Skip to content

Commit 71ebdc1

Browse files
ayazhafizKeen Yee Liau
authored and
Keen Yee Liau
committed
docs: add section about mismatch in TS loading the language service
Adds information about the issue seen in #594 to the README. cc @ikilinc.
1 parent c1b92aa commit 71ebdc1

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@ and external templates including:
1616

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

19+
## Versioning
20+
21+
The langauge service extension uses the `@angular/language-service` package for its backend. This
22+
package is loaded either from the version bundled with the extension, or from the current workspace
23+
project the extension is running on. Due to the behavior of TypeScript below version 3.8,
24+
incompatible versions of the language service may sometimes be loaded. If you are using a version of
25+
TypeScript below 3.8, we suggest either
26+
27+
- Not installing `@angular/language-service` in your project (recommended; will fallback on the
28+
version bundled with the extension)
29+
- Installing and keeping updates for the latest version of `@angular/language-service`
30+
31+
For further information, please see #594.
1932

2033
## Installing a particular release build
2134

@@ -24,6 +37,7 @@ Download the `.vsix` file for the release that you want to install from the [rel
2437
*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.
2538

2639
The extension can also be installed with the following command:
40+
2741
```
2842
code --install-extension /path/to/ngls.vsix
2943
```

0 commit comments

Comments
 (0)