Skip to content

Commit

Permalink
docs: clarification on ts plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
yioneko committed Jun 27, 2023
1 parent 8bae97c commit d79cb57
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Install by `npm install -g @vtsls/language-server`, then run `vtsls --stdio`. Re

## LSP Features

See [available server capabilities](./packages/server/src/capabilities.ts).
See [available server capabilities](./packages/server/src/capabilities.ts). Here are also [references from VSCode](https://code.visualstudio.com/docs/typescript/typescript-editing).

### Code Lens

Expand Down Expand Up @@ -104,11 +104,25 @@ Instead of switching client, some server configuration options could also make p
- `typescript.preferences.includePackageJsonAutoImports = 'off'`
- `typescript.preferences.autoImportFileExcludePatterns`

### TypeScript plugin not activated

- Plugin should be specified in `tsconfig.json`.
- Check the place of running tsserver. By default the bundled version is used as in VSCode. Switch to workspace version by command `typescript.restartTsServer` or config option `typescript.tsdk`.
- `typescript.tsserver.pluginPaths`: use this option without modifying `tsconfig.json`.

### Log

- Set `typescript.tsserver.log` in configuration
- Execute command `typescript.openTsServerLog`

## Not Planned

Some not editor-agnostic features in VSCode:

- Read TypeScript plugin from VSCode extensions
- Web server
- All the features not supported in upstream
- Running in browser, the server only targets on Node environment

Plus any features not supported in VSCode.

## Develop

Expand Down

0 comments on commit d79cb57

Please sign in to comment.