From bdbc65aadc708ce528efb22bca5f82a7cca6b54d Mon Sep 17 00:00:00 2001 From: Yi Ming Date: Thu, 5 Sep 2024 16:26:31 +0800 Subject: feat(ts_ls)!: rename `tsserver` to `ts_ls` #3232 `tsserver` cannot be used as an abbreviation for `typescript-language-server`, because there is [`tsserver`](https://github.com/microsoft/TypeScript/wiki/Standalone-Server-(tsserver)) already and it is completely different from `typescript-language-server`. This is misleading. As the [README of `typescript-language-server`](https://github.com/typescript-language-server/typescript-language-server/blob/master/README.md) says, it's a wrapper of `tsserver`. This abuse has been around for so many time in lspconfig that people don't realize they are two different things, and are then confused by replacements of `typescript-language-server` like [typescript-tools.nvim](https://github.com/pmizio/typescript-tools.nvim) and [vtsls](https://github.com/yioneko/vtsls). --- lua/lspconfig.lua | 4 ++ lua/lspconfig/server_configurations/svelte.lua | 2 +- lua/lspconfig/server_configurations/ts_ls.lua | 90 ++++++++++++++++++++++++ lua/lspconfig/server_configurations/tsserver.lua | 88 ----------------------- lua/lspconfig/server_configurations/volar.lua | 4 +- 5 files changed, 97 insertions(+), 91 deletions(-) create mode 100644 lua/lspconfig/server_configurations/ts_ls.lua delete mode 100644 lua/lspconfig/server_configurations/tsserver.lua (limited to 'lua') diff --git a/lua/lspconfig.lua b/lua/lspconfig.lua index 0823ec8d..b9012f87 100644 --- a/lua/lspconfig.lua +++ b/lua/lspconfig.lua @@ -27,6 +27,10 @@ local function server_alias(name) to = 'lua_ls', version = '0.2.0', }, + tsserver = { + to = 'ts_ls', + version = '0.2.0', + }, } return aliases[name] diff --git a/lua/lspconfig/server_configurations/svelte.lua b/lua/lspconfig/server_configurations/svelte.lua index a08bb954..edaa740d 100644 --- a/lua/lspconfig/server_configurations/svelte.lua +++ b/lua/lspconfig/server_configurations/svelte.lua @@ -10,7 +10,7 @@ return { description = [[ https://github.com/sveltejs/language-tools/tree/master/packages/language-server -Note: assuming that [tsserver](#tsserver) is setup, full JavaScript/TypeScript support (find references, rename, etc of symbols in Svelte files when working in JS/TS files) requires per-project installation and configuration of [typescript-svelte-plugin](https://github.com/sveltejs/language-tools/tree/master/packages/typescript-plugin#usage). +Note: assuming that [ts_ls](#ts_ls) is setup, full JavaScript/TypeScript support (find references, rename, etc of symbols in Svelte files when working in JS/TS files) requires per-project installation and configuration of [typescript-svelte-plugin](https://github.com/sveltejs/language-tools/tree/master/packages/typescript-plugin#usage). `svelte-language-server` can be installed via `npm`: ```sh diff --git a/lua/lspconfig/server_configurations/ts_ls.lua b/lua/lspconfig/server_configurations/ts_ls.lua new file mode 100644 index 00000000..38a7c800 --- /dev/null +++ b/lua/lspconfig/server_configurations/ts_ls.lua @@ -0,0 +1,90 @@ +local util = require 'lspconfig.util' + +return { + default_config = { + init_options = { hostInfo = 'neovim' }, + cmd = { 'typescript-language-server', '--stdio' }, + filetypes = { + 'javascript', + 'javascriptreact', + 'javascript.jsx', + 'typescript', + 'typescriptreact', + 'typescript.tsx', + }, + root_dir = util.root_pattern('tsconfig.json', 'jsconfig.json', 'package.json', '.git'), + single_file_support = true, + }, + docs = { + description = [[ +https://github.com/typescript-language-server/typescript-language-server + +`ts_ls`, aka `typescript-language-server`, is a Language Server Protocol implementation for TypeScript wrapping `tsserver`. Note that `ts_ls` is not `tsserver`. + +`typescript-language-server` depends on `typescript`. Both packages can be installed via `npm`: +```sh +npm install -g typescript typescript-language-server +``` + +To configure typescript language server, add a +[`tsconfig.json`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) or +[`jsconfig.json`](https://code.visualstudio.com/docs/languages/jsconfig) to the root of your +project. + +Here's an example that disables type checking in JavaScript files. + +```json +{ + "compilerOptions": { + "module": "commonjs", + "target": "es6", + "checkJs": false + }, + "exclude": [ + "node_modules" + ] +} +``` + +### Vue support + +As of 2.0.0, Volar no longer supports TypeScript itself. Instead, a plugin +adds Vue support to this language server. + +*IMPORTANT*: It is crucial to ensure that `@vue/typescript-plugin` and `volar `are of identical versions. + +```lua +require'lspconfig'.ts_ls.setup{ + init_options = { + plugins = { + { + name = "@vue/typescript-plugin", + location = "/usr/local/lib/node_modules/@vue/typescript-plugin", + languages = {"javascript", "typescript", "vue"}, + }, + }, + }, + filetypes = { + "javascript", + "typescript", + "vue", + }, +} + +-- You must make sure volar is setup +-- e.g. require'lspconfig'.volar.setup{} +-- See volar's section for more information +``` + +`location` MUST be defined. If the plugin is installed in `node_modules`, +`location` can have any value. + +`languages` must include `vue` even if it is listed in `filetypes`. + +`filetypes` is extended here to include Vue SFC. +]], + default_config = { + root_dir = [[root_pattern("tsconfig.json", "jsconfig.json", "package.json", ".git")]], + }, + }, +} diff --git a/lua/lspconfig/server_configurations/tsserver.lua b/lua/lspconfig/server_configurations/tsserver.lua deleted file mode 100644 index 6220e7f2..00000000 --- a/lua/lspconfig/server_configurations/tsserver.lua +++ /dev/null @@ -1,88 +0,0 @@ -local util = require 'lspconfig.util' - -return { - default_config = { - init_options = { hostInfo = 'neovim' }, - cmd = { 'typescript-language-server', '--stdio' }, - filetypes = { - 'javascript', - 'javascriptreact', - 'javascript.jsx', - 'typescript', - 'typescriptreact', - 'typescript.tsx', - }, - root_dir = util.root_pattern('tsconfig.json', 'jsconfig.json', 'package.json', '.git'), - single_file_support = true, - }, - docs = { - description = [[ -https://github.com/typescript-language-server/typescript-language-server - -`typescript-language-server` depends on `typescript`. Both packages can be installed via `npm`: -```sh -npm install -g typescript typescript-language-server -``` - -To configure typescript language server, add a -[`tsconfig.json`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) or -[`jsconfig.json`](https://code.visualstudio.com/docs/languages/jsconfig) to the root of your -project. - -Here's an example that disables type checking in JavaScript files. - -```json -{ - "compilerOptions": { - "module": "commonjs", - "target": "es6", - "checkJs": false - }, - "exclude": [ - "node_modules" - ] -} -``` - -### Vue support - -As of 2.0.0, Volar no longer supports TypeScript itself. Instead, a plugin -adds Vue support to this language server. - -*IMPORTANT*: It is crucial to ensure that `@vue/typescript-plugin` and `volar `are of identical versions. - -```lua -require'lspconfig'.tsserver.setup{ - init_options = { - plugins = { - { - name = "@vue/typescript-plugin", - location = "/usr/local/lib/node_modules/@vue/typescript-plugin", - languages = {"javascript", "typescript", "vue"}, - }, - }, - }, - filetypes = { - "javascript", - "typescript", - "vue", - }, -} - --- You must make sure volar is setup --- e.g. require'lspconfig'.volar.setup{} --- See volar's section for more information -``` - -`location` MUST be defined. If the plugin is installed in `node_modules`, -`location` can have any value. - -`languages` must include `vue` even if it is listed in `filetypes`. - -`filetypes` is extended here to include Vue SFC. -]], - default_config = { - root_dir = [[root_pattern("tsconfig.json", "jsconfig.json", "package.json", ".git")]], - }, - }, -} diff --git a/lua/lspconfig/server_configurations/volar.lua b/lua/lspconfig/server_configurations/volar.lua index 4875b1ff..888cd165 100644 --- a/lua/lspconfig/server_configurations/volar.lua +++ b/lua/lspconfig/server_configurations/volar.lua @@ -44,8 +44,8 @@ Volar by default supports Vue 3 projects. Vue 2 projects need [additional configuration](https://github.com/vuejs/language-tools/tree/master/packages/vscode-vue#usage). **TypeScript support** -As of release 2.0.0, Volar no longer wraps around tsserver. For typescript -support, `tsserver` needs to be configured with the `@vue/typescript-plugin` +As of release 2.0.0, Volar no longer wraps around ts_ls. For typescript +support, `ts_ls` needs to be configured with the `@vue/typescript-plugin` plugin. **Take Over Mode** -- cgit v1.2.3-70-g09d2