summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Jungo <michaeljungo92@gmail.com>2017-11-11 19:27:41 +0100
committerw0rp <devw0rp@gmail.com>2017-11-12 10:56:53 +0000
commit39107a48b99607fdebd1708cfaf0f115768c4899 (patch)
tree923d21fe70db88829abc4e13eec0784997ba20dd /doc
parent8e0d1f57c6f568a6845aa11a57add84a8f771b68 (diff)
downloadale-39107a48b99607fdebd1708cfaf0f115768c4899.zip
Add ocaml-language-server for OCaml and ReasonML
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-ocaml.txt22
-rw-r--r--doc/ale-reasonml.txt23
-rw-r--r--doc/ale.txt6
3 files changed, 49 insertions, 2 deletions
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 c78ba3b7..83a724f7 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -121,6 +121,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|
@@ -154,6 +155,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|
@@ -308,7 +310,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`
@@ -317,7 +319,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`