ld/amix-vimrc-mirror
1
0
Fork 0
mirror of https://github.com/amix/vimrc synced 2025-06-16 01:25:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated plugins

Browse Source
This commit is contained in:
Amir Salihefendic
2018-06-14 12:31:12 +02:00
parent 7288aee801
commit 3e3297af67
273 changed files with 11821 additions and 5377 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
sources_non_forked/ale/doc/ale-cpp.txt
View File

@ -156,6 +156,26 @@ g:ale_cpp_cpplint_options *g:ale_cpp_cpplint_options*
This variable can be changed to modify flags given to cpplint.
===============================================================================
cquery *ale-cpp-cquery*
g:ale_cpp_cquery_executable *g:ale_cpp_cquery_executable*
*b:ale_cpp_cquery_executable*
Type: |String|
Default: `'cquery'`
This variable can be changed to use a different executable for cquery.
g:ale_cpp_cquery_cache_directory *g:ale_cpp_cquery_cache_directory*
*b:ale_cpp_cquery_cache_directory*
Type: |String|
Default: `'~/.cache/cquery'`
This variable can be changed to decide which directory cquery uses for its
cache.
===============================================================================
flawfinder *ale-cpp-flawfinder*

2
sources_non_forked/ale/doc/ale-css.txt
View File

@ -30,7 +30,7 @@ g:ale_css_stylelint_options *g:ale_css_stylelint_options*
g:ale_css_stylelint_use_global *g:ale_css_stylelint_use_global*
*b:ale_css_stylelint_use_global*
Type: |String|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

6
sources_non_forked/ale/doc/ale-elm.txt
View File

@ -16,7 +16,7 @@ g:ale_elm_format_executable *g:ale_elm_format_executable*
g:ale_elm_format_use_global *g:ale_elm_format_use_global*
*b:ale_elm_format_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -34,7 +34,7 @@ elm-make *ale-elm-elm-make*
g:ale_elm_make_executable *g:ale_elm_make_executable*
*b:ale_elm_make_executable*
Type: |String|
Default: `'elm-make'`
Default: `'elm'`
See |ale-integrations-local-executables|
@ -42,7 +42,7 @@ g:ale_elm_make_executable *g:ale_elm_make_executable*
g:ale_elm_make_use_global *g:ale_elm_make_use_global*
*b:ale_elm_make_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

12
sources_non_forked/ale/doc/ale-gitcommit.txt
View File

@ -19,18 +19,20 @@ g:ale_gitcommit_gitlint_options *g:ale_gitcommit_gitlint_options*
Default: `''`
This variable can be changed to add command-line arguments to the gitlint
invocation.
invocation. For example, you can specify the path to a configuration file. >
For example, to dinamically set the gitlint configuration file path, you
may want to set >
let g:ale_gitcommit_gitlint_options = '-C /home/user/.config/gitlint.ini'
<
You can also disable particular error codes using this option. For example,
you can ignore errors for git commits with a missing body. >
let g:ale_gitcommit_gitlint_options = '-C /home/user/.config/gitlint.ini'
let g:ale_gitcommit_gitlint_options = '--ignore B6'
<
g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global*
*b:ale_gitcommit_gitlint_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable controls whether or not ALE will search for gitlint in a
virtualenv directory first. If this variable is set to `1`, then ALE will

8
sources_non_forked/ale/doc/ale-go.txt
View File

@ -73,8 +73,8 @@ g:ale_go_gometalinter_options *g:ale_go_gometalinter_options*
number of linters known to be slow or consume a lot of resources.
g:ale_go_gometalinter_package *g:ale_go_gometalinter_package*
*b:ale_go_gometalinter_package*
g:ale_go_gometalinter_lint_package *g:ale_go_gometalinter_lint_package*
*b:ale_go_gometalinter_lint_package*
Type: |Number|
Default: `0`
@ -94,8 +94,8 @@ g:ale_go_staticcheck_options *g:ale_go_staticcheck_options*
linter.
g:ale_go_staticcheck_package *g:ale_go_staticcheck_package*
*b:ale_go_staticcheck_package*
g:ale_go_staticcheck_lint_package *g:ale_go_staticcheck_lint_package*
*b:ale_go_staticcheck_lint_package*
Type: |Number|
Default: `0`

2
sources_non_forked/ale/doc/ale-handlebars.txt
View File

@ -16,7 +16,7 @@ g:ale_handlebars_embertemplatelint_executable
g:ale_handlebars_embertemplatelint_use_global
*g:ale_handlebars_embertemplatelint_use_global*
Type: |Number| *b:ale_handlebars_embertemplatelint_use_global*
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

8
sources_non_forked/ale/doc/ale-haskell.txt
View File

@ -36,10 +36,16 @@ g:ale_haskell_hdevtools_executable *g:ale_haskell_hdevtools_executable*
g:ale_haskell_hdevtools_options *g:ale_haskell_hdevtools_options*
*b:ale_haskell_hdevtools_options*
Type: |String|
Default: `'-g -Wall'`
Default: `get(g:, 'hdevtools_options', '-g -Wall')`
This variable can be changed to modify flags given to hdevtools.
The hdevtools documentation recommends setting GHC options for `hdevtools`
with `g:hdevtools_options`. ALE will use the value of `g:hdevtools_options`
for the value of `g:ale_haskell_hdevtools_options` by default, so this
option can be respected and overridden specifically for ALE.
===============================================================================
hfmt *ale-haskell-hfmt*

2
sources_non_forked/ale/doc/ale-html.txt
View File

@ -24,7 +24,7 @@ g:ale_html_htmlhint_options *g:ale_html_htmlhint_options*
g:ale_html_htmlhint_use_global *g:ale_html_htmlhint_use_global*
*b:ale_html_htmlhint_use_global*
Type: |String|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

22
sources_non_forked/ale/doc/ale-java.txt
View File

@ -25,6 +25,14 @@ g:ale_java_javac_classpath *g:ale_java_javac_classpath*
This variable can be set to change the global classpath for Java.
g:ale_java_javac_executable *g:ale_java_javac_executable*
*b:ale_java_javac_executable*
Type: |String|
Default: `'javac'`
This variable can be set to change the executable path used for javac.
g:ale_java_javac_options *g:ale_java_javac_options*
*b:ale_java_javac_options*
Type: |String|
@ -53,5 +61,19 @@ g:ale_java_google_java_format_options *g:ale_java_google_java_format_options*
This variable can be set to pass additional options
===============================================================================
pmd *ale-java-pmd*
g:ale_java_pmd_options *g:ale_java_pmd_options*
*b:ale_java_pmd_options*
Type: String
Default: '-R category/java/bestpractices'
This variable can be changed to modify flags given to PMD. Do not specify -f
and -d. They are added automatically.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

