From 51463322066a1d1bf3537b31e7b330861e0cf283 Mon Sep 17 00:00:00 2001 From: w0rp Date: Thu, 8 Jun 2017 17:28:38 +0100 Subject: Add tsserver support --- ale_linters/typescript/tsserver.vim | 23 +++++ autoload/ale/engine.vim | 169 +++++++++++++++++++++++-------- autoload/ale/lsp.vim | 35 +++++-- autoload/ale/lsp/response.vim | 25 ++++- autoload/ale/lsp/tsserver_message.vim | 9 +- test/lsp/test_lsp_client_messages.vader | 6 +- test/lsp/test_lsp_connections.vader | 26 +++-- test/lsp/test_read_lsp_diagnostics.vader | 26 +++-- 8 files changed, 247 insertions(+), 72 deletions(-) create mode 100644 ale_linters/typescript/tsserver.vim diff --git a/ale_linters/typescript/tsserver.vim b/ale_linters/typescript/tsserver.vim new file mode 100644 index 00000000..332e32e5 --- /dev/null +++ b/ale_linters/typescript/tsserver.vim @@ -0,0 +1,23 @@ +" Author: w0rp +" Description: tsserver integration for ALE + +call ale#Set('typescript_tsserver_executable', 'tsserver') +call ale#Set('typescript_tsserver_config_path', '') +call ale#Set('typescript_tsserver_use_global', 0) + +function! ale_linters#typescript#tsserver#GetExecutable(buffer) abort + return ale#node#FindExecutable(a:buffer, 'typescript_tsserver', [ + \ 'node_modules/.bin/tsserver', + \]) +endfunction + +function! ale_linters#typescript#tsserver#Handle(buffer, lines) abort + return a:lines +endfunction + +call ale#linter#Define('typescript', { +\ 'name': 'tsserver', +\ 'lsp': 'tsserver', +\ 'executable_callback': 'ale_linters#typescript#tsserver#GetExecutable', +\ 'callback': 'ale_linters#typescript#tsserver#Handle', +\}) diff --git a/autoload/ale/engine.vim b/autoload/ale/engine.vim index 3049ab5b..8c9293f3 100644 --- a/autoload/ale/engine.vim +++ b/autoload/ale/engine.vim @@ -11,6 +11,15 @@ if !has_key(s:, 'job_info_map') let s:job_info_map = {} endif +" Stores information for each LSP command including: +" +" linter: The linter dictionary for the command. +" buffer: The buffer number for the command. +" message: The message we sent, [is_notification, command, params?] +if !has_key(s:, 'lsp_command_info_map') + let s:lsp_command_info_map = {} +endif + let s:executable_cache_map = {} " Check if files are executable, and if they are, remember that they are @@ -42,6 +51,8 @@ function! ale#engine#InitBufferInfo(buffer) abort \ 'temporary_file_list': [], \ 'temporary_directory_list': [], \ 'history': [], + \ 'open_lsp_documents': [], + \ 'lsp_command_list': [], \} endif endfunction @@ -103,6 +114,51 @@ function! s:GatherOutput(job_id, line) abort endif endfunction +function! s:HandleLoclist(linter, buffer, loclist) abort + " Make some adjustments to the loclists to fix common problems, and also + " to set default values for loclist items. + let l:linter_loclist = ale#engine#FixLocList(a:buffer, a:linter, a:loclist) + + " Remove previous items for this linter. + call filter(g:ale_buffer_info[a:buffer].loclist, 'v:val.linter_name !=# a:linter.name') + " Add the new items. + call extend(g:ale_buffer_info[a:buffer].loclist, l:linter_loclist) + + " Sort the loclist again. + " We need a sorted list so we can run a binary search against it + " for efficient lookup of the messages in the cursor handler. + call sort(g:ale_buffer_info[a:buffer].loclist, 'ale#util#LocItemCompare') + + let l:linting_is_done = empty(g:ale_buffer_info[a:buffer].job_list) + \ && empty(g:ale_buffer_info[a:buffer].lsp_command_list) + + if l:linting_is_done + " Automatically remove all managed temporary files and directories + " now that all jobs have completed. + call ale#engine#RemoveManagedFiles(a:buffer) + + " Figure out which linters are still enabled, and remove + " problems for linters which are no longer enabled. + let l:name_map = {} + + for l:linter in ale#linter#Get(getbufvar(a:buffer, '&filetype')) + let l:name_map[l:linter.name] = 1 + endfor + + call filter( + \ g:ale_buffer_info[a:buffer].loclist, + \ 'get(l:name_map, v:val.linter_name)', + \) + endif + + call ale#engine#SetResults(a:buffer, g:ale_buffer_info[a:buffer].loclist) + + if l:linting_is_done + " Call user autocommands. This allows users to hook into ALE's lint cycle. + silent doautocmd User ALELint + endif +endfunction + function! s:HandleExit(job_id, exit_code) abort if !has_key(s:job_info_map, a:job_id) return @@ -143,55 +199,33 @@ function! s:HandleExit(job_id, exit_code) abort call ale#history#RememberOutput(l:buffer, a:job_id, l:output[:]) endif - let l:linter_loclist = ale#util#GetFunction(l:linter.callback)(l:buffer, l:output) - - " Make some adjustments to the loclists to fix common problems, and also - " to set default values for loclist items. - let l:linter_loclist = ale#engine#FixLocList(l:buffer, l:linter, l:linter_loclist) + let l:loclist = ale#util#GetFunction(l:linter.callback)(l:buffer, l:output) - " Remove previous items for this linter. - call filter(g:ale_buffer_info[l:buffer].loclist, 'v:val.linter_name !=# l:linter.name') - " Add the new items. - call extend(g:ale_buffer_info[l:buffer].loclist, l:linter_loclist) + call s:HandleLoclist(l:linter, l:buffer, l:loclist) +endfunction - " Sort the loclist again. - " We need a sorted list so we can run a binary search against it - " for efficient lookup of the messages in the cursor handler. - call sort(g:ale_buffer_info[l:buffer].loclist, 'ale#util#LocItemCompare') +function! s:HandleLSPResponse(request_id, response) abort + let l:info = get(s:lsp_command_info_map, a:request_id, {}) - let l:linting_is_done = empty(g:ale_buffer_info[l:buffer].job_list) + if empty(l:info) + return + endif - if l:linting_is_done - " Automatically remove all managed temporary files and directories - " now that all jobs have completed. - call ale#engine#RemoveManagedFiles(l:buffer) + call remove(s:lsp_command_info_map, a:request_id) - " Figure out which linters are still enabled, and remove - " problems for linters which are no longer enabled. - let l:name_map = {} + let l:command_list = g:ale_buffer_info[l:info.buffer].lsp_command_list + call filter(l:command_list, 'v:val != a:request_id') - for l:linter in ale#linter#Get(getbufvar(l:buffer, '&filetype')) - let l:name_map[l:linter.name] = 1 - endfor + let l:loclist = ale#lsp#response#ReadTSServerDiagnostics(a:response) - call filter( - \ g:ale_buffer_info[l:buffer].loclist, - \ 'get(l:name_map, v:val.linter_name)', - \) - endif - - call ale#engine#SetResults(l:buffer, g:ale_buffer_info[l:buffer].loclist) - - if l:linting_is_done - " Call user autocommands. This allows users to hook into ALE's lint cycle. - silent doautocmd User ALELint - endif + call s:HandleLoclist(l:info.linter, l:info.buffer, l:loclist) endfunction function! ale#engine#SetResults(buffer, loclist) abort let l:info = get(g:ale_buffer_info, a:buffer, {}) let l:job_list = get(l:info, 'job_list', []) - let l:linting_is_done = empty(l:job_list) + let l:lsp_command_list = get(l:info, 'lsp_command_list', []) + let l:linting_is_done = empty(l:job_list) && empty(l:lsp_command_list) " Set signs first. This could potentially fix some line numbers. " The List could be sorted again here by SetSigns. @@ -498,16 +532,63 @@ function! ale#engine#StopCurrentJobs(buffer, include_lint_file_jobs) abort " Update the List, so it includes only the jobs we still need. let l:info.job_list = l:new_job_list + " Ignore current LSP commands. + " We should consider cancelling them in future. + let l:info.lsp_command_list = [] endfunction -function! ale#engine#Invoke(buffer, linter) abort - let l:executable = has_key(a:linter, 'executable_callback') - \ ? ale#util#GetFunction(a:linter.executable_callback)(a:buffer) - \ : a:linter.executable +function! s:CheckWithTSServer(buffer, linter, executable) abort + let l:info = g:ale_buffer_info[a:buffer] + let l:open_documents = l:info.open_lsp_documents + let l:is_open = index(l:open_documents, a:linter.name) >= 0 + + if !l:is_open + call add(l:open_documents, a:linter.name) + call ale#lsp#SendMessageToProgram( + \ a:executable, + \ a:executable, + \ ale#lsp#tsserver_message#Open(a:buffer), + \) + endif + + call ale#lsp#SendMessageToProgram( + \ a:executable, + \ a:executable, + \ ale#lsp#tsserver_message#Change(a:buffer), + \) + + let l:message = ale#lsp#tsserver_message#Geterr(a:buffer) + let l:request_id = ale#lsp#SendMessageToProgram( + \ a:executable, + \ a:executable, + \ l:message, + \ function('s:HandleLSPResponse'), + \) + + if l:request_id > 0 + let s:lsp_command_info_map[l:request_id] = { + \ 'buffer': a:buffer, + \ 'linter': a:linter, + \ 'message': l:message, + \} + call add(l:info.lsp_command_list, l:request_id) + endif +endfunction - " Run this program if it can be executed. - if s:IsExecutable(l:executable) - call s:InvokeChain(a:buffer, a:linter, 0, []) +function! ale#engine#Invoke(buffer, linter) abort + if empty(a:linter.lsp) || a:linter.lsp ==# 'tsserver' + let l:executable = has_key(a:linter, 'executable_callback') + \ ? ale#util#GetFunction(a:linter.executable_callback)(a:buffer) + \ : a:linter.executable + + " Run this program if it can be executed. + if s:IsExecutable(l:executable) + if a:linter.lsp ==# 'tsserver' + call s:CheckWithTSServer(a:buffer, a:linter, l:executable) + else + call s:InvokeChain(a:buffer, a:linter, 0, []) + endif + endif endif endfunction diff --git a/autoload/ale/lsp.vim b/autoload/ale/lsp.vim index 76d0c8df..a8e68a0a 100644 --- a/autoload/ale/lsp.vim +++ b/autoload/ale/lsp.vim @@ -60,7 +60,7 @@ function! s:CreateTSServerMessageData(message) abort let l:obj.arguments = a:message[2] endif - let l:data = json_encode(l:obj) + let l:data = json_encode(l:obj) . "\n" return [l:is_notification ? 0 : l:obj.seq, l:data] endfunction @@ -135,6 +135,16 @@ function! ale#lsp#ReadMessageData(data) abort return [l:remainder, l:response_list] endfunction +function! s:FindCallbackIDForType(callback_map, type) abort + for l:key in reverse(keys(a:callback_map)) + if a:callback_map[l:key][1][1] ==# a:type + return str2nr(l:key) + endif + endfor + + return 0 +endfunction + function! ale#lsp#HandleMessage(conn, message) abort let a:conn.data .= a:message @@ -147,8 +157,15 @@ function! ale#lsp#HandleMessage(conn, message) abort \ ? l:response.seq \ : l:response.id - let l:callback = a:conn.callback_map.pop(l:id) - call ale#util#GetFunction(l:callback)(l:response) + if get(l:response, 'type', '') ==# 'event' + \&& get(l:response, 'event', '') ==# 'semanticDiag' + let l:id = s:FindCallbackIDForType(a:conn.callback_map, 'ts@geterr') + endif + + if has_key(a:conn.callback_map, l:id) + let [l:Callback, l:message] = remove(a:conn.callback_map, l:id) + call ale#util#GetFunction(l:Callback)(l:id, l:response) + endif endfor endfunction @@ -190,8 +207,10 @@ function! ale#lsp#SendMessageToProgram(executable, command, message, ...) abort let [l:id, l:data] = ale#lsp#CreateMessageData(a:message) let l:matches = filter(s:connections[:], 'v:val.executable ==# a:executable') + " Get the current connection or a new one. let l:conn = !empty(l:matches) ? l:matches[0] : s:NewConnection() + let l:conn.executable = a:executable if !ale#job#IsRunning(l:conn.job_id) let l:options = { @@ -199,6 +218,8 @@ function! ale#lsp#SendMessageToProgram(executable, command, message, ...) abort \ 'out_cb': function('s:HandleCommandMessage'), \} let l:job_id = ale#job#Start(ale#job#PrepareCommand(a:command), l:options) + else + let l:job_id = l:conn.job_id endif if l:job_id <= 0 @@ -209,14 +230,14 @@ function! ale#lsp#SendMessageToProgram(executable, command, message, ...) abort " request for which the server must not return a response. if l:id != 0 " Add the callback, which the server will respond to later. - let l:conn.callback_map[l:id] = a:1 + let l:conn.callback_map[l:id] = [a:1, a:message] endif call ale#job#SendRaw(l:job_id, l:data) let l:conn.job_id = l:job_id - return 1 + return l:id endfunction " Send a message to a server at a given address. @@ -252,7 +273,7 @@ function! ale#lsp#SendMessageToAddress(address, message, ...) abort " request for which the server must not return a response. if l:id != 0 " Add the callback, which the server will respond to later. - let l:conn.callback_map[l:id] = a:1 + let l:conn.callback_map[l:id] = [a:1, a:message] endif if ch_status(l:conn.channnel) ==# 'fail' @@ -261,4 +282,6 @@ function! ale#lsp#SendMessageToAddress(address, message, ...) abort " Send the message to the server call ch_sendraw(l:conn.channel, l:data) + + return l:id endfunction diff --git a/autoload/ale/lsp/response.vim b/autoload/ale/lsp/response.vim index aeb93a58..a2146f6a 100644 --- a/autoload/ale/lsp/response.vim +++ b/autoload/ale/lsp/response.vim @@ -15,7 +15,7 @@ function! ale#lsp#response#ReadDiagnostics(params) abort for l:diagnostic in a:params.diagnostics let l:severity = get(l:diagnostic, 'severity', 0) let l:loclist_item = { - \ 'message': l:diagnostic.message, + \ 'text': l:diagnostic.message, \ 'type': 'E', \ 'lnum': l:diagnostic.range.start.line + 1, \ 'col': l:diagnostic.range.start.character + 1, @@ -42,3 +42,26 @@ function! ale#lsp#response#ReadDiagnostics(params) abort return [l:filename, l:loclist] endfunction + +function! ale#lsp#response#ReadTSServerDiagnostics(response) abort + let l:loclist = [] + + for l:diagnostic in a:response.body.diagnostics + let l:loclist_item = { + \ 'text': l:diagnostic.text, + \ 'type': 'E', + \ 'lnum': l:diagnostic.start.line, + \ 'col': l:diagnostic.start.offset, + \ 'end_lnum': l:diagnostic.end.line, + \ 'end_col': l:diagnostic.end.offset, + \} + + if has_key(l:diagnostic, 'code') + let l:loclist_item.nr = l:diagnostic.code + endif + + call add(l:loclist, l:loclist_item) + endfor + + return l:loclist +endfunction diff --git a/autoload/ale/lsp/tsserver_message.vim b/autoload/ale/lsp/tsserver_message.vim index fff1797e..dc5a4717 100644 --- a/autoload/ale/lsp/tsserver_message.vim +++ b/autoload/ale/lsp/tsserver_message.vim @@ -19,16 +19,19 @@ endfunction function! ale#lsp#tsserver_message#Change(buffer) abort let l:lines = getbufline(a:buffer, 1, '$') + " We will always use a very high endLine number, so we can delete + " lines from files. tsserver will gladly accept line numbers beyond the + " end. return [1, 'ts@change', { \ 'file': expand('#' . a:buffer . ':p'), \ 'line': 1, \ 'offset': 1, - \ 'endLine': len(l:lines), - \ 'endOffset': len(l:lines[-1]), + \ 'endLine': 1073741824 , + \ 'endOffset': 1, \ 'insertString': join(l:lines, "\n"), \}] endfunction function! ale#lsp#tsserver_message#Geterr(buffer) abort - return [1, 'ts@geterr', {'files': [expand('#' . a:buffer . ':p')]}] + return [0, 'ts@geterr', {'files': [expand('#' . a:buffer . ':p')]}] endfunction diff --git a/test/lsp/test_lsp_client_messages.vader b/test/lsp/test_lsp_client_messages.vader index a967e4ec..75f5826a 100644 --- a/test/lsp/test_lsp_client_messages.vader +++ b/test/lsp/test_lsp_client_messages.vader @@ -127,8 +127,8 @@ Execute(ale#lsp#tsserver_message#Change() should return correct messages): \ 'file': b:dir . '/foo.ts', \ 'line': 1, \ 'offset': 1, - \ 'endLine': 3, - \ 'endOffset': 5, + \ 'endLine': 1073741824, + \ 'endOffset': 1, \ 'insertString': "foo()\nbar()\nbaz()", \ } \ ], @@ -139,7 +139,7 @@ Execute(ale#lsp#tsserver_message#Geterr() should return correct messages): AssertEqual \ [ - \ 1, + \ 0, \ 'ts@geterr', \ { \ 'files': [b:dir . '/foo.ts'], diff --git a/test/lsp/test_lsp_connections.vader b/test/lsp/test_lsp_connections.vader index 82e3fc64..1faa7a03 100644 --- a/test/lsp/test_lsp_connections.vader +++ b/test/lsp/test_lsp_connections.vader @@ -110,55 +110,63 @@ Execute(ale#lsp#CreateMessageData() should create tsserver notification messages AssertEqual \ [ \ 0, - \ '{"seq": null, "type": "request", "command": "someNotification"}', + \ '{"seq": null, "type": "request", "command": "someNotification"}' + \ . "\n", \ ], \ ale#lsp#CreateMessageData([1, 'ts@someNotification']) AssertEqual \ [ \ 0, - \ '{"seq": null, "arguments": {"foo": "bar"}, "type": "request", "command": "someNotification"}', + \ '{"seq": null, "arguments": {"foo": "bar"}, "type": "request", "command": "someNotification"}' + \ . "\n", \ ], \ ale#lsp#CreateMessageData([1, 'ts@someNotification', {'foo': 'bar'}]) else AssertEqual \ [ \ 0, - \ '{"seq":null,"type":"request","command":"someNotification"}', + \ '{"seq":null,"type":"request","command":"someNotification"}' + \ . "\n", \ ], \ ale#lsp#CreateMessageData([1, 'ts@someNotification']) AssertEqual \ [ \ 0, - \ '{"seq":null,"arguments":{"foo":"bar"},"type":"request","command":"someNotification"}', + \ '{"seq":null,"arguments":{"foo":"bar"},"type":"request","command":"someNotification"}' + \ . "\n", \ ], \ ale#lsp#CreateMessageData([1, 'ts@someNotification', {'foo': 'bar'}]) endif -Execute(ale#lsp#CreateMessageData() should create tsserver messages excepting responses): +Execute(ale#lsp#CreateMessageData() should create tsserver messages expecting responses): if has('nvim') AssertEqual \ [ \ 1, - \ '{"seq": 1, "type": "request", "command": "someMessage"}', + \ '{"seq": 1, "type": "request", "command": "someMessage"}' + \ . "\n", \ ], \ ale#lsp#CreateMessageData([0, 'ts@someMessage']) AssertEqual \ [ \ 2, - \ '{"seq": 2, "arguments": {"foo": "bar"}, "type": "request", "command": "someMessage"}', + \ '{"seq": 2, "arguments": {"foo": "bar"}, "type": "request", "command": "someMessage"}' + \ . "\n", \ ], \ ale#lsp#CreateMessageData([0, 'ts@someMessage', {'foo': 'bar'}]) else AssertEqual \ [ \ 1, - \ '{"seq":1,"type":"request","command":"someMessage"}', + \ '{"seq":1,"type":"request","command":"someMessage"}' + \ . "\n", \ ], \ ale#lsp#CreateMessageData([0, 'ts@someMessage']) AssertEqual \ [ \ 2, - \ '{"seq":2,"arguments":{"foo":"bar"},"type":"request","command":"someMessage"}', + \ '{"seq":2,"arguments":{"foo":"bar"},"type":"request","command":"someMessage"}' + \ . "\n", \ ], \ ale#lsp#CreateMessageData([0, 'ts@someMessage', {'foo': 'bar'}]) endif diff --git a/test/lsp/test_read_lsp_diagnostics.vader b/test/lsp/test_read_lsp_diagnostics.vader index b52da1bd..63086a7f 100644 --- a/test/lsp/test_read_lsp_diagnostics.vader +++ b/test/lsp/test_read_lsp_diagnostics.vader @@ -13,7 +13,7 @@ Execute(ale#lsp#response#ReadDiagnostics() should handle errors): AssertEqual ['filename.ts', [ \ { \ 'type': 'E', - \ 'message': 'Something went wrong!', + \ 'text': 'Something went wrong!', \ 'lnum': 3, \ 'col': 11, \ 'end_lnum': 5, @@ -34,7 +34,7 @@ Execute(ale#lsp#response#ReadDiagnostics() should handle warnings): AssertEqual ['filename.ts', [ \ { \ 'type': 'W', - \ 'message': 'Something went wrong!', + \ 'text': 'Something went wrong!', \ 'lnum': 2, \ 'col': 4, \ 'end_lnum': 2, @@ -55,7 +55,7 @@ Execute(ale#lsp#response#ReadDiagnostics() should treat messages with missing se AssertEqual ['filename.ts', [ \ { \ 'type': 'E', - \ 'message': 'Something went wrong!', + \ 'text': 'Something went wrong!', \ 'lnum': 3, \ 'col': 11, \ 'end_lnum': 5, @@ -75,7 +75,7 @@ Execute(ale#lsp#response#ReadDiagnostics() should handle messages without codes) AssertEqual ['filename.ts', [ \ { \ 'type': 'E', - \ 'message': 'Something went wrong!', + \ 'text': 'Something went wrong!', \ 'lnum': 3, \ 'col': 11, \ 'end_lnum': 5, @@ -93,7 +93,7 @@ Execute(ale#lsp#response#ReadDiagnostics() should handle multiple messages): AssertEqual ['filename.ts', [ \ { \ 'type': 'E', - \ 'message': 'Something went wrong!', + \ 'text': 'Something went wrong!', \ 'lnum': 1, \ 'col': 3, \ 'end_lnum': 1, @@ -101,7 +101,7 @@ Execute(ale#lsp#response#ReadDiagnostics() should handle multiple messages): \ }, \ { \ 'type': 'W', - \ 'message': 'A warning', + \ 'text': 'A warning', \ 'lnum': 2, \ 'col': 5, \ 'end_lnum': 2, @@ -119,3 +119,17 @@ Execute(ale#lsp#response#ReadDiagnostics() should handle multiple messages): \ 'message': 'A warning', \ }, \ ]}) + +Execute(ale#lsp#response#ReadTSServerDiagnostics() should handle tsserver responses): + AssertEqual [ + \ { + \ 'type': 'E', + \ 'nr': 2365, + \ 'text': 'Operator ''''+'''' cannot be applied to types ''''3'''' and ''''{}''''.', + \ 'lnum': 1, + \ 'col': 11, + \ 'end_lnum': 1, + \ 'end_col': 17, + \ }, + \], + \ ale#lsp#response#ReadTSServerDiagnostics({"seq":0,"type":"event","event":"semanticDiag","body":{"file":"/bar/foo.ts","diagnostics":[{"start":{"line":1,"offset":11},"end":{"line":1,"offset":17},"text":"Operator ''+'' cannot be applied to types ''3'' and ''{}''.","code":2365}]}}) -- cgit v1.2.3