summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2018-01-02 13:32:59 +0000
committerGitHub <noreply@github.com>2018-01-02 13:32:59 +0000
commit80342b119aa1e8fda62ca24cc0000ae3e9709dd1 (patch)
treea15d9b3673b36e4007872c2633a73b29bec19cc0 /doc
parentd9a3722e060a52d92e5a95fa3a10c1b51ef6b5b4 (diff)
parent3b0c67e42c4bffbe90edb98a181497a9791d9de4 (diff)
downloadale-80342b119aa1e8fda62ca24cc0000ae3e9709dd1.zip
Merge pull request #1252 from nthapaliya/fish-shell-linter
Fish shell linter
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-fish.txt14
-rw-r--r--doc/ale.txt2
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/ale-fish.txt b/doc/ale-fish.txt
new file mode 100644
index 00000000..8450b38a
--- /dev/null
+++ b/doc/ale-fish.txt
@@ -0,0 +1,14 @@
+===============================================================================
+ALE Fish Integration *ale-fish-options*
+
+Lints fish files using `fish -n`.
+
+Note that `fish -n` is not foolproof: it sometimes gives false positives or
+errors that are difficult to parse without more context. This integration skips
+displaying errors if an error message is not found.
+
+If ALE is not showing any errors but your file does not run as expected, run
+`fish -n <file.fish>` from the command line.
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 3eb6c6df..a7d53b0c 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -64,6 +64,7 @@ CONTENTS *ale-contents*
erlc................................|ale-erlang-erlc|
syntaxerl...........................|ale-erlang-syntaxerl|
eruby.................................|ale-eruby-options|
+ fish..................................|ale-fish-options|
fortran...............................|ale-fortran-options|
gcc.................................|ale-fortran-gcc|
fountain..............................|ale-fountain-options|
@@ -301,6 +302,7 @@ Notes:
* Elm: `elm-format, elm-make`
* Erb: `erb`, `erubis`
* Erlang: `erlc`, `SyntaxErl`
+* Fish: `fish` (-n flag)
* Fortran: `gcc`
* Fountain: `proselint`
* FusionScript: `fusion-lint`