Merge pull request #1110 from jungomi/ocaml-language-server

* Add ocaml-language-server for OCaml and ReasonML
* Remove id from LSP notifications

README.md

@@ -120,7 +120,7 @@ formatting.
 | nroff | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good)|
 | Objective-C | [clang](http://clang.llvm.org/) |
 | Objective-C++ | [clang](http://clang.llvm.org/) |
-| OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions |
+| OCaml | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-ocaml-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server) |
 | Perl | [perl -c](https://perl.org/), [perl-critic](https://metacpan.org/pod/Perl::Critic) |
 | PHP | [hack](http://hacklang.org/), [hackfmt](https://github.com/facebook/flow/tree/master/hack/hackfmt), [langserver](https://github.com/felixfbecker/php-language-server), [phan](https://github.com/phan/phan) see `:help ale-php-phan` to instructions, [php -l](https://secure.php.net/), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpmd](https://phpmd.org), [phpstan](https://github.com/phpstan/phpstan), [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) |
 | Pod | [proselint](http://proselint.com/), [write-good](https://github.com/btford/write-good) |
@@ -129,7 +129,7 @@ formatting.
 | Puppet | [puppet](https://puppet.com), [puppet-lint](https://puppet-lint.com) |
 | Python | [autopep8](https://github.com/hhatto/autopep8), [flake8](http://flake8.pycqa.org/en/latest/), [isort](https://github.com/timothycrosley/isort), [mypy](http://mypy-lang.org/), [pycodestyle](https://github.com/PyCQA/pycodestyle), [pyls](https://github.com/palantir/python-language-server), [pylint](https://www.pylint.org/) !!, [yapf](https://github.com/google/yapf) |
 | R | [lintr](https://github.com/jimhester/lintr) |
-| ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [refmt](https://github.com/reasonml/reason-cli) |
+| ReasonML | [merlin](https://github.com/the-lambda-church/merlin) see `:help ale-integration-reason-merlin` for configuration instructions, [ols](https://github.com/freebroccolo/ocaml-language-server), [refmt](https://github.com/reasonml/reason-cli) |
 | reStructuredText | [proselint](http://proselint.com/), [rstcheck](https://github.com/myint/rstcheck), [write-good](https://github.com/btford/write-good) |
 | RPM spec | [rpmlint](https://github.com/rpm-software-management/rpmlint) (disabled by default; see `:help ale-integration-spec`) |
 | Ruby | [brakeman](http://brakemanscanner.org/) !!, [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) !!, [reek](https://github.com/troessner/reek), [rubocop](https://github.com/bbatsov/rubocop), [ruby](https://www.ruby-lang.org) |

ale_linters/ocaml/ols.vim

@@ -0,0 +1,14 @@
+" Author: Michael Jungo <michaeljungo92@gmail.com>
+" Description: A language server for OCaml
+
+call ale#Set('ocaml_ols_executable', 'ocaml-language-server')
+call ale#Set('ocaml_ols_use_global', 0)
+
+call ale#linter#Define('ocaml', {
+\   'name': 'ols',
+\   'lsp': 'stdio',
+\   'executable_callback': 'ale#handlers#ols#GetExecutable',
+\   'command_callback': 'ale#handlers#ols#GetCommand',
+\   'language_callback': 'ale#handlers#ols#GetLanguage',
+\   'project_root_callback': 'ale#handlers#ols#GetProjectRoot',
+\})

ale_linters/reason/ols.vim

@@ -0,0 +1,14 @@
+" Author: Michael Jungo <michaeljungo92@gmail.com>
+" Description: A language server for Reason
+
+call ale#Set('reason_ols_executable', 'ocaml-language-server')
+call ale#Set('reason_ols_use_global', 0)
+
+call ale#linter#Define('reason', {
+\   'name': 'ols',
+\   'lsp': 'stdio',
+\   'executable_callback': 'ale#handlers#ols#GetExecutable',
+\   'command_callback': 'ale#handlers#ols#GetCommand',
+\   'language_callback': 'ale#handlers#ols#GetLanguage',
+\   'project_root_callback': 'ale#handlers#ols#GetProjectRoot',
+\})

autoload/ale/handlers/ols.vim

@@ -0,0 +1,25 @@
+" Author: Michael Jungo <michaeljungo92@gmail.com>
+" Description: Handlers for the OCaml language server
+
+function! ale#handlers#ols#GetExecutable(buffer) abort
+    let l:ols_setting = ale#handlers#ols#GetLanguage(a:buffer) . '_ols'
+    return ale#node#FindExecutable(a:buffer, l:ols_setting, [
+    \   'node_modules/.bin/ocaml-language-server',
+    \])
+endfunction
+
+function! ale#handlers#ols#GetCommand(buffer) abort
+    let l:executable = ale#handlers#ols#GetExecutable(a:buffer)
+
+    return ale#node#Executable(a:buffer, l:executable) . ' --stdio'
+endfunction
+
+function! ale#handlers#ols#GetLanguage(buffer) abort
+    return getbufvar(a:buffer, '&filetype')
+endfunction
+
+function! ale#handlers#ols#GetProjectRoot(buffer) abort
+    let l:merlin_file = ale#path#FindNearestFile(a:buffer, '.merlin')
+
+    return !empty(l:merlin_file) ? fnamemodify(l:merlin_file, ':h') : ''
+endfunction

autoload/ale/lsp.vim

@@ -83,9 +83,8 @@ function! ale#lsp#CreateMessageData(message) abort
     let l:is_notification = a:message[0]
 
     let l:obj = {
-    \   'id': v:null,
-    \   'jsonrpc': '2.0',
     \   'method': a:message[1],
+    \   'jsonrpc': '2.0',
     \}
 
     if !l:is_notification

doc/ale-ocaml.txt

@@ -10,6 +10,28 @@ merlin                                                       *ale-ocaml-merlin*
   detailed instructions
   (https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch).
 
+===============================================================================
+ols                                                             *ale-ocaml-ols*
+
+  The `ocaml-language-server` is the engine that powers OCaml and ReasonML
+  editor support using the Language Server Protocol. See the installation
+  instructions:
+  https://github.com/freebroccolo/ocaml-language-server#installation
+
+g:ale_ocaml_ols_executable                         *g:ale_ocaml_ols_executable*
+                                                   *b:ale_ocaml_ols_executable*
+  Type: |String|
+  Default: `'ocaml-language-server'`
+
+  This variable can be set to change the executable path for `ols`.
+
+g:ale_ocaml_ols_use_global                         *g:ale_ocaml_ols_use_global*
+                                                   *b:ale_ocaml_ols_use_global*
+  Type: |String|
+  Default: `0`
+
+  This variable can be set to `1` to always use the globally installed
+  executable. See also |ale-integrations-local-executables|.
 
 ===============================================================================
   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

doc/ale-reasonml.txt

@@ -10,6 +10,29 @@ merlin                                                    *ale-reasonml-merlin*
   detailed instructions
   (https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch).
 
+===============================================================================
+ols                                                          *ale-reasonml-ols*
+
+  The `ocaml-language-server` is the engine that powers OCaml and ReasonML
+  editor support using the Language Server Protocol. See the installation
+  instructions:
+  https://github.com/freebroccolo/ocaml-language-server#installation
+
+g:ale_reason_ols_executable                       *g:ale_reason_ols_executable*
+                                                  *b:ale_reason_ols_executable*
+  Type: |String|
+  Default: `'ocaml-language-server'`
+
+  This variable can be set to change the executable path for `ols`.
+
+g:ale_reason_ols_use_global                       *g:ale_reason_ols_use_global*
+                                                  *b:ale_reason_ols_use_global*
+  Type: |String|
+  Default: `0`
+
+  This variable can be set to `1` to always use the globally installed
+  executable. See also |ale-integrations-local-executables|.
+
 ===============================================================================
 refmt                                                      *ale-reasonml-refmt*
 

doc/ale.txt

@@ -120,6 +120,7 @@ CONTENTS                                                         *ale-contents*
       clang...............................|ale-objcpp-clang|
     ocaml.................................|ale-ocaml-options|
       merlin..............................|ale-ocaml-merlin|
+      ols.................................|ale-ocaml-ols|
     perl..................................|ale-perl-options|
       perl................................|ale-perl-perl|
       perlcritic..........................|ale-perl-perlcritic|
@@ -153,6 +154,7 @@ CONTENTS                                                         *ale-contents*
       lintr...............................|ale-r-lintr|
     reasonml..............................|ale-reasonml-options|
       merlin..............................|ale-reasonml-merlin|
+      ols.................................|ale-reasonml-ols|
       refmt...............................|ale-reasonml-refmt|
     restructuredtext......................|ale-restructuredtext-options|
       write-good..........................|ale-restructuredtext-write-good|
@@ -306,7 +308,7 @@ Notes:
 * nroff: `proselint`, `write-good`
 * Objective-C: `clang`
 * Objective-C++: `clang`
-* OCaml: `merlin` (see |ale-ocaml-merlin|)
+* OCaml: `merlin` (see |ale-ocaml-merlin|), `ols`
 * Perl: `perl -c`, `perl-critic`
 * PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf`
 * Pod: `proselint`, `write-good`
@@ -315,7 +317,7 @@ Notes:
 * Puppet: `puppet`, `puppet-lint`
 * Python: `autopep8`, `flake8`, `isort`, `mypy`, `pycodestyle`, `pyls`, `pylint`!!, `yapf`
 * R: `lintr`
-* ReasonML: `merlin`, `refmt`
+* ReasonML: `merlin`, `ols`, `refmt`
 * reStructuredText: `proselint`, `rstcheck`, `write-good`
 * RPM spec: `rpmlint`
 * Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby`

test/lsp/test_lsp_connections.vader

@@ -26,7 +26,7 @@ Execute(ale#lsp#CreateMessageData() should create an appropriate message):
       \ [
       \   1,
       \   "Content-Length: 79\r\n\r\n"
-      \   . '{"id": 1, "jsonrpc": "2.0", "method": "someMethod", "params": {"foo": "barÜ"}}',
+      \   . '{"method": "someMethod", "jsonrpc": "2.0", "id": 1, "params": {"foo": "barÜ"}}',
       \ ],
       \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}])
       " Check again to ensure that we use the next ID.
@@ -34,7 +34,7 @@ Execute(ale#lsp#CreateMessageData() should create an appropriate message):
       \ [
       \   2,
       \   "Content-Length: 79\r\n\r\n"
-      \   . '{"id": 2, "jsonrpc": "2.0", "method": "someMethod", "params": {"foo": "barÜ"}}',
+      \   . '{"method": "someMethod", "jsonrpc": "2.0", "id": 2, "params": {"foo": "barÜ"}}',
       \ ],
       \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}])
     else
@@ -42,14 +42,14 @@ Execute(ale#lsp#CreateMessageData() should create an appropriate message):
       \ [
       \   1,
       \   "Content-Length: 71\r\n\r\n"
-      \   . '{"id":1,"jsonrpc":"2.0","method":"someMethod","params":{"foo":"barÜ"}}',
+      \   . '{"method":"someMethod","jsonrpc":"2.0","id":1,"params":{"foo":"barÜ"}}',
       \ ],
       \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}])
       AssertEqual
       \ [
       \   2,
       \   "Content-Length: 71\r\n\r\n"
-      \   . '{"id":2,"jsonrpc":"2.0","method":"someMethod","params":{"foo":"barÜ"}}',
+      \   . '{"method":"someMethod","jsonrpc":"2.0","id":2,"params":{"foo":"barÜ"}}',
       \ ],
       \ ale#lsp#CreateMessageData([0, 'someMethod', {'foo': 'barÜ'}])
     endif
