Skip to content

Commit

Permalink
Improve ThisAssembly.Vsix wording a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
kzu committed Nov 8, 2024
1 parent 341b8f8 commit 09c3b51
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions src/ThisAssembly.Vsix/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@ MSBuild project properties from the VSIX manifest. For example:

![](https://raw.githubusercontent.com/devlooped/ThisAssembly/main/img/ThisAssembly.Vsix.png)

And in the `source.extension.vsixmanifest`:
In addition to making the [VSIX manifest metadata](https://learn.microsoft.com/en-us/visualstudio/extensibility/vsix-extension-schema-2-0-reference?view=vs-2022#metadata-element)
properties available as constants, the package also provides targets for those properties
with sensible defaults from project properties so that the manifest can leverage
[placeolder syntax](https://learn.microsoft.com/en-us/visualstudio/extensibility/vsix-extension-schema-2-0-reference?view=vs-2022#metadata-element)
and avoid duplication in the `source.extension.vsixmanifest`:

```xml
<PackageManifest Version="2.0.0" ...>
<Metadata>
Expand All @@ -18,12 +23,6 @@ And in the `source.extension.vsixmanifest`:
</PackageManifest>
```

As shown above, in addition to making the [VSIX manifest metadata](https://learn.microsoft.com/en-us/visualstudio/extensibility/vsix-extension-schema-2-0-reference?view=vs-2022#metadata-element)
properties available as constants, the package also provides targets for those properties
with sensible defaults from project properties so that the manifest can leverage
[placeolder syntax](https://learn.microsoft.com/en-us/visualstudio/extensibility/vsix-extension-schema-2-0-reference?view=vs-2022#metadata-element)
and avoid duplication.

The available properties and their default values are:

| Name | Default Value |
Expand All @@ -35,7 +34,6 @@ The available properties and their default values are:
| VsixProduct | `$(Product)` |
| VsixPublisher | `$(Company)` |
| VsixLanguage | `$(NeutralLanguage)` or 'en-US' |
| VsixDescription | `$(Description)` |

As shown in the example above, the syntax for using these properties from the `source.extension.vsixmanifest` is
`|%CurrentProject%;[PROPERTY]|`. This is because the package defines a corresponding target to
Expand Down

0 comments on commit 09c3b51

Please sign in to comment.