summaryrefslogtreecommitdiff
path: root/doc/ale-python.txt
diff options
context:
space:
mode:
authorJon Parise <jon@indelible.org>2022-02-07 22:54:25 -0800
committerGitHub <noreply@github.com>2022-02-08 15:54:25 +0900
commit8b1ea33cc0cb18bec3bf19d1131b322b313cea4e (patch)
tree754da607ffda3bf955187e6194e4b182fa3ebfde /doc/ale-python.txt
parent2428d4d81d964a3be83bea649c882012acd4b210 (diff)
downloadale-8b1ea33cc0cb18bec3bf19d1131b322b313cea4e.zip
Add a unimport linter for Python files (#4058)
Unimport (https://github.com/hakancelik96/unimport/) is a linter, formatter for finding and removing unused import statements. This introduces linting support, although fixer support could come later.
Diffstat (limited to 'doc/ale-python.txt')
-rw-r--r--doc/ale-python.txt52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 7486d0b4..2f9f5d29 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -1067,6 +1067,58 @@ g:ale_python_reorder_python_imports_use_global
===============================================================================
+unimport *ale-python-unimport*
+
+`unimport` will be run from a detected project root, per |ale-python-root|.
+
+
+g:ale_python_unimport_auto_pipenv *g:ale_python_unimport_auto_pipenv*
+ *b:ale_python_unimport_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.
+
+
+g:ale_python_unimport_auto_poetry *g:ale_python_unimport_auto_poetry*
+ *b:ale_python_unimport_auto_poetry*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a poetry, and set the executable to `poetry`
+ if true. This is overridden by a manually-set executable.
+
+
+g:ale_python_unimport_executable *g:ale_python_mypy_executable*
+ *b:ale_python_unimport_executable*
+ Type: |String|
+ Default: `'unimport'`
+
+ See |ale-integrations-local-executables|
+
+ Set this to `'pipenv'` to invoke `'pipenv` `run` `unimport'`.
+ Set this to `'poetry'` to invoke `'poetry` `run` `unimport'`.
+
+
+g:ale_python_unimport_options *g:ale_python_mypy_options*
+ *b:ale_python_unimport_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to add command-line arguments to the unimport
+ invocation.
+
+
+g:ale_python_unimport_use_global *g:ale_python_mypy_use_global*
+ *b:ale_python_unimport_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+===============================================================================
vulture *ale-python-vulture*
g:ale_python_vulture_change_directory *g:ale_python_vulture_change_directory*