29
sources_non_forked/ale/doc/ale-javascript.txt
View File

@ -45,7 +45,7 @@ g:ale_javascript_eslint_options *g:ale_javascript_eslint_options*
g:ale_javascript_eslint_use_global *g:ale_javascript_eslint_use_global*
*b:ale_javascript_eslint_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -98,11 +98,22 @@ g:ale_javascript_flow_use_home_config *g:ale_javascript_flow_use_home_config*
g:ale_javascript_flow_use_global *g:ale_javascript_flow_use_global*
*b:ale_javascript_flow_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_javascript_flow_use_respect_pragma
*g:ale_javascript_flow_use_respect_pragma*
*b:ale_javascript_flow_use_respect_pragma*
Type: |Number|
Default: `1`
By default, ALE will use the `--respect-pragma` option for `flow`, so only
files with the `@flow` pragma are checked by ALE. This option can be set to
`0` to disable that behaviour, so all files can be checked by `flow`.
===============================================================================
importjs *ale-javascript-importjs*
@ -126,7 +137,7 @@ g:ale_javascript_jscs_executable *g:ale_javascript_jscs_executable*
g:ale_javascript_jscs_use_global *g:ale_javascript_jscs_use_global*
*b:ale_javascript_jscs_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -145,7 +156,7 @@ g:ale_javascript_jshint_executable *g:ale_javascript_jshint_executable*
g:ale_javascript_jshint_use_global *g:ale_javascript_jshint_use_global*
*b:ale_javascript_jshint_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -172,7 +183,7 @@ g:ale_javascript_prettier_options *g:ale_javascript_prettier_options*
g:ale_javascript_prettier_use_global *g:ale_javascript_prettier_use_global*
*b:ale_javascript_prettier_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -202,7 +213,7 @@ g:ale_javascript_prettier_eslint_use_global
*g:ale_javascript_prettier_eslint_use_global*
*b:ale_javascript_prettier_eslint_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -233,7 +244,7 @@ g:ale_javascript_prettier_standard_use_global
*g:ale_javascript_prettier_standard_use_global*
*b:ale_javascript_prettier_standard_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -262,7 +273,7 @@ g:ale_javascript_standard_options *g:ale_javascript_standard_options*
g:ale_javascript_standard_use_global *g:ale_javascript_standard_use_global*
*b:ale_javascript_standard_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -289,7 +300,7 @@ g:ale_javascript_xo_options *g:ale_javascript_xo_options*
g:ale_javascript_xo_use_global *g:ale_javascript_xo_use_global*
*b:ale_javascript_xo_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

2
sources_non_forked/ale/doc/ale-json.txt
View File

@ -44,7 +44,7 @@ g:ale_json_fixjson_use_global *g:ale_json_fixjson_use_global*
*b:ale_json_fixjson_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

4
sources_non_forked/ale/doc/ale-less.txt
View File

@ -24,7 +24,7 @@ g:ale_less_lessc_options *g:ale_less_lessc_options*
g:ale_less_lessc_use_global *g:ale_less_lessc_use_global*
*b:ale_less_lessc_use_global*
Type: |String|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -57,7 +57,7 @@ g:ale_less_stylelint_options *g:ale_less_stylelint_options*
g:ale_less_stylelint_use_global *g:ale_less_stylelint_use_global*
*b:ale_less_stylelint_use_global*
Type: |String|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

3
sources_non_forked/ale/doc/ale-markdown.txt
View File

@ -10,7 +10,8 @@ g:ale_markdown_mdl_executable *g:ale_markdown_mdl_executable*
Type: |String|
Default: `'mdl'`
See |ale-integrations-local-executables|
Override the invoked mdl binary. This is useful for running mdl from
binstubs or a bundle.
g:ale_markdown_mdl_options *g:ale_markdown_mdl_options*

26
sources_non_forked/ale/doc/ale-mercury.txt Normal file
View File

@ -0,0 +1,26 @@
===============================================================================
ALE Mercury Integration *ale-mercury-options*
===============================================================================
mmc *ale-mercury-mmc*
g:ale_mercury_mmc_executable *g:ale_mercury_mmc_executable*
*b:ale_mercury_mmc_executable*
Type: |String|
Default: `'mmc'`
This variable can be changed to use a different executable for mmc.
g:ale_mercury_mmc_options *g:ale_mercury_mmc_options*
*b:ale_mercury_mmc_options*
Type: |String|
Default: `'--make --output-compile-error-lines 100'`
This variable can be set to pass additional options to mmc.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

26
sources_non_forked/ale/doc/ale-nasm.txt Normal file
View File

@ -0,0 +1,26 @@
===============================================================================
ALE NASM Integration *ale-nasm-options*
===============================================================================
nasm *ale-nasm-nasm*
g:ale_nasm_nasm_executable *g:ale_nasm_nasm_executable*
*b:ale_nasm_nasm_executable*
Type: |String|
Default `'nasm'`
This variable can be changed to use different executable for NASM.
g:ale_nasm_nasm_options *g:ale_nasm_nasm_options*
*b:ale_nasm_nasm_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to NASM.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

2
sources_non_forked/ale/doc/ale-ocaml.txt
View File

@ -28,7 +28,7 @@ g:ale_ocaml_ols_executable *g:ale_ocaml_ols_executable*
g:ale_ocaml_ols_use_global *g:ale_ocaml_ols_use_global*
*b:ale_ocaml_ols_use_global*
Type: |String|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable can be set to `1` to always use the globally installed
executable. See also |ale-integrations-local-executables|.

9
sources_non_forked/ale/doc/ale-perl.txt
View File

@ -76,7 +76,16 @@ g:ale_perl_perlcritic_showrules *g:ale_perl_perlcritic_showrules*
Controls whether perlcritic rule names are shown after the error message.
Defaults to off to reduce length of message.
===============================================================================
perltidy *ale-perl-perltidy*
g:ale_perl_perltidy_options *g:ale_perl_perltidy_options*
*b:ale_perl_perltidy_options*
Type: |String|
Default: `''`
This variable can be changed to alter the command-line arguments to
the perltidy invocation.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

33
sources_non_forked/ale/doc/ale-php.txt
View File

