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

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

diff --git a/.vim/bundle/ale/doc/ale-hack.txt b/.vim/bundle/ale/doc/ale-hack.txt
new file mode 100644 (file)
index 0000000..3bf74bc
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-hack.txt
@@ -0,0 +1,61 @@
+===============================================================================
+ALE Hack Integration                                         *ale-hack-options*
+                                                         *ale-integration-hack*
+
+  HHAST is disabled by default, as it executes code in the project root.
+
+  Currently linters must be enabled globally. HHAST can be enabled in ftplugin
+  files like so: >
+
+  let b:ale_linters = ['hack', 'hhast']
+<
+  Or in Lua: >
+  require("ale").setup.buffer({linters = {"hack", "hhast"}})
+<
+
+===============================================================================
+hack                                                            *ale-hack-hack*
+
+                                             *ale-options.hack_hack_executable*
+                                                   *g:ale_hack_hack_executable*
+                                                   *b:ale_hack_hack_executable*
+hack_hack_executable
+g:ale_hack_hack_executable
+  Type: |String|
+  Default: `'hh_client'`
+
+  This variable can be set to use a specific executable to interact with the
+  Hack typechecker.
+
+
+===============================================================================
+hackfmt                                                      *ale-hack-hackfmt*
+
+                                             *ale-options.hack_hackfmt_options*
+                                                   *g:ale_hack_hackfmt_options*
+                                                   *b:ale_hack_hackfmt_options*
+hack_hackfmt_options
+g:ale_hack_hackfmt_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be set to pass additional options to the hackfmt fixer.
+
+
+===============================================================================
+hhast                                                          *ale-hack-hhast*
+
+                                            *ale-options.hack_hhast_executable*
+                                                  *g:ale_hack_hhast_executable*
+                                                  *b:ale_hack_hhast_executable*
+hack_hhast_executable
+g:ale_hack_hhast_executable
+  Type: |String|
+  Default: `'vendor/bin/hhast-lint'`
+
+  This variable can be set to use a specific executable to interact with the
+  Hack typechecker.
+
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: