coc-tsserver
v2.3.1
javascript and typescript language features extension of coc.nvim
0/weekUpdated 9 months agoMITUnpacked: 759.0 KB
Published by chemzqm@gmail.com
npm install coc-tsservercoc-tsserver
Tsserver language server extension for coc.nvim.
Tsserver is part of TypeScript which
provide rich language features for javascript and typescript.
This extension is a fork of typescript-language-features extension which is
bundled with VSCode. File type detect and syntax highlight are not supported by
this extension, use other vim plugin instead.
Important note: from v2.0.0, tsserver module resolved first from global
configuration tsserver.tsdk and use bundled module when not found, iftsserver.useLocalTsdk is enabled, workspace folder configured tsserver.tsdk
or typescript module inside current workspace folder would be used when exists.
Install
In your vim/neovim, run command:
:CocInstall coc-tsserver
For yarn2 ( >= v2.0.0-rc.36) user want to use local typescript module:
- Run command yarn dlx @yarnpkg/sdks vim, which will generate
.vim/coc-settings.json, with content:
``json`
{
"eslint.packageManager": "yarn",
"eslint.nodePath": ".yarn/sdks",
"workspace.workspaceFolderCheckCwd": false,
"tsserver.tsdk": ".yarn/sdks/typescript/lib"
}
Features
Almost the same as VSCode.
- Supports javascript & typescript and jsx/tsx (make sure the buffer filetype is typescriptreact or javascriptreact).
- Installs typings automatically.
- Commands to work with tsserver, including:
- tsserver.reloadProjects
-
-
-
-
-
- Code completion support.
- Go to definition (more info in microsoft/TypeScript#37777)
- Code validation.
- Document highlight.
- Document symbols of current buffer.
- Folding and folding range of current buffer.
- Format current buffer, range format and format on type.
- Hover for documentation.
- Implementations codeLens and references codeLens.
- Organize imports command.
- Quickfix using code actions.
- Code refactor using code actions.
- Source code action, including:
- Fix all fixable JS/TS issues.
- Remove all unused code.
- Add all missing imports.
- Organize Imports.
- Sort Imports.
- Remove Unused Imports
- Find references.
- Signature help.
- Call hierarchy.
- Selection range.
- Semantic tokens.
- Rename symbols support.
- Automatic tag closing.
- Rename imports on file rename, require
watchman installed in your \$PATH.
- Search for workspace symbols.
- Inlay hints support using virtual text feature of neovim, which requires:
- TypeScript >= 4.4.0
- Neovim >= 0.4.0
- Enabled by options starts with orjavascript.inlayHints
.
~Tsserver module first resolved from your local workspace. If it's not found, use
tsserver from tsserver.tsdk configuration or use bundled tsserver with this
extension.~
Commands
Commands contributed to :CocList commands
- tsserver.reloadProjects Reload current projecttsserver.openTsServerLog
- Open log file of tsserver.tsserver.goToProjectConfig
- Open project config file.tsserver.restart
- Restart tsservertsserver.findAllFileReferences
- Find File Referencestsserver.goToSourceDefinition
- Go to Source Definitiontsserver.watchBuild
- Run tsc --watch for current project by use vim's job feature.tsserver.executeAutofix
- Fix autofixable problems of current document.tsserver.chooseVersion
- Choose different typescript version for current project.
Configuration options
Checkout :h coc-configuration for guide of coc.nvim's configuration.
- tsserver.enable: Enable running of tsserver. Default: true
- : Path to tsconfig file for the tsserver.watchBuild command. Default: "tsconfig.json"
- : Socket path used to connect to tsserver, the socket should be opened already (use tools like socat to start server and pipe messages to sdtio of tsserver), when exists, command line arguments related configurations wont' works. Configure the path like \"127.0.0.1:7070\", Default: null.tsserver.locale
- : Sets the locale used to report JavaScript and TypeScript errors. Defaults to use VS Code's locale. Default: "auto"
Valid options: ["auto","de","es","en","fr","it","ja","ko","ru","zh-CN","zh-TW"]
- : Use tsserver from typescript module in workspace folder, ignore tsserver.tsdk configuration. Default: false
- : Set the maximum amount of memory to allocate to the TypeScript server process Default: 3072
- : Configure which watching strategies should be used to keep track of files and directories. Requires using TypeScript 3.8+ in the workspace.tsserver.tsdk
- : Specifies the folder path to the tsserver and lib*.d.ts files under a TypeScript install to use for IntelliSense, for example: ./node_modules/typescript/lib. - When specified as a user setting, the TypeScript version from tsserver.tsdk automatically replaces the built-in TypeScript version. - When specified as a workspace setting, the tsserver is used when tsserver.useLocalTsdk is true. Use command :CocCommand tsserver.chooseVersion to choose different typescript version. Default: ""
- : Specifies the path to the npm executable used for Automatic Type Acquisition. Default: ""
- : Log level of tsserver Default: "off"
Valid options: ["normal","terse","verbose","off"]
- : Trace level of tsserver Default: "off"
Valid options: ["off","messages","verbose"]
- : Enables tracing TS server performance to a directory. These trace files can be used to diagnose TS Server performance issues. The log may contain file paths, source code, and other potentially sensitive information from your project. Default: false
- : Additional paths to discover TypeScript Language Service plugins. Default: []
- : Report style checks as warnings. Default: true
- : Enable checkJs for implicit project Default: false
- : Sets the module system for the program. See more: https://www.typescriptlang.org/tsconfig#module. Default: "ESNext"
Valid options: ["CommonJS","AMD","System","UMD","ES6","ES2015","ES2020","ESNext","None","ES2022","Node12","NodeNext"]
- : Set target JavaScript language version for emitted JavaScript and include library declarations. See more: https://www.typescriptlang.org/tsconfig#target. Default: "ES2020"
Valid options: ["ES3","ES5","ES6","ES2015","ES2016","ES2017","ES2018","ES2019","ES2020","ES2021","ES2022","ESNext"]
- : Enable/disable strict null checks in JavaScript and TypeScript files that are not part of a project. Existing jsconfig.json or tsconfig.json files override this setting. Default: true
- : Enable/disable strict function types in JavaScript and TypeScript files that are not part of a project. Existing jsconfig.json or tsconfig.json files override this setting. Default: true
- : Enable experimentalDecorators for implicit project Default: false
- : Disables automatic type acquisition. Automatic type acquisition fetches @types packages from npm to improve IntelliSense for external libraries. Default: false
- : Controls if TypeScript launches a dedicated server to more quickly handle syntax related operations, such as computing code folding. Default: "auto"
Valid options: ["always","never","auto"]
- : (Experimental) Enables project wide error reporting. Default: false
- : Check if npm is installed for Automatic Type Acquisition. Default: true
- : Document schemes that should be disabled for tsserver to avoid tsserver error. Default: ["git", "fugitive", "vsls", "diffview", "github", "azurerepos"]
- : Show unused variable hint. Default: true
- : Show deprecated variable hint. Default: true
- : Enable/disable automatic updating of import paths when you rename or move a file in VS Code. Default: "prompt"
Valid options: ["prompt","always","never"]
- : Enable codeLens for implementations Default: false
- : Enable codeLens for references Default: false
- : Enable/disable references CodeLens on all functions in typescript files. Default: false
- : Preferred path style for auto imports. Default: "shortest"
Valid options: ["shortest","relative","non-relative","project-relative"]
- : Preferred path ending for auto imports. Default: "auto"
Valid options: ["auto","minimal","index","js"]
- : Preferred style for JSX attribute completions. Default: "auto"
Valid options: ["auto","braces","none"]
- : Enable/disable searching package.json dependencies for available auto imports. Default: "auto"
Valid options: ["auto","on","off"]
- : Preferred quote style to use for quick fixes. Default: "auto"
Valid options: ["auto","single","double"]
- : Enable/disable introducing aliases for object shorthand properties during renames. Requires using TypeScript 3.4 or newer in the workspace. Default: true
- : Specify glob patterns of files to exclude from auto imports. Requires using TypeScript 4.8 or newer in the workspace.typescript.preferences.preferTypeOnlyAutoImports
- : Include the type keyword in auto-imports whenever possible. Requires using TypeScript 5.3+ in the workspace.typescript.preferences.renameShorthandProperties
- : Enable/disable introducing aliases for object shorthand properties during renames. Requires using TypeScript 3.4 or newer in the workspace. Default: true
- : Enable/disable suggestion diagnostics for TypeScript files in the editor. Requires using TypeScript 2.8 or newer in the workspace. Default: true
- : Enable/disable TypeScript validation. Default: true
- : Enabled/disable autocomplete suggestions. Default: true
- : Enable/disable suggest paths in import statement and require calls Default: true
- : Enable/disable auto import suggests. Default: true
- : Enable snippet for method suggestion Default: true
- : Enable/disable auto-import-style completions on partially-typed import statements. Requires using TypeScript 4.3+ in the workspace. Default: true
- : Enable/disable snippet completions from TS Server. Requires using TypeScript 4.3+ in the workspace. Default: true
- : Enable/disable snippet completions for class members. Requires using TypeScript 4.5+ in the workspace Default: true
- : Enable/disable generating @return annotations for JSDoc templates. Requires using TypeScript 4.2+ in the workspace. Default: true
- : Enable format for typescript. Default: true
- : Defines space handling after a comma delimiter. Default: true
- : Defines space handling after the constructor keyword. Default: false
- : Defines space handling after a semicolon in a for statement. Default: true
- : Defines space handling after a binary operator. Default: true
- : Defines space handling after keywords in a control flow statement. Default: true
- : Defines space handling after function keyword for anonymous functions. Default: true
- : Defines space handling before function argument parentheses. Default: false
- : Defines space handling after opening and before closing non-empty parenthesis. Default: false
- : Defines space handling after opening and before closing non-empty brackets. Default: false
- : Defines space handling after opening and before closing empty braces. Default: false
- : Defines space handling after opening and before closing non-empty braces. Default: false
- : Defines space handling after opening and before closing template string braces. Default: false
- : Defines space handling after opening and before closing JSX expression braces. Default: false
- : Defines space handling after type assertions in TypeScript. Default: false
- : Defines whether an open brace is put onto a new line for functions or not. Default: false
- : Defines whether an open brace is put onto a new line for control blocks or not. Default: false
- : Defines handling of optional semicolons. Requires using TypeScript 3.7 or newer in the workspace. Default: "ignore"
Valid options: ["ignore","insert","remove"]
- : Enable/disable showing completions on potentially undefined values that insert an optional chain call. Requires TS 3.7+ and strict null checks to be enabled. Default: true
- : Controls which files are searched by go to symbol in workspace. Default: "allOpenProjects"
Valid options: ["allOpenProjects","currentProject"]
- : Enable/disable automatic closing of JSX tags. Default: true
- : Makes Go to Definition avoid type declaration files when possible by triggering Go to Source Definition instead. Requires using TypeScript 4.7+ in the workspace. Default: false
- : Show unused variable hint. Default: true
- : Show deprecated variable hint. Default: true
- : Enable/disable automatic updating of import paths when you rename or move a file in VS Code. Default: "prompt"
Valid options: ["prompt","always","never"]
- : Enable/disable implementations CodeLens. This CodeLens shows the implementers of an interface. Default: false
- : Enable/disable references CodeLens in JavaScript files. Default: false
- : Enable/disable references CodeLens on all functions in JavaScript files. Default: false
- : Preferred path style for auto imports. Default: "shortest"
Valid options: ["shortest","relative","non-relative","project-relative"]
- : Preferred path ending for auto imports. Default: "auto"
Valid options: ["auto","minimal","index","js"]
- : Preferred style for JSX attribute completions. Default: "auto"
Valid options: ["auto","braces","none"]
- : Preferred quote style to use for quick fixes. Default: "auto"
Valid options: ["auto","single","double"]
- : Enable/disable introducing aliases for object shorthand properties during renames. Requires using TypeScript 3.4 or newer in the workspace. Default: true
- : Specify glob patterns of files to exclude from auto imports. Requires using TypeScript 4.8 or newer in the workspace.javascript.preferences.renameShorthandProperties
- : Enable/disable introducing aliases for object shorthand properties during renames. Requires using TypeScript 3.4 or newer in the workspace. Default: true
- : Enable/disable JavaScript validation. Default: true
- : Enable/disable suggestion diagnostics for JavaScript files in the editor. Requires using TypeScript 2.8 or newer in the workspace. Default: true
- : Enable/disable including unique names from the file in JavaScript suggestions. Note that name suggestions are always disabled in JavaScript code that is semantically checked using @ts-check or checkJs. Default: true
- : Enabled/disable autocomplete suggestions. Default: true
- : Enable/disable suggest paths in import statement and require calls Default: true
- : Enable/disable auto import suggests. Default: true
- : Enable snippet for method suggestion Default: true
- : Enable/disable auto-import-style completions on partially-typed import statements. Requires using TypeScript 4.3+ in the workspace. Default: true
- : Enable/disable snippet completions for class members. Requires using TypeScript 4.5+ in the workspace Default: true
- : Enable/disable generating @return annotations for JSDoc templates. Requires using TypeScript 4.2+ in the workspace. Default: true
- : Enable format for javascript. Default: true
- : Default: true
- : Default: false
- : Default: true
- : Default: true
- : Default: true
- : Default: true
- : Default: false
- : Default: false
- : Default: false
- : Default: false
- : Default: false
- : Default: false
- : Default: false
- : Default: false
- : Default: false
- : Default: false
- : Enable/disable showing completions on potentially undefined values that insert an optional chain call. Requires TS 3.7+ and strict null checks to be enabled. Default: true
- : Enable/disable inlay hints of parameter names. Default: "none"
Valid options: ["none","literals","all"]
- : Suppress parameter name hints on arguments whose text is identical to the parameter name. Default: true
- : Enable/disable inlay hints of parameter types. Default: false
- : Enable/disable inlay hints of variable types. Default: false
- : Enable/disable inlay hints of property declarations. Default: false
- : Enable/disable inlay hints of return type for function signatures. Default: false
- : Enable/disable inlay hints of enum member values. Default: false
- : Suppress type hints on variables whose name is identical to the type name. Requires using TypeScript 4.8+ in the workspace. Default: true
- : Enable/disable inlay hints of parameter names. Default: "none"
Valid options: ["none","literals","all"]
- : Suppress parameter name hints on arguments whose text is identical to the parameter name. Default: true
- : Enable/disable inlay hints of parameter types. Default: false
- : Enable/disable inlay hints of variable types. Default: false
- : Enable/disable inlay hints of property declarations. Default: false
- : Enable/disable inlay hints of return type for function signatures. Default: false
- : Enable/disable inlay hints of enum member values. Default: false
- : Suppress type hints on variables whose name is identical to the type name. Requires using TypeScript 4.8+ in the workspace. Default: true
- : Enable/disable automatic closing of JSX tags. Default: true
- : Makes Go to Definition avoid type declaration files when possible by triggering Go to Source Definition instead. Requires using TypeScript 4.7+ in the workspace. Default: false
- : Defines handling of optional semicolons. Requires using TypeScript 3.7 or newer in the workspace. Default: "ignore"
Valid options: ["ignore","insert","remove"]
- : Enable/disable suggestion to complete JSDoc comments. Default: true
- : Enable/disable suggestion to complete JSDoc comments. Default: true
- : Enable/disable snippet completions for methods in object literals. Requires using TypeScript 4.7+ in the workspace Default: true
- : Enable/disable snippet completions for methods in object literals. Requires using TypeScript 4.7+ in the workspace Default: true
Most Configurations are the same as with VSCode. Install
coc-json and try completion with
tsserver, typescript or javascript in yourcoc-settings.json.
$3
Added configurations by coc-tsserver:
- tsserver.useLocalTsdk only works when used as workspace folder configuration.tsserver.tsconfigPath
-
-
Removed configurations:
- typescript.tsserver.useSeparateSyntaxServer Use tsserver.useSyntaxServer instead.typescript.enablePromptUseWorkspaceTsdk
- No propmpts given.typescript.tsc.autoDetect
- Used for task, not supported.typescript.surveys.enabled
- Not supported.
Renamed configurations to use tsserver as prefix:
- typescript.tsdk => tsserver.tsdk
- => tsserver.disableAutomaticTypeAcquisition
- => tsserver.npm
- => tsserver.locale
- => tsserver.maxTsServerMemory
- => tsserver.watchOptions
- => tsserver.useSyntaxServer
- => tsserver.log
- => tsserver.trace.server
- => tsserver.enableTracing
- => tsserver.pluginPaths
- => tsserver.reportStyleChecksAsWarnings
- => tsserver.implicitProjectConfig.checkJs
- => tsserver.implicitProjectConfig.experimentalDecorators
- => tsserver.implicitProjectConfig.module
- => tsserver.implicitProjectConfig.target
- => tsserver.implicitProjectConfig.strictNullChecks
- => tsserver.implicitProjectConfig.strictFunctionTypes
- => tsserver.experimental.enableProjectDiagnostics
Related extensions
- coc-eslint: enable eslint plugin for tsserver to lint TypeScript and JavaScript files.
- coc-tslint-plugin: enable tslint plugin for tsserver (deprecated).
- coc-styled-components: Styled component for coc.nvim as a tsserver plugin.
- coc-react-refactor: React refactor extension for coc.nvim, forked from vscode-react-refactor.
- coc-vetur: vue extension.
- coc-angular: angular extension.
Troubleshooting
- Add "tsserver.log": "verbose" to your coc-settings.json (opened by command:CocConfig
)"tsserver.trace.server": "verbose"
- To trace LSP communication, add to yourcoc-settings.json
- Restart coc server by command
- Make the issue happen.
- Open tsserver log file by command
- Open tsserver output channel by command
If you find any issues, please create an
issue.
Q & A
Q: React syntax not recognized by tsserver.
A: Make sure to use javascriptreact and typescriptreact for buffer filetype.`
vim`
autocmd BufNewFile,BufRead *.tsx setlocal filetype=typescriptreact
autocmd BufNewFile,BufRead *.jsx setlocal filetype=javascriptreact
Add those autocmds to your vimrc.
Q: Automatic type acquisition not work.
A: configure tsserver.npm to your global npm path or configure"tsserver.disableAutomaticTypeAcquisition": false to disable automatic typings
installation.
Q: The extension needs some time to work.
A: The initialize of tsserver requires some time, you can add g:coc_status to:h coc-status
your status line, see . If your tsserver get slow, try exclude
unnecessary files in your jsconfig.json/tsconfig.json, make sure typescript
version > 4.9 and disable logging (disabled by default).
Q: Update import on file rename not work.
A: Make sure install watchman in your
\$PATH. Use command :CocCommand workspace.showOutput watchman` to check
watchman output.
Q: Not work with buffer just created.
A: Tsserver treat buffer without a disk file belongs to implicit project, VSCode
could work because VSCode create empty file first for buffer, save the buffer to
disk to make tsserver work.
Q: Not work with my javascript project.
A: Configure jsconfig.json to make
tsserver understand your code. Some features may still not work well, it's
recommended to use typescript.
Q: Not work on WSL.
A: Copy you project files from mounted dirs to linux home otherwise tsserver
may not work properly.
Sponsoring
If you like coc-tsserver, consider supporting me on Patreon or PayPal:
License
MIT