@ -37,7 +37,7 @@ g:ale_php_langserver_executable *g:ale_php_langserver_executable*
g:ale_php_langserver_use_global *g:ale_php_langserver_use_global*
*b:ale_php_langserver_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable can be set to `1` to force the language server to be run with
the executable set for |g:ale_php_langserver_executable|.
@ -48,7 +48,7 @@ g:ale_php_langserver_use_global *g:ale_php_langserver_use_global*
===============================================================================
phan *ale-php-phan*
WARNING: please do not use this linter if you have an configuration file
WARNING: please use the phan_client linter if you have an configuration file
for your project because the phan will look into your entirely project and
ale will display in the current buffer warnings that may belong to other file.
@ -57,8 +57,22 @@ g:ale_php_phan_minimum_severity *g:ale_php_phan_minimum_severity*
Type: |Number|
Default: `0`
This variable defines the minimum severity level
This variable defines the minimum severity level.
g:ale_php_phan_executable *g:ale_php_phan_executable*
*b:ale_php_phan_executable*
Type: |String|
Default: `'phan'`
This variable sets executable used for phan or phan_client.
g:ale_php_phan_use_client *g:ale_php_phan_use_client*
*b:ale_php_phan_use_client*
Type: |Number|
Default: `get(g:, 'ale_php_phan_use_client', 0)`
This variable can be set to 1 to use the phan_client with phan daemon mode
instead of the phan standalone.
===============================================================================
phpcbf *ale-php-phpcbf*
@ -84,7 +98,7 @@ g:ale_php_phpcbf_standard *g:ale_php_phpcbf_standard*
g:ale_php_phpcbf_use_global *g:ale_php_phpcbf_use_global*
*b:ale_php_phpcbf_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -113,7 +127,7 @@ g:ale_php_phpcs_standard *g:ale_php_phpcs_standard*
g:ale_php_phpcs_use_global *g:ale_php_phpcs_use_global*
*b:ale_php_phpcs_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -179,9 +193,16 @@ g:ale_php_cs_fixer_executable *g:ale_php_cs_fixer_executable*
g:ale_php_cs_fixer_use_global *g:ale_php_cs_fixer_use_global*
*b:ale_php_cs_fixer_use_global*
Type: |Boolean|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable force globally installed fixer.
g:ale_php_cs_fixer_options *g:ale_php_cs_fixer_options*
*b:ale_php_cs_fixer_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to php-cs-fixer.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

2
sources_non_forked/ale/doc/ale-pug.txt
View File

@ -35,7 +35,7 @@ g:ale_pug_puglint_options *g:ale_pug_puglint_options*
g:ale_pug_puglint_use_global *g:ale_pug_puglint_use_global*
*b:ale_pug_puglint_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

124
sources_non_forked/ale/doc/ale-python.txt
View File