@@ -60,7 +60,7 @@ Execute(ale#lsp#CreateMessageData() should create messages without params):
       \ [
       \   1,
       \   "Content-Length: 56\r\n\r\n"
-      \   . '{"id": 1, "jsonrpc": "2.0", "method": "someOtherMethod"}',
+      \   . '{"method": "someOtherMethod", "jsonrpc": "2.0", "id": 1}',
       \ ],
       \ ale#lsp#CreateMessageData([0, 'someOtherMethod'])
     else
@@ -68,7 +68,7 @@ Execute(ale#lsp#CreateMessageData() should create messages without params):
       \ [
       \   1,
       \   "Content-Length: 51\r\n\r\n"
-      \   . '{"id":1,"jsonrpc":"2.0","method":"someOtherMethod"}',
+      \   . '{"method":"someOtherMethod","jsonrpc":"2.0","id":1}',
       \ ],
       \ ale#lsp#CreateMessageData([0, 'someOtherMethod'])
     endif
@@ -78,30 +78,30 @@ Execute(ale#lsp#CreateMessageData() should create notifications):
       AssertEqual
       \ [
       \   0,
-      \   "Content-Length: 60\r\n\r\n"
+      \   "Content-Length: 48\r\n\r\n"
-      \   . '{"id": null, "jsonrpc": "2.0", "method": "someNotification"}',
+      \   . '{"method": "someNotification", "jsonrpc": "2.0"}',
       \ ],
       \ ale#lsp#CreateMessageData([1, 'someNotification'])
       AssertEqual
       \ [
       \   0,
-      \   "Content-Length: 86\r\n\r\n"
+      \   "Content-Length: 74\r\n\r\n"
-      \   . '{"id": null, "jsonrpc": "2.0", "method": "someNotification", "params": {"foo": "bar"}}',
+      \   . '{"method": "someNotification", "jsonrpc": "2.0", "params": {"foo": "bar"}}',
       \ ],
       \ ale#lsp#CreateMessageData([1, 'someNotification', {'foo': 'bar'}])
     else
       AssertEqual
       \ [
       \   0,
-      \   "Content-Length: 55\r\n\r\n"
+      \   "Content-Length: 45\r\n\r\n"
-      \   . '{"id":null,"jsonrpc":"2.0","method":"someNotification"}',
+      \   . '{"method":"someNotification","jsonrpc":"2.0"}',
       \ ],
       \ ale#lsp#CreateMessageData([1, 'someNotification'])
       AssertEqual
       \ [
       \   0,
-      \   "Content-Length: 78\r\n\r\n"
+      \   "Content-Length: 68\r\n\r\n"
-      \   . '{"id":null,"jsonrpc":"2.0","method":"someNotification","params":{"foo":"bar"}}',
+      \   . '{"method":"someNotification","jsonrpc":"2.0","params":{"foo":"bar"}}',
       \ ],
       \ ale#lsp#CreateMessageData([1, 'someNotification', {'foo': 'bar'}])
     endif