summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--README.md4
-rw-r--r--ale_linters/ocaml/ols.vim14
-rw-r--r--ale_linters/reason/ols.vim14
-rw-r--r--autoload/ale/handlers/ols.vim25
-rw-r--r--doc/ale-ocaml.txt22
-rw-r--r--doc/ale-reasonml.txt23
-rw-r--r--doc/ale.txt6
7 files changed, 104 insertions, 4 deletions
diff --git a/README.md b/README.md
index 7cfbf62e..2a74d858 100644
--- a/README.md
+++ b/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) |
diff --git a/ale_linters/ocaml/ols.vim b/ale_linters/ocaml/ols.vim
new file mode 100644
index 00000000..c0255a6c
--- /dev/null
+++ b/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',
+\})
diff --git a/ale_linters/reason/ols.vim b/ale_linters/reason/ols.vim
new file mode 100644
index 00000000..b2cd5f79
--- /dev/null
+++ b/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',
+\})
diff --git a/autoload/ale/handlers/ols.vim b/autoload/ale/handlers/ols.vim
new file mode 100644
index 00000000..1dda7f92
--- /dev/null
+++ b/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
diff --git a/doc/ale-ocaml.txt b/doc/ale-ocaml.txt
index 093d9113..cfa365af 100644
--- a/doc/ale-ocaml.txt
+++ b/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:
diff --git a/doc/ale-reasonml.txt b/doc/ale-reasonml.txt
index d533d856..36ddd75d 100644
--- a/doc/ale-reasonml.txt
+++ b/doc/ale-reasonml.txt
@@ -11,6 +11,29 @@ merlin *ale-reasonml-merlin*
(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*
g:ale_reasonml_refmt_executable *g:ale_reasonml_refmt_executable*
diff --git a/doc/ale.txt b/doc/ale.txt
index 54f1b223..ae6b7abe 100644
--- a/doc/ale.txt
+++ b/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`
generated by cgit v1.2.3 (git 2.25.1) at 2024-09-21 14:12:09 +0000