@ -2,6 +2,31 @@
ALE Python Integration *ale-python-options*
===============================================================================
ALE Python Project Root Behavior *ale-python-root*
For some linters, ALE will search for a Python project root by looking at the
files in directories on or above where a file being checked is. ALE applies
the following methods, in order:
1. Find the first directory containing a common Python configuration file.
2. If no configuration file can be found, use the first directory which does
not contain a readable file named `__init__.py`.
ALE will look for configuration files with the following filenames. >
MANIFEST.in
setup.cfg
pytest.ini
tox.ini
mypy.ini
pycodestyle.cfg
flake8.cfg
<
The first directory containing any of the files named above will be used.
===============================================================================
autopep8 *ale-python-autopep8*
@ -24,7 +49,34 @@ g:ale_python_autopep8_options *g:ale_python_autopep8_options*
g:ale_python_autopep8_use_global *g:ale_python_autopep8_use_global*
*b:ale_python_autopep8_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
black *ale-python-black*
g:ale_python_black_executable *g:ale_python_black_executable*
*b:ale_python_black_executable*
Type: |String|
Default: `'black'`
See |ale-integrations-local-executables|
autopep8
g:ale_python_black_options *g:ale_python_black_options*
*b:ale_python_black_options*
Type: |String|
Default: `''`
This variable can be set to pass extra options to black.
g:ale_python_black_use_global *g:ale_python_black_use_global*
*b:ale_python_black_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -32,12 +84,24 @@ g:ale_python_autopep8_use_global *g:ale_python_autopep8_use_global*
===============================================================================
flake8 *ale-python-flake8*
g:ale_python_flake8_change_directory *g:ale_python_flake8_change_directory*
*b:ale_python_flake8_change_directory*
Type: |Number|
Default: `1`
If set to `1`, ALE will switch to the directory the Python file being
checked with `flake8` is in before checking it. This helps `flake8` find
configuration files more easily. This option can be turned off if you want
to control the directory Python is executed from yourself.
g:ale_python_flake8_executable *g:ale_python_flake8_executable*
*b:ale_python_flake8_executable*
Type: |String|
Default: `'flake8'`
This variable can be changed to modify the executable used for flake8.
This variable can be changed to modify the executable used for flake8. Set
this to `'pipenv'` to invoke `'pipenv` `run` `flake8'`.
g:ale_python_flake8_options *g:ale_python_flake8_options*
@ -61,7 +125,7 @@ g:ale_python_flake8_options *g:ale_python_flake8_options*
g:ale_python_flake8_use_global *g:ale_python_flake8_use_global*
*b:ale_python_flake8_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable controls whether or not ALE will search for flake8 in a
virtualenv directory first. If this variable is set to `1`, then ALE will
@ -84,7 +148,7 @@ g:ale_python_isort_executable *g:ale_python_isort_executable*
g:ale_python_isort_use_global *g:ale_python_isort_use_global*
*b:ale_python_isort_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -96,6 +160,8 @@ The minimum supported version of mypy that ALE supports is v0.4.4. This is
the first version containing the `--shadow-file` option ALE needs to be able
to check for errors while you type.
`mypy` will be run from a detected project root, per |ale-python-root|.
g:ale_python_mypy_executable *g:ale_python_mypy_executable*
*b:ale_python_mypy_executable*
@ -104,6 +170,8 @@ g:ale_python_mypy_executable *g:ale_python_mypy_executable*
See |ale-integrations-local-executables|
Set this to `'pipenv'` to invoke `'pipenv` `run` `mypy'`.
g:ale_python_mypy_ignore_invalid_syntax
*g:ale_python_mypy_ignore_invalid_syntax*
*b:ale_python_mypy_ignore_invalid_syntax*
@ -127,7 +195,7 @@ g:ale_python_mypy_options *g:ale_python_mypy_options*
g:ale_python_mypy_use_global *g:ale_python_mypy_use_global*
*b:ale_python_mypy_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -142,6 +210,8 @@ g:ale_python_prospector_executable *g:ale_python_prospector_executable*
See |ale-integrations-local-executables|
Set this to `'pipenv'` to invoke `'pipenv` `run` `prospector'`.
g:ale_python_prospector_options *g:ale_python_prospector_options*
*b:ale_python_prospector_options*
@ -167,7 +237,7 @@ g:ale_python_prospector_options *g:ale_python_prospector_options*
g:ale_python_prospector_use_global *g:ale_python_prospector_use_global*
*b:ale_python_prospector_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -183,6 +253,8 @@ g:ale_python_pycodestyle_executable *g:ale_python_pycodestyle_executable*
See |ale-integrations-local-executables|
Set this to `'pipenv'` to invoke `'pipenv` `run` `pycodestyle'`.
g:ale_python_pycodestyle_options *g:ale_python_pycodestyle_options*
*b:ale_python_pycodestyle_options*
@ -196,14 +268,39 @@ g:ale_python_pycodestyle_options *g:ale_python_pycodestyle_options*
g:ale_python_pycodestyle_use_global *g:ale_python_pycodestyle_use_global*
*b:ale_python_pycodestyle_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
pyflakes *ale-python-pyflakes*
g:ale_python_pyflakes_executable *g:ale_python_pyflakes_executable*
*b:ale_python_pyflakes_executable*
Type: |String|
Default: `'pyflakes'`
See |ale-integrations-local-executables|
Set this to `'pipenv'` to invoke `'pipenv` `run` `pyflakes'`.
===============================================================================
pylint *ale-python-pylint*
g:ale_python_pylint_change_directory *g:ale_python_pylint_change_directory*
*b:ale_python_pylint_change_directory*
Type: |Number|
Default: `1`
If set to `1`, ALE will switch to the directory the Python file being
checked with `pylint` is in before checking it. This helps `pylint` find
configuration files more easily. This option can be turned off if you want
to control the directory Python is executed from yourself.
g:ale_python_pylint_executable *g:ale_python_pylint_executable*
*b:ale_python_pylint_executable*
Type: |String|
@ -211,6 +308,8 @@ g:ale_python_pylint_executable *g:ale_python_pylint_executable*
See |ale-integrations-local-executables|
Set this to `'pipenv'` to invoke `'pipenv` `run` `pylint'`.
g:ale_python_pylint_options *g:ale_python_pylint_options*
*b:ale_python_pylint_options*
@ -235,7 +334,7 @@ g:ale_python_pylint_options *g:ale_python_pylint_options*
g:ale_python_pylint_use_global *g:ale_python_pylint_use_global*
*b:ale_python_pylint_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -243,6 +342,9 @@ g:ale_python_pylint_use_global *g:ale_python_pylint_use_global*
===============================================================================
pyls *ale-python-pyls*
`pyls` will be run from a detected project root, per |ale-python-root|.
g:ale_python_pyls_executable *g:ale_python_pyls_executable*
*b:ale_python_pyls_executable*
Type: |String|
@ -250,11 +352,13 @@ g:ale_python_pyls_executable *g:ale_python_pyls_executable*
See |ale-integrations-local-executables|
Set this to `'pipenv'` to invoke `'pipenv` `run` `pyls'`.
g:ale_python_pyls_use_global *g:ale_python_pyls_use_global*
*b:ale_python_pyls_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -273,7 +377,7 @@ g:ale_python_yapf_executable *g:ale_python_yapf_executable*
g:ale_python_yapf_use_global *g:ale_python_yapf_use_global*
*b:ale_python_yapf_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

18
sources_non_forked/ale/doc/ale-qml.txt Normal file
View File

@ -0,0 +1,18 @@
===============================================================================
ALE QML Integration *ale-qml-options*
===============================================================================
qmlfmt *ale-qml-qmlfmt*
g:ale_qml_qmlfmt_executable *g:ale_qml_qmlfmt_executable*
*b:ale_qml_qmlfmt_executable*
Type: |String|
Default: `'qmlfmt'`
This variable can be set to change the path to qmlfmt.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

2
sources_non_forked/ale/doc/ale-reasonml.txt
View File

@ -28,7 +28,7 @@ g:ale_reason_ols_executable *g:ale_reason_ols_executable*
g:ale_reason_ols_use_global *g:ale_reason_ols_use_global*
*b:ale_reason_ols_use_global*
Type: |String|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable can be set to `1` to always use the globally installed
executable. See also |ale-integrations-local-executables|.

20
sources_non_forked/ale/doc/ale-rust.txt
View File

@ -59,6 +59,26 @@ g:ale_rust_cargo_check_all_targets *g:ale_rust_cargo_check_all_targets*
is used. See |g:ale_rust_cargo_use_check|,
g:ale_rust_cargo_check_tests *g:ale_rust_cargo_check_tests*
*b:ale_rust_cargo_check_tests*
Type: |Number|
Default: `0`
When set to `1`, ALE will set the `--tests` option when `cargo check`
is used. This allows for linting of tests which are normally excluded.
See |g:ale_rust_cargo_use_check|,
g:ale_rust_cargo_check_examples *g:ale_rust_cargo_check_examples*
*b:ale_rust_cargo_check_examples*
Type: |Number|
Default: `0`
When set to `1`, ALE will set the `--examples` option when `cargo check`
is used. This allows for linting of examples which are normally excluded.
See |g:ale_rust_cargo_use_check|,
g:ale_rust_cargo_default_feature_behavior
*g:ale_rust_cargo_default_feature_behavior*
*b:ale_rust_cargo_default_feature_behavior*

2
sources_non_forked/ale/doc/ale-sass.txt
View File

@ -16,7 +16,7 @@ g:ale_sass_stylelint_executable *g:ale_sass_stylelint_executable*
g:ale_sass_stylelint_use_global *g:ale_sass_stylelint_use_global*
*b:ale_sass_stylelint_use_global*
Type: |String|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

25
sources_non_forked/ale/doc/ale-scala.txt
View File

