Skip to content

Commit

Permalink
feat(volar): add support for the volar langserver for Vue (neovim#1223)
Browse files Browse the repository at this point in the history
  • Loading branch information
sethidden authored and cyruseuros committed Sep 11, 2021
1 parent 9daef9e commit 265834e
Showing 1 changed file with 89 additions and 0 deletions.
89 changes: 89 additions & 0 deletions lua/lspconfig/volar.lua
@@ -0,0 +1,89 @@
local configs = require 'lspconfig/configs'
local util = require 'lspconfig/util'

local function get_typescript_server_path(root_dir)
local project_root = util.find_node_modules_ancestor(root_dir)
return project_root and (util.path.join(project_root, 'node_modules', 'typescript', 'lib', 'tsserverlibrary.js'))
or ''
end

local server_name = 'volar'
local bin_name = 'volar-server'

-- https://github.com/johnsoncodehk/volar/blob/master/packages/shared/src/types.ts
local volar_init_options = {
typescript = {
serverPath = '',
},
languageFeatures = {
-- not supported - https://github.com/neovim/neovim/pull/14122
semanticTokens = false,
references = true,
definition = true,
typeDefinition = true,
callHierarchy = true,
hover = true,
rename = true,
renameFileRefactoring = true,
signatureHelp = true,
codeAction = true,
completion = {
defaultTagNameCase = 'both',
defaultAttrNameCase = 'kebabCase',
},
schemaRequestService = true,
documentHighlight = true,
documentLink = true,
codeLens = true,
diagnostics = true,
},
documentFeatures = {
-- not supported - https://github.com/neovim/neovim/pull/13654
documentColor = false,
selectionRange = true,
foldingRange = true,
linkedEditingRange = true,
documentSymbol = true,
documentFormatting = {
defaultPrintWidth = 100,
},
},
}

configs[server_name] = {
default_config = {
cmd = { bin_name, '--stdio' },
filetypes = { 'vue' },
root_dir = util.root_pattern 'package.json',
init_options = volar_init_options,
on_new_config = function(new_config, new_root_dir)
if
new_config.init_options
and new_config.init_options.typescript
and new_config.init_options.typescript.serverPath == ''
then
new_config.init_options.typescript.serverPath = get_typescript_server_path(new_root_dir)
end
end,
},
docs = {
package_json = 'https://raw.githubusercontent.com/johnsoncodehk/volar/master/package.json',
description = [[
https://github.com/johnsoncodehk/volar/tree/master/packages/server
Volar language server for Vue
Volar can be installed via npm
```sh
npm install -g @volar/server
```
With Vue 3 projects - it works out of the box.
With Vue 2 projects - requires [additional configuration](https://github.com/johnsoncodehk/volar#using)
Do not run `vuels` and `volar` at the same time.
To check which language servers are running, open a `.vue` file and run the `:LspInfo` command.
]],
},
}

0 comments on commit 265834e

Please sign in to comment.