summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBartek thindil Jasicki <thindil@laeran.pl>2021-01-08 09:43:19 +0100
committerBartek thindil Jasicki <thindil@laeran.pl>2021-01-08 09:43:19 +0100
commit7b1ed2733e2b73a74149f300d5400225f535f490 (patch)
treeb71be581af826a7f447b1c89897d7919106bf8df /doc
parent3fca5e73b605a07d3fdcf46cf24b1675aae5bca6 (diff)
parent54dd731cf14c809ebcc9c21b41084a17c5411744 (diff)
downloadale-7b1ed2733e2b73a74149f300d5400225f535f490.zip
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-python.txt9
-rw-r--r--doc/ale-salt.tmt43
-rw-r--r--doc/ale-supported-languages-and-tools.txt2
-rw-r--r--doc/ale.txt2
4 files changed, 56 insertions, 0 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index f0c8bfb8..504705f2 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -280,6 +280,15 @@ g:ale_python_isort_use_global *g:ale_python_isort_use_global*
See |ale-integrations-local-executables|
+g:ale_python_isort_auto_pipenv *g:ale_python_isort_auto_pipenv*
+ *b:ale_python_isort_auto_pipenv*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+ if true. This is overridden by a manually-set executable.
+
+
===============================================================================
mypy *ale-python-mypy*
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:
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 449bf6d8..3d6c50d1 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -429,6 +429,8 @@ Notes:
* `rust-analyzer`
* `rustc` (see |ale-integration-rust|)
* `rustfmt`
+* Salt
+ * `salt-lint`
* Sass
* `sass-lint`
* `stylelint`
diff --git a/doc/ale.txt b/doc/ale.txt
index 389447df..28f6902f 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2883,6 +2883,8 @@ documented in additional help files.
rls...................................|ale-rust-rls|
rustc.................................|ale-rust-rustc|
rustfmt...............................|ale-rust-rustfmt|
+ salt....................................|ale-salt-options|
+ salt-lint.............................|ale-salt-salt-lint|
sass....................................|ale-sass-options|
sasslint..............................|ale-sass-sasslint|
stylelint.............................|ale-sass-stylelint|