@ -2,6 +2,31 @@
ALE Scala Integration *ale-scala-options*
===============================================================================
scalafmt *ale-scala-scalafmt*
If Nailgun is used, override `g:ale_scala_scalafmt_executable` like so: >
let g:ale_scala_scalafmt_executable = 'ng'
g:ale_scala_scalafmt_executable *g:ale_scala_scalafmt_executable*
*b:ale_scala_scalafmt_executable*
Type: |String|
Default: `'scalafmt'`
Override the invoked `scalafmt` binary. This is useful for running `scalafmt`
with Nailgun.
g:ale_scala_scalafmt_options *g:ale_scala_scalafmt_options*
*b:ale_scala_scalafmt_options*
Type: |String|
Default: `''`
A string containing additional options to pass to `'scalafmt'`, or
`'ng scalafmt'` if Nailgun is used.
===============================================================================
scalastyle *ale-scala-scalastyle*

2
sources_non_forked/ale/doc/ale-scss.txt
View File

@ -22,7 +22,7 @@ g:ale_scss_stylelint_executable *g:ale_scss_stylelint_executable*
g:ale_scss_stylelint_use_global *g:ale_scss_stylelint_use_global*
*b:ale_scss_stylelint_use_global*
Type: |String|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

2
sources_non_forked/ale/doc/ale-stylus.txt
View File

@ -24,7 +24,7 @@ g:ale_stylus_stylelint_options *g:ale_stylus_stylelint_options*
g:ale_stylus_stylelint_use_global *g:ale_stylus_stylelint_use_global*
*b:ale_stylus_stylelint_use_global*
Type: |String|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

2
sources_non_forked/ale/doc/ale-text.txt
View File

@ -27,7 +27,7 @@ g:ale_textlint_options *g:ale_textlint_options*
g:ale_textlint_use_global *g:ale_textlint_use_global*
*b:ale_textlint_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

4
sources_non_forked/ale/doc/ale-typescript.txt
View File

@ -59,7 +59,7 @@ g:ale_typescript_tslint_rules_dir *g:ale_typescript_tslint_rules_dir*
g:ale_typescript_tslint_use_global *g:ale_typescript_tslint_use_global*
*b:ale_typescript_tslint_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -91,7 +91,7 @@ g:ale_typescript_tsserver_config_path *g:ale_typescript_tsserver_config_path*
g:ale_typescript_tsserver_use_global *g:ale_typescript_tsserver_use_global*
*b:ale_typescript_tsserver_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
This variable controls whether or not ALE will search for a local path for
tsserver first. If this variable is set to `1`, then ALE will always use the

8
sources_non_forked/ale/doc/ale-vim.txt
View File

@ -5,6 +5,14 @@ ALE Vim Integration *ale-vim-options*
===============================================================================
vint *ale-vim-vint*
g:ale_vim_vint_executable *g:ale_vim_vint_executable*
*b:ale_vim_vint_executable*
Type: |String|
Default: `'vint'`
This option can be set to change the executable path for Vint.
g:ale_vim_vint_show_style_issues *g:ale_vim_vint_show_style_issues*
*b:ale_vim_vint_show_style_issues*
Type: |Number|

2
sources_non_forked/ale/doc/ale-yaml.txt
View File

@ -31,7 +31,7 @@ g:ale_yaml_swaglint_executable *g:ale_yaml_swaglint_executable*
g:ale_yaml_swaglint_use_global *g:ale_yaml_swaglint_use_global*
*b:ale_yaml_swaglint_use_global*
Type: |String|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|

281
sources_non_forked/ale/doc/ale.txt
View File

