summaryrefslogtreecommitdiff
path: root/doc/ale-hack.txt
diff options
context:
space:
mode:
authorFred Emmott <fe@fb.com>2018-07-27 13:50:59 -0700
committerFred Emmott <fe@fb.com>2018-08-02 11:28:56 -0700
commit238201805dd23ea422a107b3170de7892335137b (patch)
treee214989c1a7dd048a0d162dc27d70a92479a62db /doc/ale-hack.txt
parent5f024eda093dcce62159a6f262ffb084ccce4e51 (diff)
downloadale-238201805dd23ea422a107b3170de7892335137b.zip
Split Hack out from PHP, modernize
fixes #1738 - Replace previous `hh_client` usage with LSP client - Add `HHAST` linter - Split Hack from PHP: Hack is increasingly diverging from PHP: - Hack tools do not understand PHP - Most PHP tools do not handle Hack code well (including vim's syntax highightling files) - http://github.com/hhvm/vim-hack now sets filetype to `hack`
Diffstat (limited to 'doc/ale-hack.txt')
-rw-r--r--doc/ale-hack.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/ale-hack.txt b/doc/ale-hack.txt
new file mode 100644
index 00000000..0fbe5c45
--- /dev/null
+++ b/doc/ale-hack.txt
@@ -0,0 +1,42 @@
+===============================================================================
+ALE Hack Integration *ale-hack-options*
+
+===============================================================================
+hack *ale-hack-hack*
+
+g:ale_hack_hhclient_executable *g:ale_hack_hhclient_executable*
+ *b:ale_hack_hhclient_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*
+
+g:ale_hack_hackfmt_options *g:ale_hack_hackfmt_options*
+ *b:ale_hack_hackfmt_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to the hackfmt fixer.
+
+
+===============================================================================
+hhast *ale-hack-hhast*
+
+g:ale_hack_hhast_executable *g:ale_hack_hhast_executable*
+ *b: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: