Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'

[etc/vim.git] / .vim / bundle / ale / doc / ale-reasonml.txt

diff --git a/.vim/bundle/ale/doc/ale-reasonml.txt b/.vim/bundle/ale/doc/ale-reasonml.txt
new file mode 100644 (file)
index 0000000..2b6c231
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-reasonml.txt
@@ -0,0 +1,90 @@
+===============================================================================
+ALE ReasonML Integration                                 *ale-reasonml-options*
+
+
+===============================================================================
+merlin                                                    *ale-reasonml-merlin*
+
+To use merlin linter for ReasonML source code you need to make sure Merlin for
+Vim is correctly configured. See the corresponding Merlin wiki page for
+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
+
+
+-------------------------------------------------------------------------------
+Options
+                                            *ale-options.reason_ols_executable*
+                                                  *g:ale_reason_ols_executable*
+                                                  *b:ale_reason_ols_executable*
+reason_ols_executable
+g:ale_reason_ols_executable
+  Type: |String|
+  Default: `'ocaml-language-server'`
+
+  This variable can be set to change the executable path for `ols`.
+
+                                            *ale-options.reason_ols_use_global*
+                                                  *g:ale_reason_ols_use_global*
+                                                  *b:ale_reason_ols_use_global*
+reason_ols_use_global
+g:ale_reason_ols_use_global
+  Type: |String|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  This variable can be set to `1` to always use the globally installed
+  executable. See also |ale-integrations-local-executables|.
+
+
+===============================================================================
+reason-language-server                           *ale-reasonml-language-server*
+
+Note: You must set an executable - there is no 'default' install location.
+Go to https://github.com/jaredly/reason-language-server and download the
+latest release. You can place it anywhere, but ensure you set the executable
+path.
+
+                                             *ale-options.reason_ls_executable*
+                                                   *g:ale_reason_ls_executable*
+                                                   *b:ale_reason_ls_executable*
+reason_ls_executable
+g:ale_reason_ls_executable
+  Type: |String|
+
+  This variable defines the standard location of the language server
+  executable. This must be set.
+
+
+===============================================================================
+refmt                                                      *ale-reasonml-refmt*
+
+                                        *ale-options.reasonml_refmt_executable*
+                                              *g:ale_reasonml_refmt_executable*
+                                              *b:ale_reasonml_refmt_executable*
+reasonml_refmt_executable
+g:ale_reasonml_refmt_executable
+  Type: |String|
+  Default: `'refmt'`
+
+  This variable can be set to pass the path of the refmt fixer.
+
+                                           *ale-options.reasonml_refmt_options*
+                                                 *g:ale_reasonml_refmt_options*
+                                                 *b:ale_reasonml_refmt_options*
+reasonml_refmt_options
+g:ale_reasonml_refmt_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be set to pass additional options to the refmt fixer.
+
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: