aboutsummaryrefslogtreecommitdiffstats
path: root/lua/lspconfig/server_configurations/ts_ls.lua
diff options
context:
space:
mode:
authorYi Ming <ofseed@foxmail.com>2024-09-05 16:26:31 +0800
committerGitHub <noreply@github.com>2024-09-05 01:26:31 -0700
commitbdbc65aadc708ce528efb22bca5f82a7cca6b54d (patch)
treec30fc57339dc7dd253244d2792df2a1a662a720c /lua/lspconfig/server_configurations/ts_ls.lua
parentdocs: update server_configurations.md (diff)
downloadnvim-lspconfig-bdbc65aadc708ce528efb22bca5f82a7cca6b54d.tar
nvim-lspconfig-bdbc65aadc708ce528efb22bca5f82a7cca6b54d.tar.gz
nvim-lspconfig-bdbc65aadc708ce528efb22bca5f82a7cca6b54d.tar.bz2
nvim-lspconfig-bdbc65aadc708ce528efb22bca5f82a7cca6b54d.tar.lz
nvim-lspconfig-bdbc65aadc708ce528efb22bca5f82a7cca6b54d.tar.xz
nvim-lspconfig-bdbc65aadc708ce528efb22bca5f82a7cca6b54d.tar.zst
nvim-lspconfig-bdbc65aadc708ce528efb22bca5f82a7cca6b54d.zip
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).
Diffstat (limited to 'lua/lspconfig/server_configurations/ts_ls.lua')
-rw-r--r--lua/lspconfig/server_configurations/ts_ls.lua90
1 files changed, 90 insertions, 0 deletions
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")]],
+ },
+ },
+}