diff options
author | Kevin Locke <kevin@kevinlocke.name> | 2019-02-08 21:44:34 +0000 |
---|---|---|
committer | w0rp <w0rp@users.noreply.github.com> | 2019-02-08 21:44:34 +0000 |
commit | a24f0b4d5f91f9214c64ae281fadcd981e0dadfc (patch) | |
tree | 25e07c98b5de66ab70db85b980fcbe9f3675358d /doc | |
parent | 422908a5721e11be73935b765f599f9fc672802e (diff) | |
download | ale-a24f0b4d5f91f9214c64ae281fadcd981e0dadfc.zip |
Support pylama for python (#2266)
* Add pylama for python
* Consolidate python traceback handling
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ale-python.txt | 55 | ||||
-rw-r--r-- | doc/ale.txt | 1 |
2 files changed, 56 insertions, 0 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt index 00faef03..8641def5 100644 --- a/doc/ale-python.txt +++ b/doc/ale-python.txt @@ -31,6 +31,7 @@ ALE will look for configuration files with the following filenames. > pycodestyle.cfg flake8.cfg .flake8rc + pylama.ini Pipfile Pipfile.lock < @@ -450,6 +451,60 @@ g:ale_python_pyflakes_auto_pipenv *g:ale_python_pyflakes_auto_pipenv* =============================================================================== +pylama *ale-python-pylama* + +g:ale_python_pylama_change_directory *g:ale_python_pylama_change_directory* + *b:ale_python_pylama_change_directory* + Type: |Number| + Default: `1` + + If set to `1`, `pylama` will be run from a detected project root, per + |ale-python-root|. This is useful because `pylama` only searches for + configuration files in its current directory and applies file masks using + paths relative to its current directory. This option can be turned off if + you want to control the directory in which `pylama` is executed. + + +g:ale_python_pylama_executable *g:ale_python_pylama_executable* + *b:ale_python_pylama_executable* + Type: |String| + Default: `'pylama'` + + This variable can be changed to modify the executable used for pylama. Set + this to `'pipenv'` to invoke `'pipenv` `run` `pylama'`. + + +g:ale_python_pylama_options *g:ale_python_pylama_options* + *b:ale_python_pylama_options* + Type: |String| + Default: `''` + + This variable can be changed to add command-line arguments to the pylama + invocation. + + +g:ale_python_pylama_use_global *g:ale_python_pylama_use_global* + *b:ale_python_pylama_use_global* + Type: |Number| + Default: `get(g:, 'ale_use_global_executables', 0)` + + This variable controls whether or not ALE will search for pylama in a + virtualenv directory first. If this variable is set to `1`, then ALE will + always use |g:ale_python_pylama_executable| for the executable path. + + Both variables can be set with `b:` buffer variables instead. + + +g:ale_python_pylama_auto_pipenv *g:ale_python_pylama_auto_pipenv* + *b:ale_python_pylama_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. + + +=============================================================================== pylint *ale-python-pylint* g:ale_python_pylint_change_directory *g:ale_python_pylint_change_directory* diff --git a/doc/ale.txt b/doc/ale.txt index 6e80117e..f36013ce 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -269,6 +269,7 @@ CONTENTS *ale-contents* pycodestyle.........................|ale-python-pycodestyle| pydocstyle..........................|ale-python-pydocstyle| pyflakes............................|ale-python-pyflakes| + pylama..............................|ale-python-pylama| pylint..............................|ale-python-pylint| pyls................................|ale-python-pyls| pyre................................|ale-python-pyre| |