mirror of
https://github.com/amix/vimrc
synced 2025-07-02 05:05:00 +08:00
Updated plugins
This commit is contained in:
Amir
@ -17,17 +17,19 @@ CONTENTS *ale-contents*
|
||||
5.1 Completion........................|ale-completion|
|
||||
5.2 Go To Definition..................|ale-go-to-definition|
|
||||
5.3 Go To Type Definition.............|ale-go-to-type-definition|
|
||||
5.4 Find References...................|ale-find-references|
|
||||
5.5 Hovering..........................|ale-hover|
|
||||
5.6 Symbol Search.....................|ale-symbol-search|
|
||||
5.7 Refactoring: Rename, Actions......|ale-refactor|
|
||||
5.4 Go To Implementation..............|ale-go-to-type-implementation|
|
||||
5.5 Find References...................|ale-find-references|
|
||||
5.6 Hovering..........................|ale-hover|
|
||||
5.7 Symbol Search.....................|ale-symbol-search|
|
||||
5.8 Refactoring: Rename, Actions......|ale-refactor|
|
||||
6. Global Options.......................|ale-options|
|
||||
6.1 Highlights........................|ale-highlights|
|
||||
7. Linter/Fixer Options.................|ale-integration-options|
|
||||
7.1 Options for alex..................|ale-alex-options|
|
||||
7.2 Options for languagetool..........|ale-languagetool-options|
|
||||
7.3 Options for write-good............|ale-write-good-options|
|
||||
7.4 Other Linter/Fixer Options........|ale-other-integration-options|
|
||||
7.2 Options for cspell................|ale-cspell-options|
|
||||
7.3 Options for languagetool..........|ale-languagetool-options|
|
||||
7.4 Options for write-good............|ale-write-good-options|
|
||||
7.5 Other Linter/Fixer Options........|ale-other-integration-options|
|
||||
8. Commands/Keybinds....................|ale-commands|
|
||||
9. API..................................|ale-api|
|
||||
10. Special Thanks......................|ale-special-thanks|
|
||||
@ -286,6 +288,12 @@ number of the buffer that ALE wants to check.
|
||||
sources should perform their checks on a buffer in the background
|
||||
asynchronously, so they don't interrupt editing.
|
||||
|
||||
|ale#other_source#ShowResults()| must not be called synchronously before
|
||||
ALE's engine executes its code after the |ALEWantResults| event runs. If
|
||||
there are immediate results to provide to ALE, a 0 millisecond timer with
|
||||
|timer_start()| can be set instead up to call |ale#other_source#ShowResults()|
|
||||
after ALE has first executed its engine code for its own sources.
|
||||
|
||||
A plugin might integrate its own checks with ALE like so: >
|
||||
|
||||
augroup SomeGroupName
|
||||
@ -363,12 +371,16 @@ are supported for running the commands.
|
||||
|
||||
`process_with` An optional callback for post-processing.
|
||||
|
||||
The callback must accept two arguments,
|
||||
`(buffer, output)`, which can be used for converting
|
||||
the output from a command into lines to replace the
|
||||
buffer's contents with.
|
||||
The callback must accept arguments `(bufnr, output)`:
|
||||
the buffer number undergoing fixing and the fixer's
|
||||
output as a |List| of |String|s. It must return a |List|
|
||||
of |String|s that will be the new contents of the
|
||||
buffer.
|
||||
|
||||
This callback is useful to remove excess lines from the
|
||||
command's output or apply additional changes to the
|
||||
output.
|
||||
|
||||
A |List| of |String|s must be returned.
|
||||
|
||||
`read_buffer` An optional key for disabling reading the buffer.
|
||||
|
||||
@ -535,8 +547,10 @@ The |ALEComplete| command can be used to show completion suggestions manually,
|
||||
even when |g:ale_completion_enabled| is set to `0`. For manually requesting
|
||||
completion information with Deoplete, consult Deoplete's documentation.
|
||||
|
||||
ALE by can support automatic imports from external modules. This behavior can
|
||||
be enabled by setting the |g:ale_completion_autoimport| variable to `1`.
|
||||
ALE supports automatic imports from external modules. This behavior can be
|
||||
disabled by setting the |g:ale_completion_autoimport| variable to `0`.
|
||||
Disabling automatic imports can drop some or all completion items from
|
||||
some LSP servers (e.g. eclipselsp).
|
||||
|
||||
You can manually request imports for symbols at the cursor with the
|
||||
|ALEImport| command. The word at the cursor must be an exact match for some
|
||||
@ -624,14 +638,23 @@ documentation for the command for configuring how the location will be
|
||||
displayed.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
5.4 Find References *ale-find-references*
|
||||
5.4 Go To Implementation *ale-go-to-implementation*
|
||||
|
||||
ALE supports jumping to the files and locations where symbols are implemented
|
||||
through any enabled LSP linters. The locations ALE will jump to depend on the
|
||||
information returned by LSP servers. The |ALEGoToImplementation| command will
|
||||
jump to the implementation of symbols under the cursor. See the documentation
|
||||
for the command for configuring how the location will be displayed.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
5.5 Find References *ale-find-references*
|
||||
|
||||
ALE supports finding references for symbols though any enabled LSP linters
|
||||
with the |ALEFindReferences| command. See the documentation for the command
|
||||
for a full list of options.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
5.5 Hovering *ale-hover*
|
||||
5.6 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:
|
||||
@ -653,7 +676,8 @@ Hover information can be displayed in the preview window instead by setting
|
||||
|
||||
When using Neovim or Vim with |popupwin|, if |g:ale_hover_to_floating_preview|
|
||||
or |g:ale_floating_preview| is set to 1, the hover information will show in a
|
||||
floating window. And |g:ale_floating_window_border| for the border setting.
|
||||
floating window. The borders of the floating preview window can be customized
|
||||
by setting |g:ale_floating_window_border|.
|
||||
|
||||
For Vim 8.1+ terminals, mouse hovering is disabled by default. Enabling
|
||||
|balloonexpr| commands in terminals can cause scrolling issues in terminals,
|
||||
@ -673,18 +697,20 @@ Documentation for symbols at the cursor can be retrieved using the
|
||||
|ALEDocumentation| command. This command is only available for `tsserver`.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
5.6 Symbol Search *ale-symbol-search*
|
||||
5.7 Symbol Search *ale-symbol-search*
|
||||
|
||||
ALE supports searching for workspace symbols via LSP linters with the
|
||||
|ALESymbolSearch| command. See the documentation for the command
|
||||
for a full list of options.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
5.7 Refactoring: Rename, Actions *ale-refactor*
|
||||
5.8 Refactoring: Rename, Actions *ale-refactor*
|
||||
|
||||
ALE supports renaming symbols in code such as variables or class names with
|
||||
the |ALERename| command.
|
||||
|
||||
`ALEFileRename` will rename file and fix import paths (tsserver only).
|
||||
|
||||
|ALECodeAction| will execute actions on the cursor or applied to a visual
|
||||
range selection, such as automatically fixing errors.
|
||||
|
||||
@ -849,11 +875,13 @@ g:ale_completion_tsserver_remove_warnings
|
||||
g:ale_completion_autoimport *g:ale_completion_autoimport*
|
||||
|
||||
Type: Number
|
||||
Default: `0`
|
||||
Default: `1`
|
||||
|
||||
When this option is set to `0`, ALE will not try to automatically import
|
||||
completion results from external modules. It can be enabled by setting it
|
||||
to `1`.
|
||||
When this option is set to `1`, ALE will try to automatically import
|
||||
completion results from external modules. It can be disabled by setting it
|
||||
to `0`. Some LSP servers include auto imports on every completion item so
|
||||
disabling automatic imports may drop some or all completion items returnend
|
||||
by it (e.g. eclipselsp).
|
||||
|
||||
|
||||
g:ale_completion_excluded_words *g:ale_completion_excluded_words*
|
||||
@ -1209,14 +1237,19 @@ g:ale_floating_preview *g:ale_floating_preview*
|
||||
g:ale_floating_window_border *g:ale_floating_window_border*
|
||||
|
||||
Type: |List|
|
||||
Default: `['|', '-', '+', '+', '+', '+']`
|
||||
Default: `['|', '-', '+', '+', '+', '+', '|', '-']`
|
||||
|
||||
When set to `[]`, window borders are disabled. The elements in the list set
|
||||
the horizontal, top, top-left, top-right, bottom-right and bottom-left
|
||||
border characters, respectively.
|
||||
the the characters for the left side, top, top-left corner, top-right
|
||||
corner, bottom-right corner, bottom-left corner, right side, and bottom of
|
||||
the floating window, respectively.
|
||||
|
||||
If the terminal supports Unicode, you might try setting the value to
|
||||
` ['│', '─', '╭', '╮', '╯', '╰']`, to make it look nicer.
|
||||
` ['│', '─', '╭', '╮', '╯', '╰', '│', '─']`, to make it look nicer.
|
||||
|
||||
NOTE: For compatibility with previous versions, if the list does not have
|
||||
elements for the right side and bottom, the left side and top will be used
|
||||
instead.
|
||||
|
||||
|
||||
g:ale_history_enabled *g:ale_history_enabled*
|
||||
@ -1439,9 +1472,9 @@ g:ale_linter_aliases *g:ale_linter_aliases*
|
||||
\ 'ps1': 'powershell',
|
||||
\ 'rmarkdown': 'r',
|
||||
\ 'rmd': 'r',
|
||||
\ 'svelte': ['svelte', 'javascript'],
|
||||
\ 'systemverilog': 'verilog',
|
||||
\ 'typescriptreact': ['typescript', 'tsx'],
|
||||
\ 'vader': ['vim', 'vader'],
|
||||
\ 'verilog_systemverilog': ['verilog_systemverilog', 'verilog'],
|
||||
\ 'vimwiki': 'markdown',
|
||||
\ 'vue': ['vue', 'javascript'],
|
||||
@ -1585,16 +1618,21 @@ g:ale_linters *g:ale_linters*
|
||||
\ 'hack': ['hack'],
|
||||
\ 'help': [],
|
||||
\ 'inko': ['inko'],
|
||||
\ 'json': ['jsonlint', 'spectral'],
|
||||
\ 'json': ['jsonlint', 'spectral', 'vscodejson'],
|
||||
\ 'json5': [],
|
||||
\ 'jsonc': [],
|
||||
\ 'perl': ['perlcritic'],
|
||||
\ 'perl6': [],
|
||||
\ 'python': ['flake8', 'mypy', 'pylint', 'pyright'],
|
||||
\ 'rust': ['cargo', 'rls'],
|
||||
\ 'spec': [],
|
||||
\ 'svelte': ['eslint', 'svelteserver'],
|
||||
\ 'text': [],
|
||||
\ 'vader': ['vimls'],
|
||||
\ 'vue': ['eslint', 'vls'],
|
||||
\ 'zsh': ['shell'],
|
||||
\ 'v': ['v'],
|
||||
\ 'yaml': ['spectral', 'yaml-language-server', 'yamllint'],
|
||||
\}
|
||||
<
|
||||
This option can be used to enable only a particular set of linters for a
|
||||
@ -1790,6 +1828,9 @@ g:ale_open_list *g:ale_open_list*
|
||||
loclist (|lopen|) or for the quickfix list instead if |g:ale_set_quickfix|
|
||||
is `1`. (|copen|)
|
||||
|
||||
When set to any higher numberical value, ALE will only open the window when
|
||||
the number of warnings or errors are at least that many.
|
||||
|
||||
When set to `'on_save'`, ALE will only open the loclist after buffers have
|
||||
been saved. The list will be opened some time after buffers are saved and
|
||||
any linter for a buffer returns results.
|
||||
@ -1810,8 +1851,8 @@ g:ale_open_list *g:ale_open_list*
|
||||
autocmd!
|
||||
autocmd QuitPre * if empty(&buftype) | lclose | endif
|
||||
augroup END
|
||||
<
|
||||
|
||||
<
|
||||
g:ale_pattern_options *g:ale_pattern_options*
|
||||
|
||||
Type: |Dictionary|
|
||||
@ -2008,7 +2049,7 @@ g:ale_set_quickfix *g:ale_set_quickfix*
|
||||
This feature should not be used in combination with tools for searching for
|
||||
matches and commands like |:cfdo|, as ALE will replace the quickfix list
|
||||
pretty frequently. If you wish to use such tools, you should populate the
|
||||
loclist instead.
|
||||
loclist or use |ALEPopulateQuickfix| instead.
|
||||
|
||||
|
||||
g:ale_set_signs *g:ale_set_signs*
|
||||
@ -2071,6 +2112,7 @@ g:ale_sign_priority *g:ale_sign_priority*
|
||||
|
||||
|
||||
g:ale_shell *g:ale_shell*
|
||||
*b:ale_shell*
|
||||
|
||||
Type: |String|
|
||||
Default: not set
|
||||
@ -2088,6 +2130,7 @@ g:ale_shell *g:ale_shell*
|
||||
|
||||
|
||||
g:ale_shell_arguments *g:ale_shell_arguments*
|
||||
*b:ale_shell_arguments*
|
||||
|
||||
Type: |String|
|
||||
Default: not set
|
||||
@ -2564,7 +2607,80 @@ g:ale_alex_use_global *g:ale_alex_use_global*
|
||||
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
7.2. Options for languagetool *ale-languagetool-options*
|
||||
7.2. Options for cspell *ale-cspell-options*
|
||||
|
||||
The options for `cspell` are shared between all filetypes, so options can be
|
||||
configured only once.
|
||||
|
||||
g:ale_cspell_executable *g:ale_cspell_executable*
|
||||
*b:ale_cspell_executable*
|
||||
Type: |String|
|
||||
Default: `'cspell'`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
g:ale_cspell_options *g:ale_cspell_options*
|
||||
*b:ale_cspell_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass additional options to `cspell`.
|
||||
|
||||
|
||||
g:ale_cspell_use_global *g:ale_cspell_use_global*
|
||||
*b:ale_cspell_use_global*
|
||||
Type: |Number|
|
||||
Default: `get(g: 'ale_use_global_executables', 0)`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
7.3. Options for dprint *ale-dprint-options*
|
||||
|
||||
`dprint` is a fixer for many file types, including: (java|type)script,
|
||||
json(c?), markdown, and more. See https://dprint.dev/plugins for an up-to-date
|
||||
list of supported plugins and their configuration options.
|
||||
|
||||
g:ale_dprint_executable *g:ale_dprint_executable*
|
||||
*b:ale_dprint_executable*
|
||||
Type: |String|
|
||||
Default: `'dprint'`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
g:ale_dprint_config *g:ale_dprint_config*
|
||||
*b:ale_dprint_config*
|
||||
Type: |String|
|
||||
Default: `'dprint.json'`
|
||||
|
||||
This variable can be changed to provide a config file to `dprint`. The
|
||||
default is the nearest `dprint.json` searching upward from the current
|
||||
buffer.
|
||||
|
||||
See https://dprint.dev/config and https://plugins.dprint.dev
|
||||
|
||||
|
||||
g:ale_dprint_options *g:ale_dprint_options*
|
||||
*b:ale_dprint_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass additional options to `dprint`.
|
||||
|
||||
|
||||
g:ale_dprint_use_global *g:ale_dprint_use_global*
|
||||
*b:ale_dprint_use_global*
|
||||
Type: |Number|
|
||||
Default: `get(g: 'ale_use_global_executables', 0)`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
7.4. Options for languagetool *ale-languagetool-options*
|
||||
|
||||
g:ale_languagetool_executable *g:ale_languagetool_executable*
|
||||
*b:ale_languagetool_executable*
|
||||
@ -2584,7 +2700,7 @@ g:ale_languagetool_options *g:ale_languagetool_options*
|
||||
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
7.3. Options for write-good *ale-write-good-options*
|
||||
7.5. Options for write-good *ale-write-good-options*
|
||||
|
||||
The options for `write-good` are shared between all filetypes, so options can
|
||||
be configured once.
|
||||
@ -2614,12 +2730,13 @@ g:ale_writegood_use_global *g:ale_writegood_use_global*
|
||||
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
7.4. Other Linter/Fixer Options *ale-other-integration-options*
|
||||
7.6. Other Linter/Fixer Options *ale-other-integration-options*
|
||||
|
||||
ALE supports a very wide variety of tools. Other linter or fixer options are
|
||||
documented in additional help files.
|
||||
|
||||
ada.....................................|ale-ada-options|
|
||||
cspell................................|ale-ada-cspell|
|
||||
gcc...................................|ale-ada-gcc|
|
||||
gnatpp................................|ale-ada-gnatpp|
|
||||
ada-language-server...................|ale-ada-language-server|
|
||||
@ -2629,10 +2746,13 @@ documented in additional help files.
|
||||
apkbuild-lint.........................|ale-apkbuild-apkbuild-lint|
|
||||
secfixes-check........................|ale-apkbuild-secfixes-check|
|
||||
asciidoc................................|ale-asciidoc-options|
|
||||
cspell................................|ale-asciidoc-cspell|
|
||||
write-good............................|ale-asciidoc-write-good|
|
||||
textlint..............................|ale-asciidoc-textlint|
|
||||
asm.....................................|ale-asm-options|
|
||||
gcc...................................|ale-asm-gcc|
|
||||
avra....................................|ale-avra-options|
|
||||
avra..................................|ale-avra-avra|
|
||||
awk.....................................|ale-awk-options|
|
||||
gawk..................................|ale-awk-gawk|
|
||||
bats....................................|ale-bats-options|
|
||||
@ -2641,6 +2761,8 @@ documented in additional help files.
|
||||
buildifier............................|ale-bazel-buildifier|
|
||||
bib.....................................|ale-bib-options|
|
||||
bibclean..............................|ale-bib-bibclean|
|
||||
bitbake.................................|ale-bitbake-options|
|
||||
oelint-adv............................|ale-bitbake-oelint_adv|
|
||||
c.......................................|ale-c-options|
|
||||
astyle................................|ale-c-astyle|
|
||||
cc....................................|ale-c-cc|
|
||||
@ -2650,8 +2772,11 @@ documented in additional help files.
|
||||
clangtidy.............................|ale-c-clangtidy|
|
||||
cppcheck..............................|ale-c-cppcheck|
|
||||
cquery................................|ale-c-cquery|
|
||||
cspell................................|ale-c-cspell|
|
||||
flawfinder............................|ale-c-flawfinder|
|
||||
uncrustify............................|ale-c-uncrustify|
|
||||
cairo...................................|ale-cairo-options|
|
||||
starknet..............................|ale-cairo-starknet|
|
||||
chef....................................|ale-chef-options|
|
||||
cookstyle.............................|ale-chef-cookstyle|
|
||||
foodcritic............................|ale-chef-foodcritic|
|
||||
@ -2662,6 +2787,7 @@ documented in additional help files.
|
||||
cfn-python-lint.......................|ale-cloudformation-cfn-python-lint|
|
||||
cmake...................................|ale-cmake-options|
|
||||
cmakelint.............................|ale-cmake-cmakelint|
|
||||
cmake-lint............................|ale-cmake-cmake-lint|
|
||||
cmake-format..........................|ale-cmake-cmakeformat|
|
||||
cpp.....................................|ale-cpp-options|
|
||||
astyle................................|ale-cpp-astyle|
|
||||
@ -2675,18 +2801,22 @@ documented in additional help files.
|
||||
cppcheck..............................|ale-cpp-cppcheck|
|
||||
cpplint...............................|ale-cpp-cpplint|
|
||||
cquery................................|ale-cpp-cquery|
|
||||
cspell................................|ale-cpp-cspell|
|
||||
flawfinder............................|ale-cpp-flawfinder|
|
||||
uncrustify............................|ale-cpp-uncrustify|
|
||||
c#......................................|ale-cs-options|
|
||||
csc...................................|ale-cs-csc|
|
||||
cspell................................|ale-cs-cspell|
|
||||
dotnet-format.........................|ale-cs-dotnet-format|
|
||||
mcs...................................|ale-cs-mcs|
|
||||
mcsc..................................|ale-cs-mcsc|
|
||||
uncrustify............................|ale-cs-uncrustify|
|
||||
css.....................................|ale-css-options|
|
||||
cspell................................|ale-css-cspell|
|
||||
fecs..................................|ale-css-fecs|
|
||||
prettier..............................|ale-css-prettier|
|
||||
stylelint.............................|ale-css-stylelint|
|
||||
vscodecss.............................|ale-css-vscode|
|
||||
cuda....................................|ale-cuda-options|
|
||||
nvcc..................................|ale-cuda-nvcc|
|
||||
clangd................................|ale-cuda-clangd|
|
||||
@ -2701,7 +2831,6 @@ documented in additional help files.
|
||||
analysis_server.......................|ale-dart-analysis_server|
|
||||
dart-analyze..........................|ale-dart-analyze|
|
||||
dart-format...........................|ale-dart-format|
|
||||
dartanalyzer..........................|ale-dart-dartanalyzer|
|
||||
dartfmt...............................|ale-dart-dartfmt|
|
||||
desktop.................................|ale-desktop-options|
|
||||
desktop-file-validate.................|ale-desktop-desktop-file-validate|
|
||||
@ -2711,6 +2840,7 @@ documented in additional help files.
|
||||
dhall-lint............................|ale-dhall-lint|
|
||||
dockerfile..............................|ale-dockerfile-options|
|
||||
dockerfile_lint.......................|ale-dockerfile-dockerfile_lint|
|
||||
dprint................................|ale-dockerfile-dprint|
|
||||
hadolint..............................|ale-dockerfile-hadolint|
|
||||
elixir..................................|ale-elixir-options|
|
||||
mix...................................|ale-elixir-mix|
|
||||
@ -2718,6 +2848,7 @@ documented in additional help files.
|
||||
dialyxir..............................|ale-elixir-dialyxir|
|
||||
elixir-ls.............................|ale-elixir-elixir-ls|
|
||||
credo.................................|ale-elixir-credo|
|
||||
cspell................................|ale-elixir-cspell|
|
||||
elm.....................................|ale-elm-options|
|
||||
elm-format............................|ale-elm-elm-format|
|
||||
elm-ls................................|ale-elm-elm-ls|
|
||||
@ -2746,8 +2877,10 @@ documented in additional help files.
|
||||
glslls................................|ale-glsl-glslls|
|
||||
go......................................|ale-go-options|
|
||||
bingo.................................|ale-go-bingo|
|
||||
cspell................................|ale-go-cspell|
|
||||
gobuild...............................|ale-go-gobuild|
|
||||
gofmt.................................|ale-go-gofmt|
|
||||
gofumpt...............................|ale-go-gofumpt|
|
||||
golangci-lint.........................|ale-go-golangci-lint|
|
||||
golangserver..........................|ale-go-golangserver|
|
||||
golines...............................|ale-go-golines|
|
||||
@ -2770,6 +2903,7 @@ documented in additional help files.
|
||||
ember-template-lint...................|ale-handlebars-embertemplatelint|
|
||||
haskell.................................|ale-haskell-options|
|
||||
brittany..............................|ale-haskell-brittany|
|
||||
cspell................................|ale-haskell-cspell|
|
||||
floskell..............................|ale-haskell-floskell|
|
||||
ghc...................................|ale-haskell-ghc|
|
||||
ghc-mod...............................|ale-haskell-ghc-mod|
|
||||
@ -2785,15 +2919,20 @@ documented in additional help files.
|
||||
hie...................................|ale-haskell-hie|
|
||||
ormolu................................|ale-haskell-ormolu|
|
||||
hcl.....................................|ale-hcl-options|
|
||||
packer-fmt............................|ale-hcl-packer-fmt|
|
||||
terraform-fmt.........................|ale-hcl-terraform-fmt|
|
||||
help....................................|ale-help-options|
|
||||
cspell................................|ale-help-cspell|
|
||||
html....................................|ale-html-options|
|
||||
angular...............................|ale-html-angular|
|
||||
cspell................................|ale-html-cspell|
|
||||
fecs..................................|ale-html-fecs|
|
||||
html-beautify.........................|ale-html-beautify|
|
||||
htmlhint..............................|ale-html-htmlhint|
|
||||
prettier..............................|ale-html-prettier|
|
||||
stylelint.............................|ale-html-stylelint|
|
||||
tidy..................................|ale-html-tidy|
|
||||
vscodehtml............................|ale-html-vscode|
|
||||
write-good............................|ale-html-write-good|
|
||||
idris...................................|ale-idris-options|
|
||||
idris.................................|ale-idris-idris|
|
||||
@ -2805,6 +2944,7 @@ documented in additional help files.
|
||||
ispc..................................|ale-ispc-ispc|
|
||||
java....................................|ale-java-options|
|
||||
checkstyle............................|ale-java-checkstyle|
|
||||
cspell................................|ale-java-cspell|
|
||||
javac.................................|ale-java-javac|
|
||||
google-java-format....................|ale-java-google-java-format|
|
||||
pmd...................................|ale-java-pmd|
|
||||
@ -2812,7 +2952,9 @@ documented in additional help files.
|
||||
eclipselsp............................|ale-java-eclipselsp|
|
||||
uncrustify............................|ale-java-uncrustify|
|
||||
javascript..............................|ale-javascript-options|
|
||||
cspell................................|ale-javascript-cspell|
|
||||
deno..................................|ale-javascript-deno|
|
||||
dprint................................|ale-javascript-dprint|
|
||||
eslint................................|ale-javascript-eslint|
|
||||
fecs..................................|ale-javascript-fecs|
|
||||
flow..................................|ale-javascript-flow|
|
||||
@ -2825,12 +2967,15 @@ documented in additional help files.
|
||||
standard..............................|ale-javascript-standard|
|
||||
xo....................................|ale-javascript-xo|
|
||||
json....................................|ale-json-options|
|
||||
cspell................................|ale-json-cspell|
|
||||
dprint................................|ale-json-dprint|
|
||||
eslint................................|ale-json-eslint|
|
||||
fixjson...............................|ale-json-fixjson|
|
||||
jsonlint..............................|ale-json-jsonlint|
|
||||
jq....................................|ale-json-jq|
|
||||
prettier..............................|ale-json-prettier|
|
||||
spectral..............................|ale-json-spectral|
|
||||
vscodejson............................|ale-json-vscode|
|
||||
jsonc...................................|ale-jsonc-options|
|
||||
eslint................................|ale-jsonc-eslint|
|
||||
jsonnet.................................|ale-jsonnet-options|
|
||||
@ -2845,6 +2990,7 @@ documented in additional help files.
|
||||
ktlint................................|ale-kotlin-ktlint|
|
||||
languageserver........................|ale-kotlin-languageserver|
|
||||
latex...................................|ale-latex-options|
|
||||
cspell................................|ale-latex-cspell|
|
||||
write-good............................|ale-latex-write-good|
|
||||
textlint..............................|ale-latex-textlint|
|
||||
less....................................|ale-less-options|
|
||||
@ -2854,12 +3000,16 @@ documented in additional help files.
|
||||
llvm....................................|ale-llvm-options|
|
||||
llc...................................|ale-llvm-llc|
|
||||
lua.....................................|ale-lua-options|
|
||||
cspell................................|ale-lua-cspell|
|
||||
lua-format............................|ale-lua-lua-format|
|
||||
luac..................................|ale-lua-luac|
|
||||
luacheck..............................|ale-lua-luacheck|
|
||||
luafmt................................|ale-lua-luafmt|
|
||||
selene................................|ale-lua-selene|
|
||||
stylua................................|ale-lua-stylua|
|
||||
markdown................................|ale-markdown-options|
|
||||
cspell................................|ale-markdown-cspell|
|
||||
dprint................................|ale-markdown-dprint|
|
||||
markdownlint..........................|ale-markdown-markdownlint|
|
||||
mdl...................................|ale-markdown-mdl|
|
||||
pandoc................................|ale-markdown-pandoc|
|
||||
@ -2878,6 +3028,7 @@ documented in additional help files.
|
||||
nix.....................................|ale-nix-options|
|
||||
nixfmt................................|ale-nix-nixfmt|
|
||||
nixpkgs-fmt...........................|ale-nix-nixpkgs-fmt|
|
||||
statix................................|ale-nix-statix|
|
||||
nroff...................................|ale-nroff-options|
|
||||
write-good............................|ale-nroff-write-good|
|
||||
objc....................................|ale-objc-options|
|
||||
@ -2890,6 +3041,7 @@ documented in additional help files.
|
||||
clangd................................|ale-objcpp-clangd|
|
||||
uncrustify............................|ale-objcpp-uncrustify|
|
||||
ocaml...................................|ale-ocaml-options|
|
||||
dune..................................|ale-ocaml-dune|
|
||||
merlin................................|ale-ocaml-merlin|
|
||||
ocamllsp..............................|ale-ocaml-ocamllsp|
|
||||
ols...................................|ale-ocaml-ols|
|
||||
@ -2899,6 +3051,10 @@ documented in additional help files.
|
||||
ibm_validator.........................|ale-openapi-ibm-validator|
|
||||
prettier..............................|ale-openapi-prettier|
|
||||
yamllint..............................|ale-openapi-yamllint|
|
||||
openscad................................|ale-openscad-options|
|
||||
sca2d.................................|ale-openscad-sca2d|
|
||||
packer..................................|ale-packer-options|
|
||||
packer-fmt-fixer......................|ale-packer-fmt-fixer|
|
||||
pascal..................................|ale-pascal-options|
|
||||
ptop..................................|ale-pascal-ptop|
|
||||
pawn....................................|ale-pawn-options|
|
||||
@ -2910,6 +3066,7 @@ documented in additional help files.
|
||||
perl6...................................|ale-perl6-options|
|
||||
perl6.................................|ale-perl6-perl6|
|
||||
php.....................................|ale-php-options|
|
||||
cspell................................|ale-php-cspell|
|
||||
langserver............................|ale-php-langserver|
|
||||
phan..................................|ale-php-phan|
|
||||
phpcbf................................|ale-php-phpcbf|
|
||||
@ -2919,6 +3076,7 @@ documented in additional help files.
|
||||
psalm.................................|ale-php-psalm|
|
||||
php-cs-fixer..........................|ale-php-php-cs-fixer|
|
||||
php...................................|ale-php-php|
|
||||
pint..................................|ale-php-pint|
|
||||
tlint.................................|ale-php-tlint|
|
||||
intelephense..........................|ale-php-intelephense|
|
||||
po......................................|ale-po-options|
|
||||
@ -2927,12 +3085,15 @@ documented in additional help files.
|
||||
write-good............................|ale-pod-write-good|
|
||||
pony....................................|ale-pony-options|
|
||||
ponyc.................................|ale-pony-ponyc|
|
||||
powershell............................|ale-powershell-options|
|
||||
powershell..........................|ale-powershell-powershell|
|
||||
psscriptanalyzer....................|ale-powershell-psscriptanalyzer|
|
||||
powershell..............................|ale-powershell-options|
|
||||
cspell................................|ale-powershell-cspell|
|
||||
powershell............................|ale-powershell-powershell|
|
||||
psscriptanalyzer......................|ale-powershell-psscriptanalyzer|
|
||||
prolog..................................|ale-prolog-options|
|
||||
swipl.................................|ale-prolog-swipl|
|
||||
proto...................................|ale-proto-options|
|
||||
buf-format............................|ale-proto-buf-format|
|
||||
buf-lint..............................|ale-proto-buf-lint|
|
||||
protoc-gen-lint.......................|ale-proto-protoc-gen-lint|
|
||||
protolint.............................|ale-proto-protolint|
|
||||
pug.....................................|ale-pug-options|
|
||||
@ -2953,6 +3114,7 @@ documented in additional help files.
|
||||
autopep8..............................|ale-python-autopep8|
|
||||
bandit................................|ale-python-bandit|
|
||||
black.................................|ale-python-black|
|
||||
cspell................................|ale-python-cspell|
|
||||
flake8................................|ale-python-flake8|
|
||||
flakehell.............................|ale-python-flakehell|
|
||||
isort.................................|ale-python-isort|
|
||||
@ -2961,12 +3123,14 @@ documented in additional help files.
|
||||
pycodestyle...........................|ale-python-pycodestyle|
|
||||
pydocstyle............................|ale-python-pydocstyle|
|
||||
pyflakes..............................|ale-python-pyflakes|
|
||||
pyflyby...............................|ale-python-pyflyby|
|
||||
pylama................................|ale-python-pylama|
|
||||
pylint................................|ale-python-pylint|
|
||||
pylsp.................................|ale-python-pylsp|
|
||||
pyre..................................|ale-python-pyre|
|
||||
pyright...............................|ale-python-pyright|
|
||||
reorder-python-imports................|ale-python-reorder_python_imports|
|
||||
unimport..............................|ale-python-unimport|
|
||||
vulture...............................|ale-python-vulture|
|
||||
yapf..................................|ale-python-yapf|
|
||||
qml.....................................|ale-qml-options|
|
||||
@ -2980,13 +3144,19 @@ documented in additional help files.
|
||||
ols...................................|ale-reasonml-ols|
|
||||
reason-language-server................|ale-reasonml-language-server|
|
||||
refmt.................................|ale-reasonml-refmt|
|
||||
rego....................................|ale-rego-options|
|
||||
cspell................................|ale-rego-cspell|
|
||||
opacheck..............................|ale-rego-opa-check|
|
||||
opafmt................................|ale-rego-opa-fmt-fixer|
|
||||
restructuredtext........................|ale-restructuredtext-options|
|
||||
cspell................................|ale-restructuredtext-cspell|
|
||||
textlint..............................|ale-restructuredtext-textlint|
|
||||
write-good............................|ale-restructuredtext-write-good|
|
||||
robot...................................|ale-robot-options|
|
||||
rflint................................|ale-robot-rflint|
|
||||
ruby....................................|ale-ruby-options|
|
||||
brakeman..............................|ale-ruby-brakeman|
|
||||
cspell................................|ale-ruby-cspell|
|
||||
debride...............................|ale-ruby-debride|
|
||||
prettier..............................|ale-ruby-prettier|
|
||||
rails_best_practices..................|ale-ruby-rails_best_practices|
|
||||
@ -3000,6 +3170,7 @@ documented in additional help files.
|
||||
rust....................................|ale-rust-options|
|
||||
analyzer..............................|ale-rust-analyzer|
|
||||
cargo.................................|ale-rust-cargo|
|
||||
cspell................................|ale-rust-cspell|
|
||||
rls...................................|ale-rust-rls|
|
||||
rustc.................................|ale-rust-rustc|
|
||||
rustfmt...............................|ale-rust-rustfmt|
|
||||
@ -3009,6 +3180,7 @@ documented in additional help files.
|
||||
sasslint..............................|ale-sass-sasslint|
|
||||
stylelint.............................|ale-sass-stylelint|
|
||||
scala...................................|ale-scala-options|
|
||||
cspell................................|ale-scala-cspell|
|
||||
metals................................|ale-scala-metals|
|
||||
sbtserver.............................|ale-scala-sbtserver|
|
||||
scalafmt..............................|ale-scala-scalafmt|
|
||||
@ -3019,6 +3191,7 @@ documented in additional help files.
|
||||
stylelint.............................|ale-scss-stylelint|
|
||||
sh......................................|ale-sh-options|
|
||||
bashate...............................|ale-sh-bashate|
|
||||
cspell................................|ale-sh-cspell|
|
||||
sh-language-server....................|ale-sh-language-server|
|
||||
shell.................................|ale-sh-shell|
|
||||
shellcheck............................|ale-sh-shellcheck|
|
||||
@ -3032,6 +3205,7 @@ documented in additional help files.
|
||||
spec....................................|ale-spec-options|
|
||||
rpmlint...............................|ale-spec-rpmlint|
|
||||
sql.....................................|ale-sql-options|
|
||||
dprint................................|ale-sql-dprint|
|
||||
pgformatter...........................|ale-sql-pgformatter|
|
||||
sqlfmt................................|ale-sql-sqlfmt|
|
||||
sqlformat.............................|ale-sql-sqlformat|
|
||||
@ -3044,12 +3218,14 @@ documented in additional help files.
|
||||
svelteserver..........................|ale-svelte-svelteserver|
|
||||
swift...................................|ale-swift-options|
|
||||
apple-swift-format....................|ale-swift-apple-swift-format|
|
||||
cspell................................|ale-swift-cspell|
|
||||
sourcekitlsp..........................|ale-swift-sourcekitlsp|
|
||||
systemd.................................|ale-systemd-options|
|
||||
systemd-analyze.......................|ale-systemd-analyze|
|
||||
tcl.....................................|ale-tcl-options|
|
||||
nagelfar..............................|ale-tcl-nagelfar|
|
||||
terraform...............................|ale-terraform-options|
|
||||
checkov...............................|ale-terraform-checkov|
|
||||
terraform-fmt-fixer...................|ale-terraform-fmt-fixer|
|
||||
terraform.............................|ale-terraform-terraform|
|
||||
terraform-ls..........................|ale-terraform-terraform-ls|
|
||||
@ -3057,19 +3233,26 @@ documented in additional help files.
|
||||
tflint................................|ale-terraform-tflint|
|
||||
tex.....................................|ale-tex-options|
|
||||
chktex................................|ale-tex-chktex|
|
||||
cspell................................|ale-tex-cspell|
|
||||
lacheck...............................|ale-tex-lacheck|
|
||||
latexindent...........................|ale-tex-latexindent|
|
||||
texlab................................|ale-tex-texlab|
|
||||
texinfo.................................|ale-texinfo-options|
|
||||
cspell................................|ale-texinfo-cspell|
|
||||
write-good............................|ale-texinfo-write-good|
|
||||
text....................................|ale-text-options|
|
||||
cspell................................|ale-text-cspell|
|
||||
textlint..............................|ale-text-textlint|
|
||||
write-good............................|ale-text-write-good|
|
||||
thrift..................................|ale-thrift-options|
|
||||
thrift................................|ale-thrift-thrift|
|
||||
thriftcheck...........................|ale-thrift-thriftcheck|
|
||||
toml....................................|ale-toml-options|
|
||||
dprint................................|ale-toml-dprint|
|
||||
typescript..............................|ale-typescript-options|
|
||||
cspell................................|ale-typescript-cspell|
|
||||
deno..................................|ale-typescript-deno|
|
||||
dprint................................|ale-typescript-dprint|
|
||||
eslint................................|ale-typescript-eslint|
|
||||
prettier..............................|ale-typescript-prettier|
|
||||
standard..............................|ale-typescript-standard|
|
||||
@ -3099,17 +3282,24 @@ documented in additional help files.
|
||||
vimls.................................|ale-vim-vimls|
|
||||
vint..................................|ale-vim-vint|
|
||||
vue.....................................|ale-vue-options|
|
||||
cspell................................|ale-vue-cspell|
|
||||
prettier..............................|ale-vue-prettier|
|
||||
vls...................................|ale-vue-vls|
|
||||
volar.................................|ale-vue-volar|
|
||||
wgsl....................................|ale-wgsl-options|
|
||||
naga..................................|ale-wgsl-naga|
|
||||
xhtml...................................|ale-xhtml-options|
|
||||
cspell................................|ale-xhtml-cspell|
|
||||
write-good............................|ale-xhtml-write-good|
|
||||
xml.....................................|ale-xml-options|
|
||||
xmllint...............................|ale-xml-xmllint|
|
||||
yaml....................................|ale-yaml-options|
|
||||
actionlint............................|ale-yaml-actionlint|
|
||||
circleci..............................|ale-yaml-circleci|
|
||||
prettier..............................|ale-yaml-prettier|
|
||||
spectral..............................|ale-yaml-spectral|
|
||||
swaglint..............................|ale-yaml-swaglint|
|
||||
yaml-language-server..................|ale-yaml-language-server|
|
||||
yamlfix...............................|ale-yaml-yamlfix|
|
||||
yamllint..............................|ale-yaml-yamllint|
|
||||
yang....................................|ale-yang-options|
|
||||
@ -3117,6 +3307,7 @@ documented in additional help files.
|
||||
zeek....................................|ale-zeek-options|
|
||||
zeek..................................|ale-zeek-zeek|
|
||||
zig.....................................|ale-zig-options|
|
||||
zigfmt................................|ale-zig-zigfmt|
|
||||
zls...................................|ale-zig-zls|
|
||||
|
||||
|
||||
@ -3157,15 +3348,16 @@ ALEFindReferences *ALEFindReferences*
|
||||
|
||||
The locations opened in different ways using the following variations.
|
||||
|
||||
`:ALEFindReferences -tab` - Open the location in a new tab.
|
||||
`:ALEFindReferences -split` - Open the location in a horizontal split.
|
||||
`:ALEFindReferences -vsplit` - Open the location in a vertical split.
|
||||
`:ALEFindReferences -tab` - Open the location in a new tab.
|
||||
`:ALEFindReferences -split` - Open the location in a horizontal split.
|
||||
`:ALEFindReferences -vsplit` - Open the location in a vertical split.
|
||||
`:ALEFindReferences -quickfix` - Put the locations into quickfix list.
|
||||
|
||||
The default method used for navigating to a new location can be changed
|
||||
by modifying |g:ale_default_navigation|.
|
||||
|
||||
You can add `-relative` to the command to view results with relatives paths,
|
||||
instead of absolute paths.
|
||||
instead of absolute paths. This option has no effect if `-quickfix` is used.
|
||||
|
||||
The selection can be opened again with the |ALERepeatSelection| command.
|
||||
|
||||
@ -3256,6 +3448,33 @@ ALEGoToTypeDefinition *ALEGoToTypeDefinition*
|
||||
`<Plug>(ale_go_to_type_definition_in_vsplit)` - `:ALEGoToTypeDefinition -vsplit`
|
||||
|
||||
|
||||
ALEGoToImplementation *ALEGoToImplementation*
|
||||
|
||||
This works similar to |ALEGoToDefinition| but instead jumps to the
|
||||
implementation of symbol under the cursor. ALE will jump to a definition if
|
||||
an LSP server provides a location to jump to. Otherwise, ALE will do nothing.
|
||||
|
||||
The locations opened in different ways using the following variations.
|
||||
|
||||
`:ALEGoToImplementation -tab` - Open the location in a new tab.
|
||||
`:ALEGoToImplementation -split` - Open the location in a horizontal split.
|
||||
`:ALEGoToImplementation -vsplit` - Open the location in a vertical split.
|
||||
|
||||
The default method used for navigating to a new location can be changed
|
||||
by modifying |g:ale_default_navigation|.
|
||||
|
||||
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|.
|
||||
|
||||
The following Plug mappings are defined for this command, which correspond
|
||||
to the following commands.
|
||||
|
||||
`<Plug>(ale_go_to_implementation)` - `:ALEGoToImplementation`
|
||||
`<Plug>(ale_go_to_implementation_in_tab)` - `:ALEGoToImplementation -tab`
|
||||
`<Plug>(ale_go_to_implementation_in_split)` - `:ALEGoToImplementation -split`
|
||||
`<Plug>(ale_go_to_implementation_in_vsplit)` - `:ALEGoToImplementation -vsplit`
|
||||
|
||||
|
||||
ALEHover *ALEHover*
|
||||
|
||||
Print brief information about the symbol under the cursor, taken from any
|
||||
@ -3298,6 +3517,13 @@ ALERename *ALERename*
|
||||
The symbol where the cursor is resting will be the symbol renamed, and a
|
||||
prompt will open to request a new name.
|
||||
|
||||
The rename operation will save all modified buffers when `set nohidden` is
|
||||
set, because that disables leaving unsaved buffers in the background. See
|
||||
`:help hidden` for more details.
|
||||
|
||||
ALEFileRename *ALEFileRename*
|
||||
|
||||
Rename a file and fix imports using `tsserver`.
|
||||
|
||||
ALECodeAction *ALECodeAction*
|
||||
|
||||
@ -3345,6 +3571,20 @@ ALELintStop *ALELintStop*
|
||||
Any problems from previous linter results will continue to be shown.
|
||||
|
||||
|
||||
ALEPopulateQuickfix *ALEPopulateQuickfix*
|
||||
ALEPopulateLocList *ALEPopulateLocList*
|
||||
|
||||
Manually populate the |quickfix| or |location-list| and show the
|
||||
corresponding list. Useful when you have other uses for both the |quickfix|
|
||||
and |location-list| and don't want them automatically populated. Be sure to
|
||||
disable auto populating: >
|
||||
|
||||
let g:ale_set_quickfix = 0
|
||||
let g:ale_set_loclist = 0
|
||||
<
|
||||
With these settings, ALE will still run checking and display it with signs,
|
||||
highlighting, and other output described in |ale-lint-file-linters|.
|
||||
|
||||
ALEPrevious *ALEPrevious*
|
||||
ALEPreviousWrap *ALEPreviousWrap*
|
||||
ALENext *ALENext*
|
||||
|
||||
Reference in New Issue
Block a user