summaryrefslogtreecommitdiff
path: root/doc/ale-salt.tmt
diff options
context:
space:
mode:
authorBenjamin Binier <poulpatine@gmail.com>2020-12-17 08:59:57 +0100
committerBenjamin Binier <poulpatine@gmail.com>2020-12-17 09:19:19 +0100
commite358afdd9ba5108680afc6aa017075b44f6c18fa (patch)
treed35e4ba8e3fd90a304558ab32fe11f928faadcd9 /doc/ale-salt.tmt
parentf996ede5999c99b1b3e3cecc02dbd06cb286d3ff (diff)
downloadale-e358afdd9ba5108680afc6aa017075b44f6c18fa.zip
Add salt-lint support
Diffstat (limited to 'doc/ale-salt.tmt')
-rw-r--r--doc/ale-salt.tmt43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/ale-salt.tmt b/doc/ale-salt.tmt
new file mode 100644
index 00000000..ac500d37
--- /dev/null
+++ b/doc/ale-salt.tmt
@@ -0,0 +1,43 @@
+===============================================================================
+ALE SALT Integration *ale-salt-options*
+
+===============================================================================
+salt-lint *ale-salt-salt-lint*
+
+Website: https://github.com/warpnet/salt-lint
+
+
+Installation
+-------------------------------------------------------------------------------
+
+Install salt-lint in your a virtualenv directory, locally, or globally: >
+
+ pip install salt-lint # After activating virtualenv
+ pip install --user salt-lint # Install to ~/.local/bin
+ sudo pip install salt-lint # Install globally
+
+See |g:ale_virtualenv_dir_names| for configuring how ALE searches for
+virtualenv directories.
+
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_salt_salt-lint_executable *g:ale_salt_salt_lint_executable*
+ *b:ale_salt_salt_lint_executable*
+ Type: |String|
+ Default: `'salt-lint'`
+
+ This variable can be set to change the path to salt-lint.
+
+
+g:ale_salt_salt-lint_options *g:ale_salt_salt-lint_options*
+ *b:ale_salt_salt-lint_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to salt-lint.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: