1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
---@brief
---
--- https://github.com/vuejs/language-tools/tree/master/packages/language-server
---
--- Volar language server for Vue
---
--- Volar can be installed via npm:
--- ```sh
--- npm install -g @vue/language-server
--- ```
---
--- Volar by default supports Vue 3 projects.
--- For Vue 2 projects, [additional configuration](https://github.com/vuejs/language-tools/blob/master/extensions/vscode/README.md?plain=1#L19) are required.
---
--- **Hybrid Mode (by default)**
---
--- In this mode, the Vue Language Server exclusively manages the CSS/HTML sections.
--- You need the `ts_ls` server with the `@vue/typescript-plugin` plugin to support TypeScript in `.vue` files.
--- See `ts_ls` section for more information
---
--- **No Hybrid Mode**
---
--- Volar will run embedded `ts_ls` therefore there is no need to run it separately.
--- ```lua
--- local lspconfig = require('lspconfig')
---
--- vim.lsp.config('volar', {
--- -- add filetypes for typescript, javascript and vue
--- filetypes = { 'typescript', 'javascript', 'javascriptreact', 'typescriptreact', 'vue' },
--- init_options = {
--- vue = {
--- -- disable hybrid mode
--- hybridMode = false,
--- },
--- },
--- })
--- -- you must remove "ts_ls" config
--- -- vim.lsp.config['ts_ls'] = {}
--- ```
---
--- **Overriding the default TypeScript Server used by Volar**
---
--- The default config looks for TypeScript in the local `node_modules`. This can lead to issues
--- e.g. when working on a [monorepo](https://monorepo.tools/). The alternatives are:
---
--- - use a global TypeScript Server installation
--- ```lua
--- vim.lsp.config('volar', {
--- init_options = {
--- typescript = {
--- -- replace with your global TypeScript library path
--- tsdk = '/path/to/node_modules/typescript/lib'
--- }
--- }
--- })
--- ```
---
--- - use a local server and fall back to a global TypeScript Server installation
--- ```lua
--- vim.lsp.config('volar', {
--- init_options = {
--- typescript = {
--- -- replace with your global TypeScript library path
--- tsdk = '/path/to/node_modules/typescript/lib'
--- }
--- },
--- before_init = function(params, config)
--- local lib_path = vim.fs.find('node_modules/typescript/lib', { path = new_root_dir, upward = true })[1]
--- if lib_path then
--- config.init_options.typescript.tsdk = lib_path
--- end
--- end
--- })
--- ```
local function get_typescript_server_path(root_dir)
local project_root = vim.fs.dirname(vim.fs.find('node_modules', { path = root_dir, upward = true })[1])
return project_root and vim.fs.joinpath(project_root, 'node_modules', 'typescript', 'lib') or ''
end
-- https://github.com/vuejs/language-tools/blob/master/packages/language-server/lib/types.ts
local volar_init_options = {
typescript = {
tsdk = '',
},
}
return {
cmd = { 'vue-language-server', '--stdio' },
filetypes = { 'vue' },
root_markers = { 'package.json' },
init_options = volar_init_options,
before_init = function(_, config)
if config.init_options and config.init_options.typescript and config.init_options.typescript.tsdk == '' then
config.init_options.typescript.tsdk = get_typescript_server_path(config.root_dir)
end
end,
}
|