@ -13,6 +13,7 @@ CONTENTS *ale-contents*
5. Language Server Protocol Support.....|ale-lsp|
5.1 Completion........................|ale-completion|
5.2 Go To Definition..................|ale-go-to-definition|
5.3 Find References...................|ale-find-references|
6. Global Options.......................|ale-options|
6.1 Highlights........................|ale-highlights|
6.2 Options for write-good Linter.....|ale-write-good-options|
@ -43,6 +44,7 @@ CONTENTS *ale-contents*
clangtidy...........................|ale-cpp-clangtidy|
cppcheck............................|ale-cpp-cppcheck|
cpplint.............................|ale-cpp-cpplint|
cquery..............................|ale-cpp-cquery|
flawfinder..........................|ale-cpp-flawfinder|
gcc.................................|ale-cpp-gcc|
c#....................................|ale-cs-options|
@ -106,6 +108,7 @@ CONTENTS *ale-contents*
checkstyle..........................|ale-java-checkstyle|
javac...............................|ale-java-javac|
google-java-format..................|ale-java-google-java-format|
pmd.................................|ale-java-pmd|
javascript............................|ale-javascript-options|
eslint..............................|ale-javascript-eslint|
flow................................|ale-javascript-flow|
@ -141,6 +144,10 @@ CONTENTS *ale-contents*
prettier............................|ale-markdown-prettier|
textlint............................|ale-markdown-textlint|
write-good..........................|ale-markdown-write-good|
mercury...............................|ale-mercury-options|
mmc.................................|ale-mercury-mmc|
nasm..................................|ale-nasm-options|
nasm................................|ale-nasm-nasm|
nroff.................................|ale-nroff-options|
write-good..........................|ale-nroff-write-good|
objc..................................|ale-objc-options|
@ -153,6 +160,7 @@ CONTENTS *ale-contents*
perl..................................|ale-perl-options|
perl................................|ale-perl-perl|
perlcritic..........................|ale-perl-perlcritic|
perltidy............................|ale-perl-perltidy|
php...................................|ale-php-options|
hack................................|ale-php-hack|
hackfmt.............................|ale-php-hackfmt|
@ -177,14 +185,18 @@ CONTENTS *ale-contents*
puppetlint..........................|ale-puppet-puppetlint|
python................................|ale-python-options|
autopep8............................|ale-python-autopep8|
black...............................|ale-python-black|
flake8..............................|ale-python-flake8|
isort...............................|ale-python-isort|
mypy................................|ale-python-mypy|
prospector..........................|ale-python-prospector|
pycodestyle.........................|ale-python-pycodestyle|
pyflakes............................|ale-python-pyflakes|
pylint..............................|ale-python-pylint|
pyls................................|ale-python-pyls|
yapf................................|ale-python-yapf|
qml...................................|ale-qml-options|
qmlfmt..............................|ale-qml-qmlfmt|
r.....................................|ale-r-options|
lintr...............................|ale-r-lintr|
reasonml..............................|ale-reasonml-options|
@ -208,6 +220,7 @@ CONTENTS *ale-contents*
sass..................................|ale-sass-options|
stylelint...........................|ale-sass-stylelint|
scala.................................|ale-scala-options|
scalafmt............................|ale-scala-scalafmt|
scalastyle..........................|ale-scala-scalastyle|
scss..................................|ale-scss-options|
prettier............................|ale-scss-prettier|
@ -307,7 +320,7 @@ Notes:
* Bash: `shell` (-n flag), `shellcheck`, `shfmt`
* Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt`
* C: `cppcheck`, `cpplint`!!, `clang`, `clangtidy`!!, `clang-format`, `flawfinder`, `gcc`
* C++ (filetype cpp): `clang`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `cppcheck`, `cpplint`!!, `flawfinder`, `gcc`
* C++ (filetype cpp): `clang`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `cppcheck`, `cpplint`!!, `cquery`, `flawfinder`, `gcc`
* CUDA: `nvcc`!!
* C#: `mcs`, `mcsc`!!
* Chef: `foodcritic`
@ -316,6 +329,7 @@ Notes:
* CoffeeScript: `coffee`, `coffeelint`
* Crystal: `crystal`!!
* CSS: `csslint`, `prettier`, `stylelint`
* Cucumber: `cucumber`
* Cython (pyrex filetype): `cython`
* D: `dmd`
* Dafny: `dafny`!!
@ -338,7 +352,7 @@ Notes:
* Haskell: `brittany`, `ghc`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `stack-ghc-mod`, `hlint`, `hdevtools`, `hfmt`
* HTML: `alex`!!, `HTMLHint`, `proselint`, `tidy`, `write-good`
* Idris: `idris`
* Java: `checkstyle`, `javac`, `google-java-format`
* Java: `checkstyle`, `javac`, `google-java-format`, `PMD`
* JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint`, `prettier-standard`, `standard`, `xo`
* JSON: `fixjson`, `jsonlint`, `jq`, `prettier`
* Kotlin: `kotlinc`, `ktlint`
@ -350,13 +364,15 @@ Notes:
* Make: `checkmake`
* Markdown: `alex`!!, `markdownlint`!!, `mdl`, `prettier`, `proselint`, `redpen`, `remark-lint`, `textlint`, `vale`, `write-good`
* MATLAB: `mlint`
* Mercury: `mmc`!!
* NASM: `nasm`!!
* Nim: `nim check`!!
* nix: `nix-instantiate`
* nroff: `alex`!!, `proselint`, `write-good`
* Objective-C: `clang`
* Objective-C++: `clang`
* OCaml: `merlin` (see |ale-ocaml-merlin|), `ols`
* Perl: `perl -c`, `perl-critic`
* Perl: `perl -c`, `perl-critic`, `perltidy`
* PHP: `hack`, `hackfmt`, `langserver`, `phan`, `php -l`, `phpcs`, `phpmd`, `phpstan`, `phpcbf`, `php-cs-fixer`
* PO: `alex`!!, `msgfmt`, `proselint`, `write-good`
* Pod: `alex`!!, `proselint`, `write-good`
@ -364,8 +380,8 @@ Notes:
* proto: `protoc-gen-lint`
* Pug: `pug-lint`
* Puppet: `puppet`, `puppet-lint`
* Python: `autopep8`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pylint`!!, `yapf`
* QML: `qmllint`
* Python: `autopep8`, `black`, `flake8`, `isort`, `mypy`, `prospector`, `pycodestyle`, `pyls`, `pylint`!!, `yapf`
* QML: `qmlfmt`, `qmllint`
* R: `lintr`
* ReasonML: `merlin`, `ols`, `refmt`
* reStructuredText: `alex`!!, `proselint`, `redpen`, `rstcheck`, `vale`, `write-good`
@ -375,10 +391,10 @@ Notes:
* Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt`
* SASS: `sass-lint`, `stylelint`
* SCSS: `prettier`, `sass-lint`, `scss-lint`, `stylelint`
* Scala: `scalac`, `scalastyle`
* Scala: `fsc`, `scalac`, `scalafmt`, `scalastyle`
* Slim: `slim-lint`
* SML: `smlnj`
* Solidity: `solhint, solium`
* Solidity: `solhint`, `solium`
* Stylus: `stylelint`
* SQL: `sqlint`
* Swift: `swiftlint`, `swiftformat`
@ -462,14 +478,22 @@ the buffer-local options can be used with external plugins for reading Vim
project configuration files. Buffer-local settings can also be used in
ftplugin files for different filetypes.
ALE offers several options for controlling which linters are run.
* Selecting linters to run. - |g:ale_linters|
* Aliasing filetypes for linters - |g:ale_linter_aliases|
* Only running linters you asked for. - |g:ale_linters_explicit|
===============================================================================
4. Fixing Problems *ale-fix*
ALE can fix problems with files with the |ALEFix| command. When |ALEFix| is
run, the variable |g:ale_fixers| will be read for getting a |List| of commands
for filetypes, split on `.`, and the functions named in |g:ale_fixers| will be
executed for fixing the errors.
ALE can fix problems with files with the |ALEFix| command. |ALEFix|
accepts names of fixers to be applied as arguments. Alternatively,
when no arguments are provided, the variable |g:ale_fixers| will be
read for getting a |List| of commands for filetypes, split on `.`, and
the functions named in |g:ale_fixers| will be executed for fixing the
errors.
The |ALEFixSuggest| command can be used to suggest tools that be used to
fix problems for the current buffer.
@ -619,6 +643,9 @@ delay for completion can be configured with |g:ale_completion_delay|. ALE will
only suggest so many possible matches for completion. The maximum number of
items can be controlled with |g:ale_completion_max_suggestions|.
If you don't like some of the suggestions you see, you can filter them out
with |g:ale_completion_excluded_words| or |b:ale_completion_excluded_words|.
-------------------------------------------------------------------------------
5.2 Go To Definition *ale-go-to-definition*
@ -631,6 +658,32 @@ information returned by LSP servers. The following commands are supported:
|ALEGoToDefinitionInTab| - The same, but for opening the file in a new tab.
-------------------------------------------------------------------------------
5.3 Find References *ale-find-references*
ALE supports finding references for symbols though any enabled LSP linters.
ALE will display a preview window showing the places where a symbol is
referenced in a codebase when a command is run. The following commands are
supported:
|ALEFindReferences| - Find references for the word under the cursor.
-------------------------------------------------------------------------------
5.4 Hovering *ale-hover*
ALE supports "hover" information for printing brief information about symbols
at the cursor taken from LSP linters. The following commands are supported:
|ALEHover| - Print information about the symbol at the cursor.
If |b:ale_set_balloons| is set to `1` and your version of Vim supports the
|balloon_show()| function, then "hover" information also show up when you move
the mouse over a symbol in a buffer. Diagnostic information will take priority
over hover information for balloons. If a line contains a problem, that
problem will be displayed in a balloon instead of hover information.
===============================================================================
6. Global Options *ale-options*
@ -648,7 +701,7 @@ g:airline#extensions#ale#enabled *g:airline#extensions#ale#enabled*
g:ale_cache_executable_check_failures *g:ale_cache_executable_check_failures*
Type: |Number|
Default: `0`
Default: undefined
When set to `1`, ALE will cache failing executable checks for linters. By
default, only executable checks which succeed will be cached.
@ -731,6 +784,24 @@ g:ale_completion_enabled *g:ale_completion_enabled*
See |ale-completion|
g:ale_completion_excluded_words *g:ale_completion_excluded_words*
*b:ale_completion_excluded_words*
Type: |List|
Default: `[]`
This option can be set to a list of |String| values for "words" to exclude
from completion results, as in the words for |complete-items|. The strings
will be matched exactly in a case-sensitive manner. (|==#|)
This setting can be configured in ftplugin files with buffer variables, so
that different lists can be used for different filetypes. For example: >
" In ~/.vim/ftplugin/typescript.vim
" Don't suggest `it` or `describe` so we can use snippets for those words.
let b:ale_completion_excluded_words = ['it', 'describe']
<
g:ale_completion_max_suggestions *g:ale_completion_max_suggestions*
Type: |Number|
@ -830,20 +901,6 @@ g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str*
The string used for `%severity%` for warnings. See |g:ale_echo_msg_format|
g:ale_emit_conflict_warnings *g:ale_emit_conflict_warnings*
Type: |Number|
Default: `1`
When set to `0`, ALE will not emit any warnings on startup about conflicting
plugins. ALE will probably not work if other linting plugins are installed.
When this option is set to `1`, ALE will add its `after` directory to
|runtimepath| automatically, so the checks can be applied. Setting this
option to `0` before ALE is loaded will prevent ALE from modifying
|runtimepath|.
g:ale_enabled *g:ale_enabled*
*b:ale_enabled*
@ -1053,8 +1110,12 @@ g:ale_linter_aliases *g:ale_linter_aliases*
following values: >
{
\ 'zsh': 'sh',
\ 'Dockerfile': 'dockerfile',
\ 'csh': 'sh',
\ 'plaintex': 'tex',
\ 'systemverilog': 'verilog',
\ 'vimwiki': 'markdown',
\ 'zsh': 'sh',
\}
<
For example, if you wish to map a new filetype `'foobar'` to run the `'php'`
@ -1213,7 +1274,7 @@ g:ale_max_signs *g:ale_max_signs*
g:ale_maximum_file_size *g:ale_maximum_file_size*
*b:ale_maximum_file_size*
Type: |Number|
Default: `0`
Default: undefined
A maximum file size in bytes for ALE to check. If set to any positive
number, ALE will skip checking files larger than the given size.
@ -1294,17 +1355,38 @@ g:ale_set_balloons *g:ale_set_balloons*
*b:ale_set_balloons*
Type: |Number|
Default: `has('balloon_eval')`
Default: `(has('balloon_eval') && has('gui_running'))`
`|| (has('balloon_eval_term') && !has('gui_running'))`
When this option is set to `1`, balloon messages will be displayed for
problems. Problems nearest to the cursor on the line the cursor is over will
be displayed. Balloons will not be shown when either |g:ale_enabled| is `0`
or |b:ale_enabled| is `0`.
problems or hover information if available.
Problems nearest to the line the mouse cursor is over will be displayed. If
there are no problems to show, and one of the linters is an LSP linter
supporting "Hover" information, per |ale-hover|, then brief information
about the symbol under the cursor will be displayed in a balloon.
`b:ale_set_balloons` can be set to `0` to disable balloons for a buffer.
Balloons cannot be enabled for a specific buffer when not initially enabled
globally.
Balloons will not be shown when |g:ale_enabled| or |b:ale_enabled| is `0`.
g:ale_set_balloons_legacy_echo *g:ale_set_balloons_legacy_echo*
*b:ale_set_balloons_legacy_echo*
Type: |Number|
Default: undefined
If set to `1`, moving your mouse over documents in Vim will make ALE ask
`tsserver` or `LSP` servers for information about the symbol where the mouse
cursor is, and print that information into Vim's echo line. This is an
option for supporting older versions of Vim which do not properly support
balloons in an asynchronous manner.
If your version of Vim supports the |balloon_show| function, then this
option does nothing meaningful.
g:ale_set_highlights *g:ale_set_highlights*
@ -1492,6 +1574,18 @@ g:ale_type_map *g:ale_type_map*
Type maps can be set per-buffer with `b:ale_type_map`.
g:ale_use_global_executables *g:ale_use_global_executables*
Type: |Number|
Default: not set
This option can be set to change the default for all `_use_global` options.
This option must be set before ALE is loaded, preferably in a vimrc file.
See |ale-integrations-local-executables| for more information on those
options.
g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
b:ale_virtualenv_dir_names *b:ale_virtualenv_dir_names*
@ -1679,7 +1773,7 @@ g:ale_writegood_options *g:ale_writegood_options*
g:ale_writegood_use_global *g:ale_writegood_use_global*
*b:ale_writegood_use_global*
Type: |Number|
Default: `0`
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
@ -1713,6 +1807,9 @@ If you prefer to use global executables for those tools, set the relevant
let g:ale_python_flake8_use_global = 1
<
|g:ale_use_global_executables| can be set to `1` in your vimrc file to make
ALE use global executables for all linters by default.
The option |g:ale_virtualenv_dir_names| controls the local virtualenv paths
ALE will use to search for Python executables.
@ -1720,6 +1817,21 @@ ALE will use to search for Python executables.
===============================================================================
8. Commands/Keybinds *ale-commands*
ALEFindReferences *ALEFindReferences*
Find references in the codebase for the symbol under the cursor using the
enabled LSP linters for the buffer. ALE will display a preview window
containing the results if some references are found.
The window can be navigated using the usual Vim navigation commands. The
Enter key (`<CR>`) can be used to jump to a referencing location, or the `t`
key can be used to jump to the location in a new tab.
You can jump back to the position you were at before going to a reference of
something with jump motions like CTRL-O. See |jump-motions|.
A plug mapping `<Plug>(ale_find_references)` is defined for this command.
ALEFix *ALEFix*
Fix problems with the current buffer. See |ale-fix| for more information.
@ -1740,6 +1852,9 @@ ALEGoToDefinition *ALEGoToDefinition*
linters for the buffer. ALE will jump to a definition if an LSP server
provides a location to jump to. Otherwise, ALE will do nothing.
You can jump back to the position you were at before going to the definition
of something with jump motions like CTRL-O. See |jump-motions|.
A plug mapping `<Plug>(ale_go_to_definition)` is defined for this command.
@ -1750,6 +1865,19 @@ ALEGoToDefinitionInTab *ALEGoToDefinitionInTab*
A plug mapping `<Plug>(ale_go_to_definition_in_tab)` is defined for this
command.
ALEHover *ALEHover*
Print brief information about the symbol under the cursor, taken from any
available LSP linters. There may be a small non-blocking delay before
information is printed.
NOTE: In Vim 8, long messages will be shown in a preview window, as Vim 8
does not support showing a prompt to press enter to continue for long
messages from asynchronous callbacks.
A plug mapping `<Plug>(ale_hover)` is defined for this command.
*:ALELint*
ALELint *ALELint*
@ -1863,6 +1991,9 @@ ALEInfoToClipboard *ALEInfoToClipboard*
The command `:ALEInfoToClipboard` can be used to output ALEInfo directly to
your clipboard. This might not work on every machine.
`:ALEInfoToFile` will write the ALE runtime information to a given filename.
The filename works just like |:w|.
ALEReset *ALEReset*
ALEResetBuffer *ALEResetBuffer*
@ -2066,6 +2197,13 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
key is also set with a valid number for some other
buffer.
`vcol` - Defaults to `0`.
If set to `1`, ALE will convert virtual column
positions for `col` and `end_col` to byte column
positions. If the buffer is changed in-between
checking it and displaying the results, the
calculated byte column positions will probably be
wrong.
`type` - Defaults to `'E'`.
`nr` - Defaults to `-1`.
@ -2184,14 +2322,21 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
process for a language server runnning, and
communicates with it directly via a |channel|.
When this argument is not empty, then the
`project_callback` and `language_callback` arguments
must also be defined.
When this argument is not empty, only one of either
`language` or `language_callback` must be defined,
and `project_root_callback` must be defined.
LSP linters handle diagnostics automatically, so
the `callback` argument must not be defined.
`project_callback` A |String| or |Funcref| for a callback function
An optional `completion_filter` callback may be
defined for filtering completion results.
An optional `initialization_options` or
`initialization_options_callback` may be defined to
pass initialization options to the LSP.
`project_root_callback` A |String| or |Funcref| for a callback function
accepting a buffer number. A |String| should be
returned representing the path to the project for the
file being checked with the language server. If an
@ -2201,13 +2346,29 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
This argument must only be set if the `lsp` argument
is also set to a non-empty string.
`language` A |String| representing the name of the language
being checked. This string will be sent to the LSP to
tell it what type of language is being checked.
This argument must only be set if the `lsp` argument
is also set to a non-empty string.
`language_callback` A |String| or |Funcref| for a callback function
accepting a buffer number. A |String| should be
returned representing the name of the language being
checked.
This argument must only be set if the `lsp` argument
is also set to a non-empty string.
This option can be used instead of `language` if a
linter can check multiple languages.
`completion_filter` A |String| or |Funcref| for a callback function
accepting a buffer number and a completion item.
The completion item will be a |Dictionary| following
the Language Server Protocol `CompletionItem`
interface as described in the specification,
available online here:
https://microsoft.github.io/language-server-protocol
`aliases` A |List| of aliases for the linter name.
@ -2216,6 +2377,17 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
setting can make it easier to guess the linter name
by offering a few alternatives.
`initialization_options` A |Dictionary| of initialization options for LSPs.
This will be fed (as JSON) to the LSP in the
initialize command.
`initialization_options_callback`
A |String| or |Funcref| for a callback function
accepting a buffer number. A |Dictionary| should be
returned for initialization options to pass the LSP.
This can be used in place of `initialization_options`
when more complicated processing is needed.
Only one of `command`, `command_callback`, or `command_chain` should be
specified. `command_callback` is generally recommended when a command string
needs to be generated dynamically, or any global options are used.
@ -2259,6 +2431,7 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
is not desired, the |ale#engine#EscapeCommandPart()| function can be used to
replace those characters to avoid formatting issues.
*ale-linter-loading-behavior*
*ale-linter-loading-behaviour*
Linters for ALE will be loaded by searching |runtimepath| in the following
@ -2271,6 +2444,21 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
containing `.` characters will be split into individual parts, and files
will be loaded for each filetype between the `.` characters.
Linters can be defined from vimrc and other files as long as this function
is loaded first. For example, the following code will define a Hello World
linter in vimrc in Vim 8: >
" Plugins have to be loaded first.
" If you are using a plugin manager, run that first.
packloadall
call ale#linter#Define('vim', {
\ 'name': 'echo-test',
\ 'executable': 'echo',
\ 'command': 'echo hello world',
\ 'callback': {buffer, lines -> map(lines, '{"text": v:val, "lnum": 1}')},
\})
<
ale#linter#Get(filetype) *ale#linter#Get()*
@ -2286,6 +2474,13 @@ ale#linter#Get(filetype) *ale#linter#Get()*
components.
ale#linter#PreventLoading(filetype) *ale#linter#PreventLoading()*
Given a `filetype`, prevent any more linters from being loaded from
|runtimepath| for that filetype. This function can be called from vimrc or
similar to prevent ALE from loading linters.
ale#statusline#Count(buffer) *ale#statusline#Count()*
Given the number of a buffer which may have problems, return a |Dictionary|
@ -2341,7 +2536,15 @@ ALEFixPost *ALEFixPost-autocmd*
autocmd User ALELintPre let s:ale_running = 1 | redrawstatus
autocmd User ALELintPost let s:ale_running = 0 | redrawstatus
augroup end
<
ALEJobStarted *ALEJobStarted-autocmd*
This |User| autocommand is triggered immediately after a job is successfully
run. This provides better accuracy for checking linter status with
|ale#engine#IsCheckingBuffer()| over |ALELintPre-autocmd|, which is actually
triggered before any linters are executed.
===============================================================================
10. Special Thanks *ale-special-thanks*