mirror of
https://github.com/amix/vimrc
synced 2025-06-16 01:25:00 +08:00
Updated vim plugins
This commit is contained in:
@ -5,6 +5,11 @@ ALE Elixir Integration *ale-elixir-options*
|
||||
===============================================================================
|
||||
mix *ale-elixir-mix*
|
||||
|
||||
|
||||
The `mix` linter is disabled by default, as it can bee too expensive to run.
|
||||
See `:help g:ale_linters`
|
||||
|
||||
|
||||
g:ale_elixir_mix_options *g:ale_elixir_mix_options*
|
||||
*b:ale_elixir_mix_options*
|
||||
Type: |String|
|
||||
@ -53,5 +58,20 @@ g:ale_elixir_elixir_ls_release *g:ale_elixir_elixir_ls_release*
|
||||
Location of the elixir-ls release directory. This directory must contain
|
||||
the language server scripts (language_server.sh and language_server.bat).
|
||||
|
||||
g:ale_elixir_elixir_ls_config *g:ale_elixir_elixir_ls_config*
|
||||
*b:ale_elixir_elixir_ls_config*
|
||||
Type: |Dictionary|
|
||||
Default: `{}`
|
||||
|
||||
Dictionary containing configuration settings that will be passed to the
|
||||
language server. For example, to disable Dialyzer: >
|
||||
{
|
||||
\ 'elixirLS': {
|
||||
\ 'dialyzerEnabled': v:false,
|
||||
\ },
|
||||
\ }
|
||||
<
|
||||
Consult the ElixirLS documentation for more information about settings.
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
||||
|
@ -1,15 +1,37 @@
|
||||
===============================================================================
|
||||
ALE Eruby Integration *ale-eruby-options*
|
||||
|
||||
There are three linters for `eruby` files:
|
||||
There are four linters for `eruby` files:
|
||||
|
||||
- `erb`
|
||||
- `erubis`
|
||||
- `erubi`
|
||||
- `ruumba`
|
||||
|
||||
`erb` is in the Ruby standard library and is mostly universal. `erubis` is the
|
||||
default parser in Rails between 3.0 and 5.1. `erubi` is the default in Rails
|
||||
5.1 and later. To selectively enable a subset, see |g:ale_linters|.
|
||||
5.1 and later. `ruumba` can extract Ruby from eruby files and run rubocop on
|
||||
the result. To selectively enable a subset, see |g:ale_linters|.
|
||||
|
||||
===============================================================================
|
||||
ruumba *ale-eruby-ruumba*
|
||||
|
||||
g:ale_eruby_ruumba_executable *g:ale_eruby_ruumba_executable*
|
||||
*b:ale_eruby_ruumba_executable*
|
||||
Type: String
|
||||
Default: `'ruumba`
|
||||
|
||||
Override the invoked ruumba binary. This is useful for running ruumba
|
||||
from binstubs or a bundle.
|
||||
|
||||
|
||||
g:ale_eruby_ruumba_options *g:ale_ruby_ruumba_options*
|
||||
*b:ale_ruby_ruumba_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be change to modify flags given to ruumba.
|
||||
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
||||
|
@ -27,7 +27,7 @@ g:ale_go_go_executable *g:ale_go_go_options*
|
||||
Default: `'go'`
|
||||
|
||||
The executable that will be run for the `gobuild` and `govet` linters, and
|
||||
the gomod` fixer.
|
||||
the `gomod` fixer.
|
||||
|
||||
|
||||
===============================================================================
|
||||
@ -53,6 +53,25 @@ g:ale_go_gofmt_options *g:ale_go_gofmt_options*
|
||||
This variable can be set to pass additional options to the gofmt fixer.
|
||||
|
||||
|
||||
===============================================================================
|
||||
golint *ale-go-golint*
|
||||
|
||||
g:ale_go_golint_executable *g:ale_go_golint_executable*
|
||||
*b:ale_go_golint_executable*
|
||||
Type: |String|
|
||||
Default: `'golint'`
|
||||
|
||||
This variable can be set to change the golint executable path.
|
||||
|
||||
|
||||
g:ale_go_golint_options *g:ale_go_golint_options*
|
||||
*b:ale_go_golint_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass additional options to the golint linter.
|
||||
|
||||
|
||||
===============================================================================
|
||||
govet *ale-go-govet*
|
||||
|
||||
|
@ -79,6 +79,12 @@ g:ale_html_tidy_use_global *g:html_tidy_use_global*
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
===============================================================================
|
||||
prettier *ale-html-prettier*
|
||||
|
||||
See |ale-javascript-prettier| for information about the available options.
|
||||
|
||||
|
||||
===============================================================================
|
||||
stylelint *ale-html-stylelint*
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
||||
===============================================================================
|
||||
|
@ -203,5 +203,15 @@ g:ale_php_cs_fixer_options *g:ale_php_cs_fixer_options*
|
||||
|
||||
This variable can be set to pass additional options to php-cs-fixer.
|
||||
|
||||
===============================================================================
|
||||
php *ale-php-php*
|
||||
|
||||
g:ale_php_php_executable *g:ale_php_php_executable*
|
||||
*b:ale_php_php_executable*
|
||||
Type: |String|
|
||||
Default: `'php'`
|
||||
|
||||
This variable sets the executable used for php.
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
||||
|
@ -328,6 +328,46 @@ g:ale_python_pycodestyle_auto_pipenv *g:ale_python_pycodestyle_auto_pipenv*
|
||||
if true. This is overridden by a manually-set executable.
|
||||
|
||||
|
||||
===============================================================================
|
||||
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*
|
||||
|
||||
|
@ -129,5 +129,27 @@ g:ale_ruby_solargraph_executable *g:ale_ruby_solargraph_executable*
|
||||
from binstubs or a bundle.
|
||||
|
||||
|
||||
===============================================================================
|
||||
standardrb *ale-ruby-standardrb*
|
||||
|
||||
g:ale_ruby_standardrb_executable *g:ale_ruby_standardrb_executable*
|
||||
*b:ale_ruby_standardrb_executable*
|
||||
Type: String
|
||||
Default: `'standardrb'`
|
||||
|
||||
Override the invoked standardrb binary. Set this to `'bundle'` to invoke
|
||||
`'bundle` `exec` standardrb'.
|
||||
|
||||
|
||||
g:ale_ruby_standardrb_options *g:ale_ruby_standardrb_options*
|
||||
*b:ale_ruby_standardrb_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be change to modify flags given to standardrb.
|
||||
|
||||
|
||||
===============================================================================
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
||||
|
@ -2,6 +2,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*
|
||||
|
||||
|
@ -8,6 +8,33 @@ prettier *ale-scss-prettier*
|
||||
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*
|
||||
|
||||
|
@ -21,9 +21,11 @@ tslint *ale-typescript-tslint*
|
||||
|
||||
This linter isn't recommended, because TSLint can't be used for checking for
|
||||
problems while you type. You should probably use the tsserver plugin instead.
|
||||
tsserver plugins are described here:
|
||||
https://github.com/Microsoft/TypeScript/wiki/Writing-a-Language-Service-Plugin
|
||||
|
||||
Follow the instructions on the plugin website for installing it:
|
||||
https://github.com/angelozerr/tsserver-plugins
|
||||
https://github.com/Microsoft/typescript-tslint-plugin
|
||||
|
||||
Then disable TSLint in vimrc or any other Vim configuration file. >
|
||||
let g:ale_linters_ignore = {'typescript': ['tslint']}
|
||||
|
@ -21,6 +21,8 @@ CONTENTS *ale-contents*
|
||||
6.1 Highlights........................|ale-highlights|
|
||||
6.2 Options for write-good Linter.....|ale-write-good-options|
|
||||
7. Integration Documentation............|ale-integrations|
|
||||
ada...................................|ale-ada-options|
|
||||
gcc.................................|ale-ada-gcc|
|
||||
ansible...............................|ale-ansible-options|
|
||||
ansible-lint........................|ale-ansible-ansible-lint|
|
||||
asciidoc..............................|ale-asciidoc-options|
|
||||
@ -29,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|
|
||||
@ -92,6 +96,7 @@ CONTENTS *ale-contents*
|
||||
erlc................................|ale-erlang-erlc|
|
||||
syntaxerl...........................|ale-erlang-syntaxerl|
|
||||
eruby.................................|ale-eruby-options|
|
||||
ruumba..............................|ale-eruby-ruumba|
|
||||
fish..................................|ale-fish-options|
|
||||
fortran...............................|ale-fortran-options|
|
||||
gcc.................................|ale-fortran-gcc|
|
||||
@ -107,6 +112,7 @@ CONTENTS *ale-contents*
|
||||
go....................................|ale-go-options|
|
||||
gobuild.............................|ale-go-gobuild|
|
||||
gofmt...............................|ale-go-gofmt|
|
||||
golint..............................|ale-go-golint|
|
||||
govet...............................|ale-go-govet|
|
||||
gometalinter........................|ale-go-gometalinter|
|
||||
staticcheck.........................|ale-go-staticcheck|
|
||||
@ -138,10 +144,13 @@ CONTENTS *ale-contents*
|
||||
html..................................|ale-html-options|
|
||||
htmlhint............................|ale-html-htmlhint|
|
||||
tidy................................|ale-html-tidy|
|
||||
prettier............................|ale-html-prettier|
|
||||
stylelint...........................|ale-html-stylelint|
|
||||
write-good..........................|ale-html-write-good|
|
||||
idris.................................|ale-idris-options|
|
||||
idris...............................|ale-idris-idris|
|
||||
ispc..................................|ale-ispc-options|
|
||||
ispc................................|ale-ispc-ispc|
|
||||
java..................................|ale-java-options|
|
||||
checkstyle..........................|ale-java-checkstyle|
|
||||
javac...............................|ale-java-javac|
|
||||
@ -224,6 +233,7 @@ CONTENTS *ale-contents*
|
||||
phpstan.............................|ale-php-phpstan|
|
||||
psalm...............................|ale-php-psalm|
|
||||
php-cs-fixer........................|ale-php-php-cs-fixer|
|
||||
php.................................|ale-php-php|
|
||||
po....................................|ale-po-options|
|
||||
write-good..........................|ale-po-write-good|
|
||||
pod...................................|ale-pod-options|
|
||||
@ -250,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|
|
||||
@ -274,12 +285,14 @@ CONTENTS *ale-contents*
|
||||
ruby................................|ale-ruby-ruby|
|
||||
rufo................................|ale-ruby-rufo|
|
||||
solargraph..........................|ale-ruby-solargraph|
|
||||
standardrb..........................|ale-ruby-standardrb|
|
||||
rust..................................|ale-rust-options|
|
||||
cargo...............................|ale-rust-cargo|
|
||||
rls.................................|ale-rust-rls|
|
||||
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|
|
||||
@ -287,6 +300,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|
|
||||
@ -388,12 +402,14 @@ Notes:
|
||||
`^` No linters for text or Vim help filetypes are enabled by default.
|
||||
`!!` These linters check only files on disk. See |ale-lint-file-linters|
|
||||
|
||||
* Ada: `gcc`
|
||||
* ASM: `gcc`
|
||||
* Ansible: `ansible-lint`
|
||||
* API Blueprint: `drafter`
|
||||
* AsciiDoc: `alex`!!, `proselint`, `redpen`, `write-good`
|
||||
* 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`
|
||||
@ -414,7 +430,7 @@ Notes:
|
||||
* Dockerfile: `dockerfile_lint`, `hadolint`
|
||||
* Elixir: `credo`, `dialyxir`, `dogma`, `mix`!!, `elixir-ls`
|
||||
* Elm: `elm-format, elm-make`
|
||||
* Erb: `erb`, `erubi`, `erubis`
|
||||
* Erb: `erb`, `erubi`, `erubis`, `ruumba`
|
||||
* Erlang: `erlc`, `SyntaxErl`
|
||||
* Fish: `fish` (-n flag)
|
||||
* Fortran: `gcc`, `language_server`
|
||||
@ -429,8 +445,9 @@ Notes:
|
||||
* Handlebars: `ember-template-lint`
|
||||
* Haskell: `brittany`, `ghc`, `cabal-ghc`, `stylish-haskell`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `hlint`, `hdevtools`, `hfmt`, `hie`
|
||||
* HCL: `terraform-fmt`
|
||||
* HTML: `alex`!!, `HTMLHint`, `proselint`, `tidy`, `write-good`
|
||||
* HTML: `alex`!!, `HTMLHint`, `proselint`, `tidy`, `prettier`, `write-good`
|
||||
* Idris: `idris`
|
||||
* ISPC: `ispc`!!
|
||||
* Java: `checkstyle`, `javac`, `google-java-format`, `PMD`, `javalsp`, `uncrustify`
|
||||
* JavaScript: `eslint`, `flow`, `jscs`, `jshint`, `prettier`, `prettier-eslint`, `prettier-standard`, `standard`, `xo`
|
||||
* JSON: `fixjson`, `jsonlint`, `jq`, `prettier`
|
||||
@ -463,14 +480,14 @@ 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`
|
||||
* reStructuredText: `alex`!!, `proselint`, `redpen`, `rstcheck`, `vale`, `write-good`
|
||||
* Re:VIEW: `redpen`
|
||||
* RPM spec: `rpmlint`
|
||||
* Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby`, `rufo`, `solargraph`
|
||||
* Ruby: `brakeman`, `rails_best_practices`!!, `reek`, `rubocop`, `ruby`, `rufo`, `solargraph`, `standardrb`
|
||||
* Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt`
|
||||
* SASS: `sass-lint`, `stylelint`
|
||||
* SCSS: `prettier`, `sass-lint`, `scss-lint`, `stylelint`
|
||||
@ -555,6 +572,7 @@ their relevant options.
|
||||
* By setting error highlights. - |g:ale_set_highlights|
|
||||
* By creating signs in the sign column. - |g:ale_set_signs|
|
||||
* By echoing messages based on your cursor. - |g:ale_echo_cursor|
|
||||
* By inline text based on your cursor. - |g:ale_virtualtext_cursor|
|
||||
* By displaying the preview based on your cursor. - |g:ale_cursor_detail|
|
||||
* By showing balloons for your mouse cursor - |g:ale_set_balloons|
|
||||
|
||||
@ -859,6 +877,9 @@ settings. For example: >
|
||||
set ttymouse=xterm
|
||||
<
|
||||
|
||||
Documentation for symbols at the cursor can be retrieved using the
|
||||
|ALEDocumentation| command. This command is only available for `tsserver`.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
5.5 Symbol Search *ale-symbol-search*
|
||||
|
||||
@ -1184,6 +1205,9 @@ b:ale_fix_on_save *b:ale_fix_on_save*
|
||||
after files are fixed, only when the buffer is open, or re-opened. Changes
|
||||
to the file will be saved to the file on disk.
|
||||
|
||||
Files will not be fixed on `:wq`, so you should check your code before
|
||||
closing a buffer.
|
||||
|
||||
Fixing files can be disabled or enabled for individual buffers by setting
|
||||
`b:ale_fix_on_save` to `0` or `1`.
|
||||
|
||||
@ -1362,6 +1386,7 @@ g:ale_linter_aliases *g:ale_linter_aliases*
|
||||
\ 'systemverilog': 'verilog',
|
||||
\ 'verilog_systemverilog': ['verilog_systemverilog', 'verilog'],
|
||||
\ 'vimwiki': 'markdown',
|
||||
\ 'vue': ['vue', 'javascript'],
|
||||
\ 'zsh': 'sh',
|
||||
\}
|
||||
<
|
||||
@ -1410,6 +1435,7 @@ g:ale_linters *g:ale_linters*
|
||||
|
||||
{
|
||||
\ 'csh': ['shell'],
|
||||
\ 'elixir': ['credo', 'dialyxir', 'dogma', 'elixir-ls'],
|
||||
\ 'go': ['gofmt', 'golint', 'go vet'],
|
||||
\ 'hack': ['hack'],
|
||||
\ 'help': [],
|
||||
@ -1419,6 +1445,7 @@ g:ale_linters *g:ale_linters*
|
||||
\ 'rust': ['cargo'],
|
||||
\ 'spec': [],
|
||||
\ 'text': [],
|
||||
\ 'vue': ['eslint', 'vls'],
|
||||
\ 'zsh': ['shell'],
|
||||
\}
|
||||
<
|
||||
@ -1866,6 +1893,49 @@ g:ale_use_global_executables *g:ale_use_global_executables*
|
||||
options.
|
||||
|
||||
|
||||
g:ale_virtualtext_cursor *g:ale_virtualtext_cursor*
|
||||
|
||||
Type: |Number|
|
||||
Default: `0`
|
||||
|
||||
When this option is set to `1`, a message will be shown when a cursor is
|
||||
near a warning or error. ALE will attempt to find the warning or error at a
|
||||
column nearest to the cursor when the cursor is resting on a line which
|
||||
contains a warning or error. This option can be set to `0` to disable this
|
||||
behavior.
|
||||
|
||||
Messages are only displayed after a short delay. See |g:ale_virtualtext_delay|.
|
||||
|
||||
Messages can be prefixed prefixed with a string. See |g:ale_virtualtext_prefix|.
|
||||
|
||||
ALE will use the following highlight groups for problems:
|
||||
|
||||
|ALEVirtualTextError| - Items with `'type': 'E'`
|
||||
|ALEVirtualTextWarning| - Items with `'type': 'W'`
|
||||
|ALEVirtualTextInfo| - Items with `'type': 'I'`
|
||||
|ALEVirtualTextStyleError| - Items with `'type': 'E'` and `'sub_type': 'style'`
|
||||
|ALEVirtualTextStyleWarning| - Items with `'type': 'W'` and `'sub_type': 'style'`
|
||||
|
||||
|
||||
g:ale_virtualtext_delay *g:ale_virtualtext_delay*
|
||||
b:ale_virtualtext_delay *b:ale_virtualtext_delay*
|
||||
Type: |Number|
|
||||
Default: `10`
|
||||
|
||||
Given any integer, this option controls the number of milliseconds before
|
||||
ALE will show a message for a problem near the cursor.
|
||||
|
||||
The value can be increased to decrease the amount of processing ALE will do
|
||||
for files displaying a large number of problems.
|
||||
|
||||
|
||||
g:ale_virtualtext_prefix *g:ale_virtualtext_prefix*
|
||||
|
||||
Type: |String|
|
||||
Default: `'> '`
|
||||
|
||||
Prefix to be used with |g:ale_virtualtext_cursor|.
|
||||
|
||||
g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
|
||||
b:ale_virtualenv_dir_names *b:ale_virtualenv_dir_names*
|
||||
|
||||
@ -1932,7 +2002,7 @@ ALEError *ALEError*
|
||||
|
||||
Default: `highlight link ALEError SpellBad`
|
||||
|
||||
The highlight used for highlighted errors. See |g:ale_set_highlights|.
|
||||
The highlight for highlighted errors. See |g:ale_set_highlights|.
|
||||
|
||||
|
||||
ALEErrorLine *ALEErrorLine*
|
||||
@ -1949,21 +2019,21 @@ ALEErrorSign *ALEErrorSign*
|
||||
|
||||
Default: `highlight link ALEErrorSign error`
|
||||
|
||||
The highlight used for error signs. See |g:ale_set_signs|.
|
||||
The highlight for error signs. See |g:ale_set_signs|.
|
||||
|
||||
|
||||
ALEInfo *ALEInfo.*
|
||||
*ALEInfo-highlight*
|
||||
Default: `highlight link ALEInfo ALEWarning`
|
||||
|
||||
The highlight used for highlighted info messages. See |g:ale_set_highlights|.
|
||||
The highlight for highlighted info messages. See |g:ale_set_highlights|.
|
||||
|
||||
|
||||
ALEInfoSign *ALEInfoSign*
|
||||
|
||||
Default: `highlight link ALEInfoSign ALEWarningSign`
|
||||
|
||||
The highlight used for info message signs. See |g:ale_set_signs|.
|
||||
The highlight for info message signs. See |g:ale_set_signs|.
|
||||
|
||||
|
||||
ALEInfoLine *ALEInfoLine*
|
||||
@ -1980,35 +2050,70 @@ ALEStyleError *ALEStyleError*
|
||||
|
||||
Default: `highlight link ALEStyleError ALEError`
|
||||
|
||||
The highlight used for highlighted style errors. See |g:ale_set_highlights|.
|
||||
The highlight for highlighted style errors. See |g:ale_set_highlights|.
|
||||
|
||||
|
||||
ALEStyleErrorSign *ALEStyleErrorSign*
|
||||
|
||||
Default: `highlight link ALEStyleErrorSign ALEErrorSign`
|
||||
|
||||
The highlight used for style error signs. See |g:ale_set_signs|.
|
||||
The highlight for style error signs. See |g:ale_set_signs|.
|
||||
|
||||
|
||||
ALEStyleWarning *ALEStyleWarning*
|
||||
|
||||
Default: `highlight link ALEStyleWarning ALEError`
|
||||
|
||||
The highlight used for highlighted style warnings. See |g:ale_set_highlights|.
|
||||
The highlight for highlighted style warnings. See |g:ale_set_highlights|.
|
||||
|
||||
|
||||
ALEStyleWarningSign *ALEStyleWarningSign*
|
||||
|
||||
Default: `highlight link ALEStyleWarningSign ALEWarningSign`
|
||||
|
||||
The highlight used for style warning signs. See |g:ale_set_signs|.
|
||||
The highlight for style warning signs. See |g:ale_set_signs|.
|
||||
|
||||
|
||||
ALEVirtualTextError *ALEVirtualTextError*
|
||||
|
||||
Default: `highlight link ALEVirtualTextError ALEError`
|
||||
|
||||
The highlight for virtualtext errors. See |g:ale_virtualtext_cursor|.
|
||||
|
||||
|
||||
ALEVirtualTextInfo *ALEVirtualTextInfo*
|
||||
|
||||
Default: `highlight link ALEVirtualTextInfo ALEVirtualTextWarning`
|
||||
|
||||
The highlight for virtualtext info. See |g:ale_virtualtext_cursor|.
|
||||
|
||||
|
||||
ALEVirtualTextStyleError *ALEVirtualTextStyleError*
|
||||
|
||||
Default: `highlight link ALEVirtualTextStyleError ALEVirtualTextError`
|
||||
|
||||
The highlight for virtualtext style errors. See |g:ale_virtualtext_cursor|.
|
||||
|
||||
|
||||
ALEVirtualTextStyleWarning *ALEVirtualTextStyleWarning*
|
||||
|
||||
Default: `highlight link ALEVirtualTextStyleWarning ALEVirtualTextWarning`
|
||||
|
||||
The highlight for virtualtext style warnings. See |g:ale_virtualtext_cursor|.
|
||||
|
||||
|
||||
ALEVirtualTextWarning *ALEVirtualTextWarning*
|
||||
|
||||
Default: `highlight link ALEVirtualTextWarning ALEWarning`
|
||||
|
||||
The highlight for virtualtext errors. See |g:ale_virtualtext_cursor|.
|
||||
|
||||
|
||||
ALEWarning *ALEWarning*
|
||||
|
||||
Default: `highlight link ALEWarning SpellCap`
|
||||
|
||||
The highlight used for highlighted warnings. See |g:ale_set_highlights|.
|
||||
The highlight for highlighted warnings. See |g:ale_set_highlights|.
|
||||
|
||||
|
||||
ALEWarningLine *ALEWarningLine*
|
||||
@ -2025,7 +2130,7 @@ ALEWarningSign *ALEWarningSign*
|
||||
|
||||
Default: `highlight link ALEWarningSign todo`
|
||||
|
||||
The highlight used for warning signs. See |g:ale_set_signs|.
|
||||
The highlight for warning signs. See |g:ale_set_signs|.
|
||||
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
@ -2097,6 +2202,17 @@ ALE will use to search for Python executables.
|
||||
===============================================================================
|
||||
8. Commands/Keybinds *ale-commands*
|
||||
|
||||
ALEDocumentation *ALEDocumentation*
|
||||
|
||||
Similar to the |ALEHover| command, retrieve documentation information for
|
||||
the symbol at the cursor. Documentation data will always be shown in a
|
||||
preview window, no matter how small the documentation content is.
|
||||
|
||||
NOTE: This command is only available for `tsserver`.
|
||||
|
||||
A plug mapping `<Plug>(ale_documentation)` is defined for this command.
|
||||
|
||||
|
||||
ALEFindReferences *ALEFindReferences*
|
||||
|
||||
Find references in the codebase for the symbol under the cursor using the
|
||||
|
Reference in New Issue
Block a user