Skip to content

Commit d932e47

Browse files
committed
docs: update information about versioning language service and typescript
#754 exprienced a versioning issue that isn't really explained well by the README docs. Update the documentation with a better overview of how we load packages and the suggested approach.
1 parent cac40a1 commit d932e47

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,21 @@ Download the extension from [Visual Studio Marketplace](https://marketplace.visu
1818

1919
## Versioning
2020

21-
The language 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
21+
The language service extension relies on the `@angular/language-service` and `typescript` packages
22+
for its backend. These packages are loaded, in order of priority, from:
2623

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`
24+
1. The path specified by `angular.ngdk` and `typescript.tsdk`, respectively, in project or global
25+
settings.
26+
2. _(Recommended)_ The version of these packages bundled with the Angular Language Service extension.
27+
3. The version of these packages present in the current workspace's node_modules.
3028

31-
For further information, please see [#594](https://github.com/angular/vscode-ng-language-service/issues/594).
29+
We suggest **not** specifying neither `angular.ngdk` nor `typescript.tsdk` in your VSCode settings
30+
per method (1) above. If the `@angular/language-service` and `typescript` packages are loaded by
31+
methods (1) or (3), there is a potential for a mismatch between
32+
the API expected by `@angular/language-service` and the API provided by `typescript`. This could
33+
lead to a failure of the language service extension.
34+
35+
For more information, please see [#594](https://github.com/angular/vscode-ng-language-service/issues/594).
3236

3337
## Installing a particular release build
3438

0 commit comments

Comments
 (0)