summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHolden <holden@axoni.com>2018-12-07 18:05:20 -0500
committerHolden <holden@axoni.com>2018-12-07 18:05:20 -0500
commit57a04701c3ac1d06efbf16f2ce184c37f0076d16 (patch)
tree8181c0025e95cd941e6abe20b45f579e1f783c08 /doc
parentcbc029b2b832e6d70d95e6cf810ab6252b42e643 (diff)
parent9226e13b31474ac17d0c25cd27aa55bff21d55c2 (diff)
downloadale-57a04701c3ac1d06efbf16f2ce184c37f0076d16.zip
Merge branch 'master' of github.com:stegmanh/ale
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-bib.txt19
-rw-r--r--doc/ale-java.txt12
-rw-r--r--doc/ale-python.txt40
-rw-r--r--doc/ale-sass.txt6
-rw-r--r--doc/ale-scss.txt27
-rw-r--r--doc/ale.txt8
6 files changed, 108 insertions, 4 deletions
diff --git a/doc/ale-bib.txt b/doc/ale-bib.txt
new file mode 100644
index 00000000..35998c30
--- /dev/null
+++ b/doc/ale-bib.txt
@@ -0,0 +1,19 @@
+===============================================================================
+ALE BibTeX Integration *ale-bib-options*
+
+
+===============================================================================
+bibclean *ale-bib-bibclean*
+
+g:ale_bib_bibclean_executable *g:ale_bib_bibclean_executable*
+
+ Type: |String|
+ Default: `'bibclean'`
+
+g:ale_bib_bibclean_options *g:ale_bib_bibclean_options*
+
+ Type: |String|
+ Default: `'-align-equals'`
+
+===============================================================================
+vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-java.txt b/doc/ale-java.txt
index 7bba12a3..8e40aea0 100644
--- a/doc/ale-java.txt
+++ b/doc/ale-java.txt
@@ -88,14 +88,20 @@ This generates a out/fat-jar.jar file that contains the language server. To
let ALE use this language server you need to set the g:ale_java_javalsp_jar
variable to the absolute path of this jar file.
+g:ale_java_javalsp_executable *g:ale_java_javalsp_executable*
+ *b:ale_java_javalsp_executable*
+ Type: |String|
+ Default: `'java'`
+
+This variable can be changed to use a different executable for java.
+
g:ale_java_javalsp_jar *g:ale_java_javalsp_jar*
*b:ale_java_javalsp_jar*
- Type: String
- Default: 'fat-jar.jar
+ Type: |String|
+ Default: `'fat-jar.jar'`
Path to the location of the vscode-javac language server plugin.
- and -d. They are added automatically.
===============================================================================
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 0b8e1746..f3f2801a 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -329,6 +329,46 @@ g:ale_python_pycodestyle_auto_pipenv *g:ale_python_pycodestyle_auto_pipenv*
===============================================================================
+pydocstyle *ale-python-pydocstyle*
+
+
+g:ale_python_pydocstyle_executable *g:ale_python_pydocstyle_executable*
+ *b:ale_python_pydocstyle_executable*
+ Type: |String|
+ Default: `'pydocstyle'`
+
+ See |ale-integrations-local-executables|
+
+ Set this to `'pipenv'` to invoke `'pipenv` `run` `pydocstyle'`.
+
+
+g:ale_python_pydocstyle_options *g:ale_python_pydocstyle_options*
+ *b:ale_python_pydocstyle_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to add command-line arguments to the
+ pydocstyle invocation.
+
+
+g:ale_python_pydocstyle_use_global *g:ale_python_pydocstyle_use_global*
+ *b:ale_python_pydocstyle_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_python_pydocstyle_auto_pipenv *g:ale_python_pydocstyle_auto_pipenv*
+ *b:ale_python_pydocstyle_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.
+
+
+===============================================================================
pyflakes *ale-python-pyflakes*
diff --git a/doc/ale-sass.txt b/doc/ale-sass.txt
index 08e9a381..735f44b2 100644
--- a/doc/ale-sass.txt
+++ b/doc/ale-sass.txt
@@ -3,6 +3,12 @@ ALE SASS Integration *ale-sass-options*
===============================================================================
+sasslint *ale-sass-sasslint*
+
+See |ale-scss-sasslint| for information about the available options.
+
+
+===============================================================================
stylelint *ale-sass-stylelint*
g:ale_sass_stylelint_executable *g:ale_sass_stylelint_executable*
diff --git a/doc/ale-scss.txt b/doc/ale-scss.txt
index 3ad84fc1..07a94fe1 100644
--- a/doc/ale-scss.txt
+++ b/doc/ale-scss.txt
@@ -9,6 +9,33 @@ See |ale-javascript-prettier| for information about the available options.
===============================================================================
+sasslint *ale-scss-sasslint*
+
+g:ale_scss_sasslint_executable *g:ale_scss_sasslint_executable*
+ *b:ale_scss_sasslint_executable*
+ Type: |String|
+ Default: `'sass-lint'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_scss_sasslint_options *g:ale_scss_sasslint_options*
+ *b:ale_scss_sasslint_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to sass-lint.
+
+
+g:ale_scss_sasslint_use_global *g:ale_scss_sasslint_use_global*
+ *b:ale_scss_sasslint_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+===============================================================================
stylelint *ale-scss-stylelint*
g:ale_scss_stylelint_executable *g:ale_scss_stylelint_executable*
diff --git a/doc/ale.txt b/doc/ale.txt
index 7fbaa0df..1535d89e 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -31,6 +31,8 @@ CONTENTS *ale-contents*
gcc.................................|ale-asm-gcc|
awk...................................|ale-awk-options|
gawk................................|ale-awk-gawk|
+ bib...................................|ale-bib-options|
+ bibclean............................|ale-bib-bibclean|
c.....................................|ale-c-options|
clang...............................|ale-c-clang|
clangd..............................|ale-c-clangd|
@@ -258,6 +260,7 @@ CONTENTS *ale-contents*
mypy................................|ale-python-mypy|
prospector..........................|ale-python-prospector|
pycodestyle.........................|ale-python-pycodestyle|
+ pydocstyle..........................|ale-python-pydocstyle|
pyflakes............................|ale-python-pyflakes|
pylint..............................|ale-python-pylint|
pyls................................|ale-python-pyls|
@@ -288,6 +291,7 @@ CONTENTS *ale-contents*
rustc...............................|ale-rust-rustc|
rustfmt.............................|ale-rust-rustfmt|
sass..................................|ale-sass-options|
+ sasslint............................|ale-sass-sasslint|
stylelint...........................|ale-sass-stylelint|
scala.................................|ale-scala-options|
sbtserver...........................|ale-scala-sbtserver|
@@ -295,6 +299,7 @@ CONTENTS *ale-contents*
scalastyle..........................|ale-scala-scalastyle|
scss..................................|ale-scss-options|
prettier............................|ale-scss-prettier|
+ sasslint............................|ale-scss-sasslint|
stylelint...........................|ale-scss-stylelint|
sh....................................|ale-sh-options|
sh-language-server..................|ale-sh-language-server|
@@ -403,6 +408,7 @@ Notes:
* AsciiDoc: `alex`!!, `proselint`, `redpen`, `write-good`, `vale`
* Awk: `gawk`
* Bash: `language-server`, `shell` (-n flag), `shellcheck`, `shfmt`
+* BibTeX: `bibclean`
* Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt`
* C: `cppcheck`, `cpplint`!!, `clang`, `clangd`, `clangtidy`!!, `clang-format`, `cquery`, `flawfinder`, `gcc`, `uncrustify`, `ccls`
* C++ (filetype cpp): `clang`, `clangd`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `clazy`!!, `cppcheck`, `cpplint`!!, `cquery`, `flawfinder`, `gcc`, `uncrustify`, `ccls`
@@ -473,7 +479,7 @@ Notes:
* proto: `protoc-gen-lint`
* Pug: `pug-lint`
* Puppet: `languageserver`, `puppet`, `puppet-lint`
-* Python: `autopep8`, `black`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pyre`, `pylint`!!, `vulture`!!, `yapf`
+* Python: `autopep8`, `black`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pydocstyle`, `pyls`, `pyre`, `pylint`!!, `vulture`!!, `yapf`
* QML: `qmlfmt`, `qmllint`
* R: `lintr`
* ReasonML: `merlin`, `ols`, `refmt`