summaryrefslogtreecommitdiff
path: root/doc/ale-sh.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ale-sh.txt')
-rw-r--r--doc/ale-sh.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/ale-sh.txt b/doc/ale-sh.txt
new file mode 100644
index 00000000..aee13912
--- /dev/null
+++ b/doc/ale-sh.txt
@@ -0,0 +1,31 @@
+===============================================================================
+ALE Shell Integration *ale-sh-options*
+
+
+-------------------------------------------------------------------------------
+shell *ale-sh-shell*
+
+g:ale_linters_sh_shell_default_shell *g:ale_linters_sh_shell_default_shell*
+
+ Type: |String|
+ Default: The current shell (`$SHELL`) or `'bash'` if that cannot be read.
+
+ When ALE runs the linter for shells with the `-n` flag, it will attempt to
+ read the shell from the shebang (`#!`) line from the shell script to
+ determine the shell program to run. When this detection fails, this variable
+ will be used instead.
+
+
+-------------------------------------------------------------------------------
+shellcheck *ale-sh-shellcheck*
+
+g:ale_linters_sh_shellcheck_exclusions *g:ale_linters_sh_shellcheck_exclusions*
+
+ Type: |String|
+ Default: `''`
+
+ Set this variable to exclude test(s) for shellcheck (-e/--exclude option).
+
+
+-------------------------------------------------------------------------------
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: