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

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

diff --git a/.vim/bundle/ale/doc/ale-elm.txt b/.vim/bundle/ale/doc/ale-elm.txt
new file mode 100644 (file)
index 0000000..59be895
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-elm.txt
@@ -0,0 +1,128 @@
+===============================================================================
+ALE Elm Integration                                           *ale-elm-options*
+
+
+===============================================================================
+elm-format                                                 *ale-elm-elm-format*
+
+                                            *ale-options.elm_format_executable*
+                                                  *g:ale_elm_format_executable*
+                                                  *b:ale_elm_format_executable*
+elm_format_executable
+g:ale_elm_format_executable
+  Type: |String|
+  Default: `'elm-format'`
+
+  See |ale-integrations-local-executables|
+
+                                            *ale-options.elm_format_use_global*
+                                                  *g:ale_elm_format_use_global*
+                                                  *b:ale_elm_format_use_global*
+elm_format_use_global
+g:ale_elm_format_use_global
+  Type: |Number|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  See |ale-integrations-local-executables|
+
+                                               *ale-options.elm_format_options*
+                                                     *g:ale_elm_format_options*
+                                                     *b:ale_elm_format_options*
+elm_format_options
+g:ale_elm_format_options
+  Type: |String|
+  Default: `'--yes'`
+
+  This variable can be set to pass additional options to elm-format.
+
+
+===============================================================================
+elm-ls                                                         *ale-elm-elm-ls*
+
+                                                *ale-options.elm_ls_executable*
+                                                      *g:ale_elm_ls_executable*
+                                                      *b:ale_elm_ls_executable*
+elm_ls_executable
+g:ale_elm_ls_executable
+  Type: |String|
+  Default: `'elm-language-server'`
+
+  See |ale-integrations-local-executables|
+
+                                                *ale-options.elm_ls_use_global*
+                                                      *g:ale_elm_ls_use_global*
+                                                      *b:ale_elm_ls_use_global*
+elm_ls_use_global
+g:ale_elm_ls_use_global
+  Type: |Number|
+  Default: `get(g:, 'ale_use_global_executables', 1)`
+
+  See |ale-integrations-local-executables|
+
+                                                  *ale-options.elm_ls_elm_path*
+                                                        *g:ale_elm_ls_elm_path*
+                                                        *b:ale_elm_ls_elm_path*
+elm_ls_elm_path
+g:ale_elm_ls_elm_path
+  Type: |String|
+  Default: `''`
+
+  See |ale-integrations-local-executables|
+
+                                           *ale-options.elm_ls_elm_format_path*
+                                                 *g:ale_elm_ls_elm_format_path*
+                                                 *b:ale_elm_ls_elm_format_path*
+elm_ls_elm_format_path
+g:ale_elm_ls_elm_format_path
+  Type: |String|
+  Default: `''`
+
+  See |ale-integrations-local-executables|
+
+                                             *ale-options.elm_ls_elm_test_path*
+                                                   *g:ale_elm_ls_elm_test_path*
+                                                   *b:ale_elm_ls_elm_test_path*
+elm_ls_elm_test_path
+g:ale_elm_ls_elm_test_path
+  Type: |String|
+  Default: `''`
+
+  See |ale-integrations-local-executables|
+
+                                       *ale-options.elm_ls_elm_analyse_trigger*
+                                             *g:ale_elm_ls_elm_analyse_trigger*
+                                             *b:ale_elm_ls_elm_analyse_trigger*
+elm_ls_elm_analyse_trigger
+g:ale_elm_ls_elm_analyse_trigger
+  Type: |String|
+  Default: `'change'`
+
+  One of 'change', 'save' or 'never'
+
+
+===============================================================================
+elm-make                                                     *ale-elm-elm-make*
+
+                                              *ale-options.elm_make_executable*
+                                                    *g:ale_elm_make_executable*
+                                                    *b:ale_elm_make_executable*
+elm_make_executable
+g:ale_elm_make_executable
+  Type: |String|
+  Default: `'elm'`
+
+  See |ale-integrations-local-executables|
+
+                                              *ale-options.elm_make_use_global*
+                                                    *g:ale_elm_make_use_global*
+                                                    *b:ale_elm_make_use_global*
+elm_make_use_global
+g:ale_elm_make_use_global
+  Type: |Number|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  See |ale-integrations-local-executables|
+
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: