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

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

diff --git a/.vim/bundle/ale/doc/ale-purescript.txt b/.vim/bundle/ale/doc/ale-purescript.txt
new file mode 100644 (file)
index 0000000..32f427f
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-purescript.txt
@@ -0,0 +1,93 @@
+===============================================================================
+ALE PureScript Integration                             *ale-purescript-options*
+
+
+===============================================================================
+purescript-language-server                     *ale-purescript-language-server*
+
+PureScript Language Server
+  (https://github.com/nwolverson/purescript-language-server)
+
+                                         *ale-options.purescript_ls_executable*
+                                               *g:ale_purescript_ls_executable*
+                                               *b:ale_purescript_ls_executable*
+purescript_ls_executable
+g:ale_purescript_ls_executable
+  Type: |String|
+  Default: `'purescript-language-server'`
+
+  PureScript language server executable.
+
+                                             *ale-options.purescript_ls_config*
+                                                   *g:ale_purescript_ls_config*
+                                                   *b:ale_purescript_ls_config*
+purescript_ls_config
+g:ale_purescript_ls_config
+  Type: |Dictionary|
+  Default: `{}`
+
+  Dictionary containing configuration settings that will be passed to the
+  language server. For example, with a spago project: >
+
+  let g:ale_purescript_ls_config = {
+  \   'purescript': {
+  \       'addSpagoSources': v:true,
+  \       'addNpmPath': v:true,
+  \       'buildCommand': 'spago --quiet build --purs-args --json-errors',
+  \   },
+  \}
+<
+
+===============================================================================
+purs-tidy                                                 *ale-purescript-tidy*
+
+                                       *ale-options.purescript_tidy_executable*
+                                             *g:ale_purescript_tidy_executable*
+                                             *b:ale_purescript_tidy_executable*
+purescript_tidy_executable
+g:ale_purescript_tidy_executable
+  Type: |String|
+  Default: `'purs-tidy'`
+
+  This variable can be changed to use a different executable for purs-tidy.
+
+                                       *ale-options.purescript_tidy_use_global*
+                                             *g:ale_purescript_tidy_use_global*
+                                             *b:ale_purescript_tidy_use_global*
+purescript_tidy_use_global
+g:ale_purescript_tidy_use_global
+  Type: |Number|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  See |ale-integrations-local-executables|
+
+                                          *ale-options.purescript_tidy_options*
+                                                *g:ale_purescript_tidy_options*
+                                                *b:ale_purescript_tidy_options*
+purescript_tidy_options
+g:ale_purescript_tidy_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be set to pass in additional option to the 'purs-tidy'
+  executable.
+>
+  let g:ale_purescript_options = '--indent 3'
+<
+
+===============================================================================
+purty                                                    *ale-purescript-purty*
+
+                                      *ale-options.purescript_purty_executable*
+                                            *g:ale_purescript_purty_executable*
+                                            *b:ale_purescript_purty_executable*
+purescript_purty_executable
+g:ale_purescript_purty_executable
+  Type: |String|
+  Default: `'purty'`
+
+  This variable can be changed to use a different executable for purty.
+
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: