vtsls
This is an LSP wrapper around TypeScript extension bundled with VSCode. All features and performance are nearly the same.
Unlike other similar projects, this is implemented by filling VSCode APIs and applying minimal patches onto the extension to make it possible to keep up with the upstream updates and drastically reduce the burden of maintenance.
Notice: Though the server is suitable for regular use scenarios at the current stage, there is no absolute guarantee for its robustness as the behavior of the wrapped VSCode extension doesn't always keep 100% clear to me. Users can view this server as a best-effort product but possbily not as reliable as other functionally identical alternatives.
Usage
Install by npm install -g @vtsls/language-server
, then run vtsls --stdio
. Requires node >= 14
.
LSP Features
See available server capabilities. Here are also references from VSCode.
Code Lens
The code lens command editor.action.showReferences
should be executed by client, relevant LSP issue here. Command arguments:
[uri: DocumentUri, codeLensStart: Position, locations: Location[]]
Commands
Some other commands are undocumented because either it is private for server or not tested.
command
: (arguments => result)
-
typescript.openTsServerLog
-
typescript.restartTsServer
-
typescript.reloadProjects
-
javascript.reloadProjects
-
typescript.selectTypeScriptVersion
-
typescript.goToSourceDefinition
:[DocumentUri, Position] => Location[]
-
typescript.findAllFileReferences
:[DocumentUri] => Location[]
-
typescript.goToProjectConfig
:[DocumentUri] => null
-
javascript.goToProjectConfig
:[DocumentUri] => null
-
_typescript.configurePlugin
:[pluginName: string, config: any] => any
-
typescript.tsserverRequest
:[RequestType, args: any, config: any] => any
See CommandTypes for available tsserver commands.
-
typescript.organizeImports
:[filePath: string] => any
-
typescript.sortImports
:[filePath: string] => any
-
javascript.sortImports
:[filePath: string] => any
-
typescript.removeUnusedImports
:[filePath: string] => any
-
javascript.removeUnusedImports
:[filePath: string] => any
Code Actions
Same as VSCode. The list below may be outdated.
Source Actions
source.organizeImports
source.sortImports
source.removeUnusedImports
source.fixAll.ts
source.removeUnused.ts
source.addMissingImports.ts
Refactor
refactor.extract.function
refactor.extract.constant
refactor.extract.type
refactor.extract.interface
refactor.move.newFile
refactor.rewrite.import
refactor.rewrite.export
refactor.rewrite.arrow.braces
refactor.rewrite.property.generateAccessors
Inline refactor action can carry an additional editor.action.rename
command for immediate renaming of new extracted symbol. The command should be executed on the client side. Command arguments:
[uri: DocumentUri, position: Position][]
Update paths on rename
Require client to send workspace/didRenameFiles
notification on rename of file/folder.
Configuration
Almost the same as the original VSCode extension, with a few additional settings excluded for this server (prefixed with vtsls.
).
See the configuration schema here.
Troubleshooting
Please see Known issues first.
Bad performance of completion
tsserver
could throw out plenty of completion entries, most of them are globally accessible variables, modules or namespaces. Some LSP clients have poor performance for fuzzy matching or filtering, and cause noticeable delay of completion.
Instead of switching client, some server configuration options could also make partial optimizations:
vtsls.experimental.completion.enableServerSideFuzzyMatch
: before returning all the completion candidates fromtsserver
, the server will do fuzzy matching and filter out entries with no match. This can reduce the number of invalid entries in the response.vtsls.experimental.completion.entriesLimit
: set the maximum number of completion entries to return.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.selectTypeScriptVersion
or config optiontypescript.tsdk
. typescript.tsserver.pluginPaths
: use this option without modifyingtsconfig.json
.
Log
- Set
typescript.tsserver.log
in configuration - Execute command
typescript.openTsServerLog
Editor Integration
Neovim | nvim-lspconfig nvim-vtsls
Not Planned
Some not editor-agnostic features in VSCode:
- Read TypeScript plugin from VSCode extensions
- Running in browser, the server only targets on Node environment
- Copilot integration namely AI code actions in VSCode
Plus any features not supported in VSCode.
Develop
Build
git submodule update --init
pnpm install
pnpm build
pnpm build:watch # or watch changes by