Skip to content

fix(vue): volar v1 support #4552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 23 additions & 44 deletions ale_linters/vue/volar.vim
Original file line number Diff line number Diff line change
Expand Up @@ -3,50 +3,21 @@
" nvim-lspconfig and volar/packages/shared/src/types.ts

call ale#Set('vue_volar_executable', 'vue-language-server')
call ale#Set('vue_volar_use_global', get(g:, 'ale_use_global_executables', 0))
call ale#Set('vue_volar_use_global', 1)
call ale#Set('vue_volar_init_options', {
\ 'documentFeatures': {
\ 'documentColor': v:false,
\ 'documentFormatting': {
\ 'defaultPrintWidth': 100,
\ },
\ 'documentSymbol': v:true,
\ 'foldingRange': v:true,
\ 'linkedEditingRange': v:true,
\ 'selectionRange': v:true,
\ },
\ 'languageFeatures': {
\ 'callHierarchy': v:true,
\ 'codeAction': v:true,
\ 'codeLens': v:true,
\ 'completion': {
\ 'defaultAttrNameCase': 'kebabCase',
\ 'defaultTagNameCase': 'both',
\ 'getDocumentNameCaseRequest': v:false,
\ 'getDocumentSelectionRequest': v:false,
\ },
\ 'definition': v:true,
\ 'diagnostics': v:true,
\ 'documentHighlight': v:true,
\ 'documentLink': v:true,
\ 'hover': v:true,
\ 'references': v:true,
\ 'rename': v:true,
\ 'renameFileRefactoring': v:true,
\ 'schemaRequestService': v:true,
\ 'semanticTokens': v:false,
\ 'signatureHelp': v:true,
\ 'typeDefinition': v:true,
\ 'workspaceSymbol': v:false,
\ },
\ 'typescript': {
\ 'serverPath': '',
\ 'localizedPath': v:null,
\ },
\ 'typescript': { 'tsdk': '' },
\})

function! ale_linters#vue#volar#GetProjectRoot(buffer) abort
let l:project_roots = ['package.json', 'vite.config.js', '.git', bufname(a:buffer)]
let l:project_roots = [
\ 'package.json',
\ 'vite.config.js',
\ 'vite.config.mjs',
\ 'vite.config.cjs',
\ 'vite.config.ts',
\ '.git',
\ bufname(a:buffer)
\]

for l:project_root in l:project_roots
let l:nearest_filepath = ale#path#FindNearestFile(a:buffer, l:project_root)
Expand All @@ -60,11 +31,19 @@ function! ale_linters#vue#volar#GetProjectRoot(buffer) abort
endfunction

function! ale_linters#vue#volar#GetInitializationOptions(buffer) abort
let l:tsserver_path = ale#path#FindNearestExecutable(a:buffer, [
\ 'node_modules/typescript/lib/tsserverlibrary.js'
\ ])
let l:tsserver_path = ale#path#FindNearestDirectory(a:buffer, 'node_modules/typescript/lib')

if l:tsserver_path is# ''
" no-custom-checks
echohl WarningMsg
" no-custom-checks
echom '[volar] Must have typescript installed in project, please install via `npm install -D typescript`.'
" no-custom-checks
echohl None
endif

let l:init_options = ale#Var(a:buffer, 'vue_volar_init_options')
let l:init_options.typescript.serverPath = l:tsserver_path
let l:init_options.typescript.tsdk = l:tsserver_path

return l:init_options
endfunction
Expand Down
4 changes: 2 additions & 2 deletions doc/ale-vue.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ g:ale_vue_volar_executable *g:ale_vue_volar_executable*
g:ale_vue_volar_use_global *g:ale_vue_volar_use_global*
*b:ale_vue_volar_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
Default: `1`

See |ale-integrations-local-executables|


g:vue_volar_init_options *g:ale_vue_volar_init_options*
*b:ale_vue_volar_init_options*
Type: |Dictionary|
Default: `{ ... }`
Default: `{ 'typescript': 'tsdk': '' }`

Default is too long to show here, take a look at it over
`ale_linters/vue/volar.vim`
Expand Down
4 changes: 2 additions & 2 deletions test/linter/test_volar.vader
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Execute(Assert proper tsserverlibrary for Volar LSP):
call ale#test#SetFilename('../test-files/volar/src/App.vue')

let g:init_opts = ale_linters#vue#volar#GetInitializationOptions(bufnr(''))
let g:tsserver_path = init_opts.typescript.serverPath
let g:actual_path = ale#path#Simplify(g:dir . '/../test-files/volar/node_modules/typescript/lib/tsserverlibrary.js')
let g:tsserver_path = init_opts.typescript.tsdk
let g:actual_path = ale#path#Simplify(g:dir . '/../test-files/volar/node_modules/typescript/lib/')

AssertEqual g:tsserver_path, g:actual_path