# coc-tsserver
-Tsserver language server extension for [coc.nvim](https://github.com/neoclide/coc.nvim).
+Tsserver language server extension for
+[coc.nvim](https://github.com/neoclide/coc.nvim).
-Most of the code is from `typescript-language-features` extension which is bundled with VSCode.
+Tsserver is part of [TypeScript](https://github.com/microsoft/TypeScript) which
+provide rich features for javascript and typescript.
-**Note:** for React to work as expected, you need your JSX filetype to be
-`javascript.jsx` and your TSX filetype to be `typescript.jsx` or
-`typescript.tsx`. In coc.nvim, these filetypes are mapped to `javascriptreact`
-and `typescriptreact` because that's what tsserver uses.
-
-**Note** for javascript project, make sure you have [jsconfig.json](https://code.visualstudio.com/docs/languages/jsconfig)
-
-## Install
+This extension is a fork of `typescript-language-features` extension which is
+bundled with VSCode.
-In your vim/neovim, run command:
+**Note:** for React to work as expected, you need your JSX filetype to be
+`javascript.jsx` or `javascriptreact` and your TSX filetype to be
+`typescript.jsx` or `typescript.tsx` or `typescriptreact`. In coc.nvim, these
+filetypes are mapped to `javascriptreact` and `typescriptreact` because that's
+what tsserver uses. For filetype like `typescript.javascript`, you need
+configure `g:coc_filetype_map` variable in vimrc.
-```
-:CocInstall coc-tsserver
-```
+**Note** for javascript project, configure
+[jsconfig.json](https://code.visualstudio.com/docs/languages/jsconfig) to make
+tsserver understand your code.
-For yarn2 user what to use local typescript module:
+**Note:** for rename import on file rename, you have to install
+[watchman](https://facebook.github.io/watchman/) in your \$PATH.
-- Add PnPify to your dependencies:
+**Note:** for [nvm](https://github.com/creationix/nvm) users, you need configure
+`tsserver.npm` to your global npm path or configure
+`"tsserver.disableAutomaticTypeAcquisition": false` to disable automatic typings
+installation.
- ```
- yarn add @yarnpkg/pnpify
- ```
+**Note:** tsserver could be quite slow to initialize on big project, exclude
+unneunnecessary files in your jsconfig.json/tsconfig.json.
-- Run the following command, which will generate a new directory called .vscode/pnpify
+## Supporting
- ```
- yarn pnpify --sdk
- ```
+If you like my extension, consider supporting me on Patreon or PayPal:
-### intructions for nvm users
+<a href="https://www.patreon.com/chemzqm"><img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Patreon donate button" /> </a>
+<a href="https://www.paypal.com/paypalme/chezqm"><img src="https://werwolv.net/assets/paypal_banner.png" alt="PayPal donate button" /> </a>
-Disable [nvm](https://github.com/creationix/nvm) with the following command:
+## Install
-```
-nvm deactivate
-```
+In your vim/neovim, run command:
-Next, find out what the global path of your installed version of npm with the following command:
+`:CocInstall coc-tsserver`
-```
-which npm
-```
+For yarn2 ( >= v2.0.0-rc.36) user want to use local typescript module:
-The output of the above command should go into the `tsserver.npm` property in your `coc-settings.json` file, a partial example listed below:
+- Run command `yarn dlx @yarnpkg/pnpify --sdk vim`, which will generate
+ `.vim/coc-settings.json`, with content:
-```
-"tsserver.npm": "/usr/local/bin/npm"
-```
+ ````json
+ {
+ "tsserver.tsdk": ".yarn/sdks/typescript/lib",
+ "eslint.packageManager": "yarn",
+ "eslint.nodePath": ".yarn/sdks"
+ } ```
+ ````
## Features
- `tsserver.openTsServerLog`
- `tsserver.goToProjectConfig`
- `tsserver.restart`
- - `tsserver.format`
- `tsserver.organizeImports`
- `tsserver.watchBuild`
- Code completion support.
- Find references.
- Signature help.
- Rename symbols support.
-- Rename imports on file rename, require [watchman](https://facebook.github.io/watchman/) installed in your \$PATH.
+- Rename imports on file rename, require
+ [watchman](https://facebook.github.io/watchman/) installed in your \$PATH.
- Search for workspace symbols.
-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.
+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.
## Configuration options
-Checkout [using the configuration file](https://github.com/neoclide/coc.nvim/wiki/Using-the-configuration-file) for guide of coc.nvim's configuration.
+Checkout [using the configuration
+file](https://github.com/neoclide/coc.nvim/wiki/Using-the-configuration-file)
+for guide of coc.nvim's configuration.
- `tsserver.enable`:Enable tsserver extension, default: `true`
- `tsserver.locale`:Locale of tsserver, default: `""`
- `tsserver.typingsCacheLocation`:Folder path for cache typings, default: `""`
-- `tsserver.formatOnType`:Run format on type special characters., default: `true`
+- `tsserver.formatOnType`:Run format on type special characters., default:
+ `true`
- `tsserver.enableJavascript`:Use tsserver for javascript files, default: `true`
-- `tsserver.maxTsServerMemory`:Set the maximum amount of memory to allocate to the TypeScript server process
+- `tsserver.maxTsServerMemory`:Set the maximum amount of memory to allocate to
+ the TypeScript server process
- `tsserver.tsdk`:Directory contains tsserver.js,, default: `""`
- `tsserver.npm`:Executable path of npm for download typings, default: `""`
- `tsserver.log`:Log level of tsserver, default: `"off"`
- `tsserver.trace.server`:Trace level of tsserver, default: `"off"`
-- `tsserver.pluginRoot`:Folder contains tsserver plugins, default: `[]`
+- `tsserver.pluginPaths`:Folders contains tsserver plugins, default: `[]`
- `tsserver.debugPort`:Debug port number of tsserver
-- `tsserver.watchOptions`:Configure which watching strategies should be used to keep track of files and directories. Requires using TypeScript 3.8+ in the workspace, default: undefined.
+- `tsserver.watchOptions`:Configure which watching strategies should be used to
+ keep track of files and directories. Requires using TypeScript 3.8+ in the
+ workspace, default: undefined.
- `tsserver.reportStyleChecksAsWarnings` default: `true`
-- `tsserver.implicitProjectConfig.checkJs`:Enable checkJs for implicit project, default: `false`
-- `tsserver.implicitProjectConfig.experimentalDecorators`:Enable experimentalDecorators for implicit project, default: `false`
-- `tsserver.disableAutomaticTypeAcquisition`:Disable download of typings, default: `false`
+- `tsserver.implicitProjectConfig.checkJs`:Enable checkJs for implicit project,
+ default: `false`
+- `tsserver.implicitProjectConfig.experimentalDecorators`:Enable
+ experimentalDecorators for implicit project, default: `false`
+- `tsserver.disableAutomaticTypeAcquisition`:Disable download of typings,
+ default: `false`
- `tsserver.useBatchedBufferSync`: use batched buffer synchronize support.
-- `typescript.updateImportsOnFileMove.enable`:Enable update imports on file move., default: `true`
-- `typescript.implementationsCodeLens.enable`:Enable codeLens for implementations, default: `true`
-- `typescript.referencesCodeLens.enable`:Enable codeLens for references, default: `true`
+- `typescript.updateImportsOnFileMove.enable`:Enable update imports on file
+ move., default: `true`
+- `typescript.implementationsCodeLens.enable`:Enable codeLens for
+ implementations, default: `true`
+- `typescript.referencesCodeLens.enable`:Enable codeLens for references,
+ default: `true`
- `typescript.preferences.importModuleSpecifier` default: `"auto"`
-- `typescript.preferences.importModuleSpecifierEnding` default: `true`
+- `typescript.preferences.importModuleSpecifierEnding` default: `"auto"`
- `typescript.preferences.quoteStyle` default: `"single"`
-- `typescript.suggestionActions.enabled`:Enable/disable suggestion diagnostics for TypeScript files in the editor. Requires using TypeScript 2.8 or newer in the workspace., default: `true`
-- `typescript.validate.enable`:Enable/disable TypeScript validation., default: `true`
+- `typescript.suggestionActions.enabled`:Enable/disable suggestion diagnostics
+ for TypeScript files in the editor. Requires using TypeScript 2.8 or newer in
+ the workspace., default: `true`
+- `typescript.validate.enable`:Enable/disable TypeScript validation., default:
+ `true`
- `typescript.showUnused`: show unused variable hint, default: `true`.
- `typescript.suggest.enabled` default: `true`
-- `typescript.suggest.paths`:Enable/disable suggest paths in import statement and require calls, default: `true`
-- `typescript.suggest.autoImports`:Enable/disable auto import suggests., default: `true`
-- `typescript.suggest.completeFunctionCalls`:Enable snippet for method suggestion, default: `true`
+- `typescript.suggest.paths`:Enable/disable suggest paths in import statement
+ and require calls, default: `true`
+- `typescript.suggest.autoImports`:Enable/disable auto import suggests.,
+ default: `true`
+- `typescript.suggest.completeFunctionCalls`:Enable snippet for method
+ suggestion, default: `true`
- `typescript.format.enabled`:Enable/disable format of typescript files.
- `typescript.format.insertSpaceAfterCommaDelimiter` default: `true`
- `typescript.format.insertSpaceAfterConstructor` default: `false`
- `typescript.format.insertSpaceAfterSemicolonInForStatements` default: `true`
- `typescript.format.insertSpaceBeforeAndAfterBinaryOperators` default: `true`
-- `typescript.format.insertSpaceAfterKeywordsInControlFlowStatements` default: `true`
-- `typescript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions` default: `true`
+- `typescript.format.insertSpaceAfterKeywordsInControlFlowStatements` default:
+ `true`
+- `typescript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions`
+ default: `true`
- `typescript.format.insertSpaceBeforeFunctionParenthesis` default: `false`
-- `typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets` default: `false`
-- `typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces` default: `false`
-- `typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis` default: `false`
-- `typescript.format.insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces` default: `false`
-- `typescript.format.insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces` default: `false`
+- `typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets`
+ default: `false`
+- `typescript.format.insertSpaceAfterOpeningAndBeforeClosingEmptyBraces`
+ default: `false`
+- `typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces`
+ default: `false`
+- `typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis`
+ default: `false`
+- `typescript.format.insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces`
+ default: `false`
+- `typescript.format.insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces`
+ default: `false`
- `typescript.format.insertSpaceAfterTypeAssertion` default: `false`
- `typescript.format.placeOpenBraceOnNewLineForFunctions` default: `false`
- `typescript.format.placeOpenBraceOnNewLineForControlBlocks` default: `false`
- `javascript.implementationsCodeLens.enable` default: `true`
- `javascript.referencesCodeLens.enable` default: `true`
- `javascript.preferences.importModuleSpecifier` default: `"auto"`
-- `javascript.preferences.importModuleSpecifierEnding` default: `true`
+- `javascript.preferences.importModuleSpecifierEnding` default: `"auto"`
- `javascript.preferences.quoteStyle` default: `"single"`
-- `javascript.validate.enable`: Enable/disable JavaScript validation., default: `true`
-- `javascript.suggestionActions.enabled`: Enable/disable suggestion diagnostics for JavaScript files in the editor. Requires using TypeScript 2.8 or newer in the workspace., default: `true`
+- `javascript.validate.enable`: Enable/disable JavaScript validation., default:
+ `true`
+- `javascript.suggestionActions.enabled`: Enable/disable suggestion diagnostics
+ for JavaScript files in the editor. Requires using TypeScript 2.8 or newer in
+ the workspace., default: `true`
- `javascript.suggest.names`: default `true`
- `javascript.suggest.enabled`: default `true`
-- `javascript.suggest.paths`: Enable/disable suggest paths in import statement and require calls, default: `true`
-- `javascript.suggest.autoImports`: Enable/disable auto import suggests., default: `true`
-- `javascript.suggest.completeFunctionCalls`:Enable snippet for method suggestion, default: `true`
+- `javascript.suggest.paths`: Enable/disable suggest paths in import statement
+ and require calls, default: `true`
+- `javascript.suggest.autoImports`: Enable/disable auto import suggests.,
+ default: `true`
+- `javascript.suggest.completeFunctionCalls`:Enable snippet for method
+ suggestion, default: `true`
- `javascript.format.insertSpaceAfterCommaDelimiter` default: `true`
- `javascript.format.insertSpaceAfterConstructor` default: `false`
- `javascript.format.insertSpaceAfterSemicolonInForStatements` default: `true`
- `javascript.format.insertSpaceBeforeAndAfterBinaryOperators` default: `true`
-- `javascript.format.insertSpaceAfterKeywordsInControlFlowStatements` default: `true`
-- `javascript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions` default: `true`
+- `javascript.format.insertSpaceAfterKeywordsInControlFlowStatements` default:
+ `true`
+- `javascript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions`
+ default: `true`
- `javascript.format.insertSpaceBeforeFunctionParenthesis` default: `false`
-- `javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets` default: `false`
-- `javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces` default: `false`
-- `javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis` default: `false`
-- `javascript.format.insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces` default: `false`
-- `javascript.format.insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces` default: `false`
+- `javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets`
+ default: `false`
+- `javascript.format.insertSpaceAfterOpeningAndBeforeClosingEmptyBraces`
+ default: `false`
+- `javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces`
+ default: `false`
+- `javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis`
+ default: `false`
+- `javascript.format.insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces`
+ default: `false`
+- `javascript.format.insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces`
+ default: `false`
- `javascript.format.insertSpaceAfterTypeAssertion` default: `false`
- `javascript.format.placeOpenBraceOnNewLineForFunctions` default: `false`
- `javascript.format.placeOpenBraceOnNewLineForControlBlocks` default: `false`
- `javascript.suggest.includeAutomaticOptionalChainCompletions`: default: `true`
-Configurations are the same as with VSCode. Try completion with `tsserver`, `typescript`
-or `javascript` in your `coc-settings.json`.
+Configurations are the same as with VSCode. Try completion with `tsserver`,
+`typescript` or `javascript` in your `coc-settings.json`.
## Related extensions
- [coc-eslint](https://github.com/neoclide/coc-eslint): enable [eslint](https://github.com/eslint/eslint) plugin for tsserver to lint TypeScript and JavaScript files.
-- [coc-tslint-plugin](https://github.com/neoclide/coc-tslint-plugin): enable [tslint](https://github.com/palantir/tslint)
- plugin for tsserver ([deprecated](https://github.com/palantir/tslint/issues/4534)).
+- [coc-tslint-plugin](https://github.com/neoclide/coc-tslint-plugin): enable [tslint](https://github.com/palantir/tslint) plugin for tsserver ([deprecated](https://github.com/palantir/tslint/issues/4534)).
+- [coc-styled-components](https://github.com/fannheyward/coc-styled-components/): Styled component for coc.nvim as a tsserver plugin.
+- [coc-react-refactor](https://github.com/fannheyward/coc-react-refactor): React refactor extension for coc.nvim, forked from vscode-react-refactor.
- [coc-vetur](https://github.com/neoclide/coc-vetur): [vue](https://github.com/vuejs/vue) extension.
- [coc-angular](https://github.com/iamcco/coc-angular): [angular](https://github.com/angular/angular) extension.
- Open tsserver log file by command `CocCommand tsserver.openTsServerLog`
- Open tsserver output channel by command `CocCommand workspace.showOutput tsserver`
-If you find any issues, please [create an issue](https://github.com/neoclide/coc-tsserver/issues/new).
+If you find any issues, please [create an
+issue](https://github.com/neoclide/coc-tsserver/issues/new).
## License
projects / dotfiles / .git / blobdiff