Skip to content

Commit

Permalink
Update README with notes for v0.1.3 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
tintoy committed Aug 20, 2017
1 parent d400ecd commit e038023
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 12 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Change Log

## v0.1.2
## v0.1.3

* Provide intellisense for items whose conditions evaluate to `false`.
* Show information about conditions on hover for items and properties.

## v0.1.2

* Handle `Import` elements that give rise to multiple imported projects (this already worked correctly for SDK-style imports).
* Initial support for master and sub projects.

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,24 @@ An extension for VS Code that provides intellisense for MSBuild project files, i

* When you're editing your project file, type `pr` then press `tab` to insert a `PackageReference` element.
* Move to the `Include` or `Version` attribute of your `PackageReference` element and press `ctrl+space` to bring up a list of package Ids / versions.
* Hover the mouse over targets, items, and properties to see information about them.
* Go-to-definition is implemented for both SDK-style and regular project imports.
* Hover the mouse over imports, targets, items, and properties to see information about them (including evaluated conditions).
* Document symbols are supported for imports, targets, items, and properties.
* Go-to-definition is implemented for both SDK-style and regular project imports.

## Installation

You can install this extension from the [VS marketplace](https://marketplace.visualstudio.com/items?itemName=tintoy.msbuild-project-tools), or simply [download](https://github.com/tintoy/msbuild-project-tools-vscode/releases/latest) the VSIX package for the latest release and install it by choosing "Install from VSIX" from the menu on the top right of the extensions panel.

## Limitations

* The new language server hasn't been tested extensively on Linux / MacOS (although I've verified that it works for simple cases).
* This extension uses the NuGet v3 API to resolve package names and versions. The API is pretty slow, unfortunately; I'll try to improve performance / result caching in the next release.
* Intellisense is not currently available for items with conditions evaluating to `false` as they are not present in the MSBuild project at runtime. I've fixed this for properties, so there's definitely a way forward; hopefully in the next release.
* There are some issues around line endings on MacOS and Linux (you may see them show up as occasional incorrect highlighting of elements on hover). They should be fixed in the next release which will hopefully be out soon.
* Note if you open more than one project at a time, subsequent projects will be loaded into the same MSBuild project collection as the first project. Once you have closed all open `*.*proj` files, the next file you open will become the master project. The master project will become selectable in a later release.
* The new language server hasn't been tested extensively on Linux / MacOS (although I've verified that it works for common use-cases).
* This extension uses the NuGet v3 API to resolve package names and versions. The API is pretty slow, unfortunately; I'll try to improve performance / result caching in a future release.
* Intellisense is not currently available for imports with conditions evaluating to `false` as they are not present in the MSBuild project at runtime. I've fixed this for properties and items, so there's definitely a way forward; hopefully in the next release.

**Note**: if you open more than one project at a time (or navigate to imported projects), subsequent projects will be loaded into the same MSBuild project collection as the first project. Once you have closed the last project file, the next project file you open will become the master project. The master project will become selectable in a later release.

## Questions / bug reports

If you have questions, feature requests, or would like to report a bug, please feel free to reach out by creating an issue. When reporting a bug, please try to include as much information as possible about what you were doing at the time, what you expected to happen, and what actually happened.
If you have questions, feedback, feature requests, or would like to report a bug, please feel free to reach out by creating an issue. When reporting a bug, please try to include as much information as possible about what you were doing at the time, what you expected to happen, and what actually happened.

If you're interested in collaborating that'd be great, too :-)
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "msbuild-project-tools",
"displayName": "MSBuild project tools",
"description": "Tools for working with MSBuild project files (such as auto-complete for package Ids / versions).",
"version": "0.1.2",
"version": "0.1.3",
"publisher": "tintoy",
"license": "MIT",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion src/LanguageServer.Engine/Handlers/HoverContent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public static MarkedStringContainer ItemGroup(MSBuildItemGroup itemGroup)
{
if (itemGroup == null)
throw new ArgumentNullException(nameof(itemGroup));

if (itemGroup.Name == "PackageReference")
{
string packageVersion = itemGroup.GetFirstMetadataValue("Version");
Expand Down

0 comments on commit e038023

Please sign in to comment.