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

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

diff --git a/.vim/bundle/ale/doc/ale-racket.txt b/.vim/bundle/ale/doc/ale-racket.txt
new file mode 100644 (file)
index 0000000..6188b04
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-racket.txt
@@ -0,0 +1,49 @@
+===============================================================================
+ALE Racket Integration                                       *ale-racket-options*
+
+
+===============================================================================
+racket_langserver                                         *ale-racket-langserver*
+
+1. Install racket-langserver as described here:
+   https://github.com/jeapostrophe/racket-langserver
+2. Have `racket` available in the `$PATH` environment variable, currently there
+   is no way to specify path to custom location of `racket`.
+3. set `racket_langserver` as a linter for `racket` like: >
+   let g:ale_linters['racket'] += ['racket_langserver']
+
+You should be able to see linter results and use LSP features of `ALE` like
+`ALEGoToDefinition` with `racket-langserver`.
+
+
+===============================================================================
+raco_fmt                                                    *ale-racket-raco-fmt*
+
+                                       *ale-options.racket_raco_fmt_executable*
+                                             *g:ale_racket_raco_fmt_executable*
+                                               *b:ale_racket_raco_fmt_executable*
+racket_raco_fmt_executable
+g:ale_racket_raco_fmt_executable
+  Type: |String|
+  Default: `'raco'`
+
+  If the `raco` excutable is not in the `$PATH` environment variable, or you
+  prefer to use one installed in a custom location, set this option to the
+  path to the specific `raco` executable.
+
+                                          *ale-options.racket_raco_fmt_options*
+                                                *g:ale_racket_raco_fmt_options*
+                                                  *b:ale_racket_raco_fmt_options*
+racket_raco_fmt_options
+g:ale_racket_raco_fmt_options
+  Type: |String|
+  Default: `''`
+
+  Use this variable to pass command-line flags/parameters to `raco_fmt`
+
+  For example, set the page width limit to 40 >
+  let g:ale_racket_raco_fmt_options = '--width 40'
+
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: