summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2019-01-26 21:41:40 +0000
committerGitHub <noreply@github.com>2019-01-26 21:41:40 +0000
commita47deeae40d7deda5f237145b7496943bde913ef (patch)
tree08d30dccc53673430507fcd99385f3f550e2b729 /doc
parent452460b8cdff8b2809d0226b60183dbda5ae605d (diff)
parent0a5de2b42b3b8774b7aa12f028544ac3f81b8830 (diff)
downloadale-a47deeae40d7deda5f237145b7496943bde913ef.zip
Merge pull request #2250 from m-pilia/bandit
Add bandit linter for Python
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-python.txt39
-rw-r--r--doc/ale.txt3
2 files changed, 41 insertions, 1 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 3d355bc6..175216f6 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -66,6 +66,45 @@ g:ale_python_autopep8_use_global *g:ale_python_autopep8_use_global*
===============================================================================
+bandit *ale-python-bandit*
+
+g:ale_python_bandit_executable *g:ale_python_bandit_executable*
+ *b:ale_python_bandit_executable*
+ Type: |String|
+ Default: `'bandit'`
+
+ See |ale-integrations-local-executables|
+
+ Set this to `'pipenv'` to invoke `'pipenv` `run` `bandit'`.
+
+
+g:ale_python_bandit_options *g:ale_python_bandit_options*
+ *b:ale_python_bandit_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to add command-line arguments to the
+ bandit invocation.
+
+
+g:ale_python_bandit_use_global *g:ale_python_bandit_use_global*
+ *b:ale_python_bandit_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_python_bandit_auto_pipenv *g:ale_python_bandit_auto_pipenv*
+ *b:ale_python_bandit_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.
+
+
+===============================================================================
black *ale-python-black*
g:ale_python_black_executable *g:ale_python_black_executable*
diff --git a/doc/ale.txt b/doc/ale.txt
index e0de8d1e..580effc7 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -257,6 +257,7 @@ CONTENTS *ale-contents*
cython..............................|ale-pyrex-cython|
python................................|ale-python-options|
autopep8............................|ale-python-autopep8|
+ bandit..............................|ale-python-bandit|
black...............................|ale-python-black|
flake8..............................|ale-python-flake8|
isort...............................|ale-python-isort|
@@ -484,7 +485,7 @@ Notes:
* proto: `protoc-gen-lint`
* Pug: `pug-lint`
* Puppet: `languageserver`, `puppet`, `puppet-lint`
-* Python: `autopep8`, `black`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pydocstyle`, `pyls`, `pyre`, `pylint`!!, `vulture`!!, `yapf`
+* Python: `autopep8`, `bandit`, `black`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pydocstyle`, `pyls`, `pyre`, `pylint`!!, `vulture`!!, `yapf`
* QML: `qmlfmt`, `qmllint`
* R: `lintr`
* Racket: `raco`