Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add section about mismatch in TS loading the language service #606

Merged
merged 2 commits into from
Feb 4, 2020
Merged

docs: add section about mismatch in TS loading the language service #606

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fb27ce
docs: add section about mismatch in TS loading the language service
ayazhafiz Feb 2, 2020
76e0d35
fixup! docs: add section about mismatch in TS loading the language se…
ayazhafiz Feb 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ and external templates including:

Download the extension from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Angular.ng-template).

## Versioning

The language service extension uses the `@angular/language-service` package for its backend. This
package is loaded either from the version bundled with the extension, or from the current workspace
project the extension is running on. Due to the behavior of TypeScript below version 3.8,
incompatible versions of the language service may sometimes be loaded. If you are using a version of
TypeScript below 3.8, we suggest either

- Not installing `@angular/language-service` in your project (recommended; will fallback on the
version bundled with the extension)
- Installing and keeping updates for the latest version of `@angular/language-service`

For further information, please see [#594](https://github.com/angular/vscode-ng-language-service/issues/594).

## Installing a particular release build

Expand All @@ -24,6 +37,7 @@ Download the `.vsix` file for the release that you want to install from the [rel
*Do not open the .vsix file directly*. Instead, in Visual Studio code, go to the extensions tab. Click on the "..." menu in the upper right corner of the extensions tab, select "Install from vsix..." and then select the .vsix file for the release you just downloaded.

The extension can also be installed with the following command:

```
code --install-extension /path/to/ngls.vsix
```
Expand Down