ld/amix-vimrc-mirror
1
0
Fork 0
mirror of https://github.com/amix/vimrc synced 2025-08-30 02:44:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated plugins

Browse Source
This commit is contained in:
Amir
2024-01-07 16:14:20 +01:00
parent 86762cf230
commit f676f799e7
172 changed files with 3227 additions and 1204 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
sources_non_forked/ale/doc/ale-c.txt
View File

@ -25,10 +25,10 @@ g:ale_c_build_dir_names *g:ale_c_build_dir_names*
Type: |List|
Default: `['build', 'bin']`
A list of directory names to be used when searching upwards from cpp files
A list of directory names to be used when searching upwards from C files
to discover compilation databases with. For directory named `'foo'`, ALE
will search for `'foo/compile_commands.json'` in all directories on and
above the directory containing the cpp file to find path to compilation
above the directory containing the C file to find path to compilation
database. This feature is useful for the clang tools wrapped around
LibTooling (namely here, clang-tidy)
@ -202,6 +202,37 @@ g:ale_c_ccls_init_options *g:ale_c_ccls_init_options*
https://github.com/MaskRay/ccls/wiki/Customization#initialization-options.
===============================================================================
clangcheck *ale-c-clangcheck*
`clang-check` will be run only when files are saved to disk, so that
`compile_commands.json` files can be used. It is recommended to use this
linter in combination with `compile_commands.json` files.
Therefore, `clang-check` linter reads the options |g:ale_c_build_dir| and
|g:ale_c_build_dir_names|. Also, setting |g:ale_c_build_dir| actually
overrides |g:ale_c_build_dir_names|.
g:ale_c_clangcheck_executable *g:ale_c_clangcheck_executable*
*b:ale_c_clangcheck_executable*
Type: |String|
Default: `'clang-check'`
This variable can be changed to use a different executable for clangcheck.
g:ale_c_clangcheck_options *g:ale_c_clangcheck_options*
*b:ale_c_clangcheck_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clang-check.
This variable should not be set to point to build subdirectory with
`-p path/to/build` option, as it is handled by the |g:ale_c_build_dir|
option.
===============================================================================
clangd *ale-c-clangd*
@ -378,7 +409,7 @@ g:ale_c_cquery_executable *g:ale_c_cquery_executable*
This variable can be changed to use a different executable for cquery.
g:ale_cpp_cquery_cache_directory *g:ale_c_cquery_cache_directory*
g:ale_c_cquery_cache_directory *g:ale_c_cquery_cache_directory*
*b:ale_c_cquery_cache_directory*
Type: |String|
Default: `'~/.cache/cquery'`

15
sources_non_forked/ale/doc/ale-cairo.txt
View File

@ -2,6 +2,19 @@
ALE Cairo Integration *ale-cairo-options*
===============================================================================
scarb *ale-cairo-scarb*
g:ale_cairo_scarb_executable *g:ale_cairo_scarb_executable*
*b:ale_cairo_scarb_executable*
Default: `'scarb build'`
For Cairo1 projects using Scarb
For more information read 'https://docs.swmansion.com/scarb/'
===============================================================================
starknet *ale-cairo-starknet*
@ -13,3 +26,5 @@ g:ale_cairo_starknet_executable *g:ale_cairo_starknet_executable*
Overrides the starknet-compile binary after installing the cairo-language.
For more information read 'https://starknet.io/docs/quickstart.html'
===============================================================================

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

@ -48,7 +48,7 @@ documented functions and options, until a major version is planned. Breaking
changes should be preceded by a deprecation phase complete with warnings.
Changes required for security may be an exception.
ALE supports Vim 8 and above, and NeoVim 0.2.0 or newer. These are the
ALE supports Vim 8 and above, and NeoVim 0.6.0 or newer. These are the
earliest versions of Vim and NeoVim which support |job|, |timer|, |closure|,
and |lambda| features. All ALE code should be written so it is compatible with
these versions of Vim, or with version checks so particular features can
@ -156,7 +156,7 @@ environments.
1. Vim 8.0.0027 on Linux via GitHub Actions.
2. Vim 9.0.0297 on Linux via GitHub Actions.
3. NeoVim 0.2.0 on Linux via GitHub Actions.
3. NeoVim 0.6.0 on Linux via GitHub Actions.
4. NeoVim 0.8.0 on Linux via GitHub Actions.
6. Vim 8 (stable builds) on Windows via AppVeyor.

18
sources_non_forked/ale/doc/ale-elixir.txt
View File

@ -104,5 +104,23 @@ cspell *ale-elixir-cspell*
See |ale-cspell-options|
===============================================================================
lexical *ale-elixir-lexical*
Lexical (https://github.com/lexical-lsp/lexical)
g:ale_elixir_lexical_release *g:ale_elixir_lexical_release*
*b:ale_elixir_lexical_release*
Type: |String|
Default: `'lexical'`
Location of the lexical release directory. This directory must contain
the language server scripts (start_lexical.sh and start_lexical.bat).
For example, set release to: `/home/projects/lexical/_build/dev/rel/lexical`
There are currnetly no configuration options for lexical.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

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

@ -264,7 +264,7 @@ g:ale_java_eclipselsp_workspace_path *g:ale_java_eclipselsp_workspace_path*
Type: |String|
Default: `''`
If you have Eclipse installed is good idea to set this variable to the
If you have Eclipse installed it is a good idea to set this variable to the
absolute path of the Eclipse workspace. If not set this value will be set to
the parent folder of the project root.

25
sources_non_forked/ale/doc/ale-nickel.txt Normal file
View File

@ -0,0 +1,25 @@
===============================================================================
ALE Nickel Integration *ale-nickel-options*
===============================================================================
nickel_format *ale-nickel-nickel-format*
g:ale_nickel_nickel_format_executable *g:ale_nickel_nickel_format_executable*
*b:ale_nickel_nickel_format_executable*
Type: |String|
Default: `'nickel'`
This option can be changed to change the path for `nickel`.
g:ale_nickel_nickel_format_options *g:ale_nickel_nickel_format_options*
*b:ale_nickel_nickel_format_options*
Type: |String|
Default: `''`
This option can be changed to pass extra options to `'nickel format'`
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

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

@ -1322,6 +1322,70 @@ g:ale_python_ruff_auto_poetry *g:ale_python_ruff_auto_poetry*
if true. This is overridden by a manually-set executable.
===============================================================================
ruff-format *ale-python-ruff-format*
g:ale_python_ruff_format_change_directory
*g:ale_python_ruff_format_change_directory*
*b:ale_python_ruff_format_change_directory*
Type: |Number|
Default: `1`
If set to `1`, `ruff` will be run from a detected project root, per
|ale-python-root|. if set to `0` or no project root detected,
`ruff` will be run from the buffer's directory.
g:ale_python_ruff_format_executable *g:ale_python_ruff_format_executable*
*b:ale_python_ruff_format_executable*
Type: |String|
Default: `'ruff'`
See |ale-integrations-local-executables|
Set this to `'pipenv'` to invoke `'pipenv` `run` `ruff'`.
Set this to `'poetry'` to invoke `'poetry` `run` `ruff'`.
g:ale_python_ruff_format_options *g:ale_python_ruff_format_options*
*b:ale_python_ruff_format_options*
Type: |String|
Default: `''`
This variable can be changed to add command-line arguments to the ruff
invocation.
For example, to select/enable and/or disable some error codes,
you may want to set >
let g:ale_python_ruff_format_options = '--ignore F401'
g:ale_python_ruff_format_use_global *g:ale_python_ruff_format_use_global*
*b:ale_python_ruff_format_use_global*
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_python_ruff_format_auto_pipenv *g:ale_python_ruff_format_auto_pipenv*
*b:ale_python_ruff_format_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.
g:ale_python_ruff_format_auto_poetry *g:ale_python_ruff_format_auto_poetry*
*b:ale_python_ruff_format_auto_poetry*
Type: |Number|
Default: `0`
Detect whether the file is inside a poetry, and set the executable to `poetry`
if true. This is overridden by a manually-set executable.
===============================================================================
unimport *ale-python-unimport*

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

@ -48,6 +48,26 @@ g:ale_ruby_debride_options *g:ale_ruby_debride_options*
This variable can be changed to modify flags given to debride.
===============================================================================
packwerk *ale-ruby-packwerk*
g:ale_ruby_packwerk_executable *g:ale_ruby_packwerk_executable*
*b:ale_ruby_packwerk_executable*
Type: |String|
Default: `'packwerk'`
Override the invoked packwerk binary. Set this to `'bundle'` to invoke
`'bundle` `exec` packwerk'.
g:ale_ruby_packwerk_options *g:ale_ruby_packwerk_options*
*b:ale_ruby_packwerk_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to packwerk.
===============================================================================
prettier *ale-ruby-prettier*

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

@ -33,11 +33,12 @@ Integration Information
5. rustfmt -- If you have `rustfmt` installed, you can use it as a fixer to
consistently reformat your Rust code.
Only cargo and rls are enabled by default. To switch to using rustc instead
of cargo, configure |g:ale_linters| appropriately: >
Only cargo and rust-analyze are enabled by default. To switch to using rustc
instead of cargo, configure |b:ale_linters| in your ftplugin file
appropriately: >
" See the help text for the option for more information.
let g:ale_linters = {'rust': ['rustc', 'rls']}
let b:ale_linters = ['analyzer', 'rustc']
<
Also note that rustc 1.18. or later is needed.

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

@ -36,6 +36,15 @@ solium *ale-solidity-solium*
See the corresponding solium usage for detailed instructions
(https://github.com/duaraghav8/Solium#usage).
===============================================================================
forge *ale-solidity-forge*
`forge fmt` is not a linter, only a formatter. It should be used only as a
fixer.
`forge fmt` should work out-of-the-box. You can further configure it using
`foundry.toml`. See the corresponding documentation for detailed
instructions (https://book.getfoundry.sh/reference/config/formatter).
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

8
sources_non_forked/ale/doc/ale-supported-languages-and-tools.txt
View File

@ -67,6 +67,7 @@ Notes:
* `ccls`
* `clang` (`cc`)
* `clang-format`
* `clangcheck`!!
* `clangd`
* `clangtidy`!!
* `cppcheck`
@ -101,6 +102,7 @@ Notes:
* `gcc` (`cc`)
* `uncrustify`
* Cairo
* `scarb`!!
* `starknet`
* Chef
* `cookstyle`
@ -168,6 +170,7 @@ Notes:
* `dialyxir`
* `dogma`!!
* `elixir-ls`
* `lexical`
* `mix`!!
* Elm
* `elm-format`
@ -380,6 +383,8 @@ Notes:
* `mmc`!!
* NASM
* `nasm`!!
* Nickel
* `nickel_format`
* Nim
* `nim check`!!
* `nimlsp`
@ -504,6 +509,7 @@ Notes:
* `refurb`
* `reorder-python-imports`
* ruff
* ruff-format
* `unimport`
* `vulture`!!
* `yapf`
@ -546,6 +552,7 @@ Notes:
* `brakeman`!!
* `cspell`
* `debride`
* `packwerk`!!
* `prettier`
* `rails_best_practices`!!
* `reek`
@ -586,6 +593,7 @@ Notes:
* SML
* `smlnj`
* Solidity
* `forge`
* `solc`
* `solhint`
* `solium`

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

@ -42,8 +42,8 @@ g:ale_deno_unstable *g:ale_deno_unstable*
Enable or disable unstable Deno features and APIs.
g:ale_deno_importMap *g:ale_deno_importMap*
*b:ale_deno_importMap*
g:ale_deno_import_map *g:ale_deno_import_map*
*b:ale_deno_import_map*
Type: |String|
Default: `'import_map.json'`

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

@ -121,7 +121,7 @@ circumstances.
ALE will report problems with your code in the following ways, listed with
their relevant options.
* Via the Neovim diagnostics API (Off by default) - |g:ale_use_neovim_diagnostics_api|
* Via Neovim diagnostics (On in Neovim 0.6+) - |g:ale_use_neovim_diagnostics_api|
* By updating loclist. (On by default) - |g:ale_set_loclist|
* By updating quickfix. (Off by default) - |g:ale_set_quickfix|
* By setting error highlights. - |g:ale_set_highlights|
@ -455,6 +455,11 @@ If you want to use another plugin for LSP features and tsserver, you can use
the |g:ale_disable_lsp| setting to disable ALE's own LSP integrations, or
ignore particular linters with |g:ale_linters_ignore|.
If for any reason you want to stop a language server ALE starts, such as when
a project configuration has significantly changed, or new files have been
added the language server isn't aware of, use either |ALEStopLSP| or
|ALEStopAllLSPs| to stop the server until ALE automatically starts it again.
-------------------------------------------------------------------------------
5.1 Completion *ale-completion*
@ -737,6 +742,7 @@ You may wish to remove some other menu items you don't want to see: >
===============================================================================
6. Global Options *ale-options*
g:airline#extensions#ale#enabled *g:airline#extensions#ale#enabled*
Type: |Number|
@ -815,7 +821,6 @@ g:ale_command_wrapper *g:ale_command_wrapper*
" Has the same effect as the above.
let g:ale_command_wrapper = 'nice -n5 %*'
<
For passing all of the arguments for a command as one argument to a wrapper,
`%@` can be used instead. >
@ -840,7 +845,6 @@ g:ale_completion_delay *g:ale_completion_delay*
g:ale_completion_enabled *g:ale_completion_enabled*
*b:ale_completion_enabled*
Type: |Number|
Default: `0`
@ -881,7 +885,7 @@ g:ale_completion_autoimport *g:ale_completion_autoimport*
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
disabling automatic imports may drop some or all completion items returned
by it (e.g. eclipselsp).
@ -906,7 +910,7 @@ g:ale_completion_excluded_words *g:ale_completion_excluded_words*
g:ale_completion_symbols *g:ale_completion_symbols*
Type: |Dictionary|
Default: See `autoload/ale/completion.vim`
A mapping from completion types to symbols for completions. See
|ale-symbols| for more information.
@ -960,6 +964,7 @@ g:ale_completion_max_suggestions *g:ale_completion_max_suggestions*
Adjust this option as needed, depending on the complexity of your codebase
and your available processing power.
g:ale_cursor_detail *g:ale_cursor_detail*
Type: |Number|
@ -984,7 +989,6 @@ g:ale_cursor_detail *g:ale_cursor_detail*
g:ale_default_navigation *g:ale_default_navigation*
*b:ale_default_navigation*
Type: |String|
Default: `'buffer'`
@ -1003,12 +1007,16 @@ g:ale_detail_to_floating_preview *g:ale_detail_to_floating_preview*
g:ale_disable_lsp *g:ale_disable_lsp*
*b:ale_disable_lsp*
Type: |Number| OR |String|
Default: `'auto'`
Type: |Number|
Default: `0`
When this option is set to `'auto'`, ALE will automatically disable linters
that it detects as having already been configured with the nvim-lspconfig
plugin. When this option is set to `1`, ALE ignores all linters powered by
LSP, and also `tsserver`.
When this option is set to `1`, ALE ignores all linters powered by LSP,
and also `tsserver`.
Any linters that are disabled will also not be usable for LSP functionality
other than just linting.
Please see also |ale-lsp|.
@ -1054,7 +1062,6 @@ g:ale_echo_msg_error_str *g:ale_echo_msg_error_str*
g:ale_echo_msg_format *g:ale_echo_msg_format*
*b:ale_echo_msg_format*
Type: |String|
Default: `'%code: %%s'`
@ -1113,7 +1120,6 @@ g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str*
g:ale_enabled *g:ale_enabled*
*b:ale_enabled*
Type: |Number|
Default: `1`
@ -1128,16 +1134,16 @@ g:ale_enabled *g:ale_enabled*
" Disable linting for all minified JS files.
let g:ale_pattern_options = {'\.min.js$': {'ale_enabled': 0}}
<
See |g:ale_pattern_options| for more information on that option.
g:ale_exclude_highlights *g:ale_exclude_highlights*
*b:ale_exclude_highlights*
Type: |List|
Default: `[]`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
A list of regular expressions for matching against highlight messages to
remove. For example: >
@ -1149,7 +1155,6 @@ g:ale_exclude_highlights *g:ale_exclude_highlights*
g:ale_fixers *g:ale_fixers*
*b:ale_fixers*
Type: |Dictionary|
Default: `{}`
@ -1171,7 +1176,6 @@ g:ale_fixers *g:ale_fixers*
g:ale_fix_on_save *g:ale_fix_on_save*
*b:ale_fix_on_save*
Type: |Number|
Default: `0`
@ -1193,7 +1197,6 @@ g:ale_fix_on_save *g:ale_fix_on_save*
g:ale_fix_on_save_ignore *g:ale_fix_on_save_ignore*
*b:ale_fix_on_save_ignore*
Type: |Dictionary| or |List|
Default: `{}`
@ -1241,11 +1244,12 @@ g:ale_floating_preview_popup_opts *g:ale_floating_preview_popup_opts*
Type: |String| or |Dictionary|
Default: `''`
Either a dictionary of options or the string name of a function that returns a
dictionary of options. This will be used as an argument to |popup_create| for
Vim users or |nvim_open_win| for NeoVim users. Note that in either case, the
resulting dictionary is merged with ALE defaults rather than expliciting overriding
them. This only takes effect if |g:ale_floating_preview| is enabled.
Either a dictionary of options or the string name of a function that returns
a dictionary of options. This will be used as an argument to |popup_create|
for Vim users or |nvim_open_win| for NeoVim users. In either case, the
resulting dictionary is merged with ALE defaults rather than explicitly
overriding them. This only takes effect if |g:ale_floating_preview| is
enabled.
NOTE: for Vim users see |popup_create-arguments|, for NeoVim users see
|nvim_open_win| for argument details
@ -1260,23 +1264,22 @@ g:ale_floating_preview_popup_opts *g:ale_floating_preview_popup_opts*
let g:ale_floating_preview_popup_opts = 'g:CustomOpts'
<
g:ale_floating_window_border *g:ale_floating_window_border*
Type: |List|
Default: `['|', '-', '+', '+', '+', '+', '|', '-']`
When set to `[]`, window borders are disabled. The elements in the list set
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.
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.
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.
elements for the right side and bottom, the left side and top will be used
instead.
g:ale_history_enabled *g:ale_history_enabled*
@ -1346,6 +1349,15 @@ g:ale_hover_to_floating_preview *g:ale_hover_to_floating_preview*
hover messages.
g:ale_info_default_mode *g:ale_info_default_mode*
*b:ale_info_default_mode*
Type: |String|
Default: `'preview'`
Changes the default mode used for |ALEInfo|. See documentation for |ALEInfo|
for more information.
g:ale_keep_list_window_open *g:ale_keep_list_window_open*
*b:ale_keep_list_window_open*
Type: |Number|
@ -1457,7 +1469,6 @@ g:ale_lint_on_text_changed *g:ale_lint_on_text_changed*
g:ale_lint_on_insert_leave *g:ale_lint_on_insert_leave*
*b:ale_lint_on_insert_leave*
Type: |Number|
Default: `1`
@ -1545,7 +1556,6 @@ g:ale_linter_aliases *g:ale_linter_aliases*
g:ale_filename_mappings *g:ale_filename_mappings*
*b:ale_filename_mappings*
Type: |Dictionary| or |List|
Default: `{}`
@ -1653,7 +1663,7 @@ g:ale_linters *g:ale_linters*
\ 'perl': ['perlcritic'],
\ 'perl6': [],
\ 'python': ['flake8', 'mypy', 'pylint', 'pyright', 'ruff'],
\ 'rust': ['cargo', 'rls'],
\ 'rust': ['analyzer', 'cargo'],
\ 'spec': [],
\ 'text': [],
\ 'vader': ['vimls'],
@ -1713,7 +1723,6 @@ g:ale_linters_explicit *g:ale_linters_explicit*
g:ale_linters_ignore *g:ale_linters_ignore*
*b:ale_linters_ignore*
Type: |Dictionary| or |List|
Default: `{}`
@ -1749,7 +1758,6 @@ g:ale_list_vertical *g:ale_list_vertical*
g:ale_loclist_msg_format *g:ale_loclist_msg_format*
*b:ale_loclist_msg_format*
Type: |String|
Default: `g:ale_echo_msg_format`
@ -1826,6 +1834,8 @@ g:ale_max_signs *g:ale_max_signs*
Type: |Number|
Default: `-1`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
When set to any positive integer, ALE will not render any more than the
given number of signs for any one buffer.
@ -1946,7 +1956,6 @@ g:ale_rename_tsserver_find_in_comments *g:ale_rename_tsserver_find_in_comments*
g:ale_rename_tsserver_find_in_strings *g:ale_rename_tsserver_find_in_strings*
Type: |Number|
Default: `0`
@ -1957,7 +1966,6 @@ g:ale_rename_tsserver_find_in_strings *g:ale_rename_tsserver_find_in_strings*
g:ale_root *g:ale_root*
*b:ale_root*
Type: |Dictionary| or |String|
Default: `{}`
@ -1974,9 +1982,18 @@ g:ale_root *g:ale_root*
LSP linter, it will not run.
g:ale_save_hidden *g:ale_save_hidden*
Type: |Number|
Default: `0`
When set to `1`, save buffers when 'hidden' is set when applying code
actions or rename operations, such as through |ALERename| or
|ALEOrganizeImports|.
g:ale_set_balloons *g:ale_set_balloons*
*b:ale_set_balloons*
Type: |Number| or |String|
Default: `has('balloon_eval') && has('gui_running')`
@ -1994,7 +2011,6 @@ g:ale_set_balloons *g:ale_set_balloons*
let g:ale_set_balloons = has('gui_running') ? 'hover' : 0
<
Balloons can be enabled for terminal versions of Vim that support balloons,
but some versions of Vim will produce strange mouse behavior when balloons
are enabled. To configure balloons for your terminal, you should first
@ -2028,6 +2044,11 @@ g:ale_set_highlights *g:ale_set_highlights*
Type: |Number|
Default: `has('syntax')`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
In addition, ALE's highlight groups will not be used when setting
highlights through Neovim's diagnostics API. See |diagnostic-highlights| for
how to configure Neovim diagnostic highlighting.
When this option is set to `1`, highlights will be set for problems.
ALE will use the following highlight groups for problems:
@ -2088,6 +2109,12 @@ g:ale_set_signs *g:ale_set_signs*
When this option is set to `1`, the |sign| column will be populated with
signs marking where problems appear in the file.
When |g:ale_use_neovim_diagnostics_api| is `1`, the only other setting that
will be respected for signs is |g:ale_sign_priority|. ALE's highlight groups
will and other sign settings will not apply when setting signs through
Neovim's diagnostics API. See |diagnostic-signs| for how to configure signs
in Neovim.
ALE will use the following highlight groups for problems:
|ALEErrorSign| - Items with `'type': 'E'`
@ -2141,7 +2168,6 @@ g:ale_sign_priority *g:ale_sign_priority*
g:ale_shell *g:ale_shell*
*b:ale_shell*
Type: |String|
Default: not set
@ -2159,7 +2185,6 @@ g:ale_shell *g:ale_shell*
g:ale_shell_arguments *g:ale_shell_arguments*
*b:ale_shell_arguments*
Type: |String|
Default: not set
@ -2173,6 +2198,8 @@ g:ale_sign_column_always *g:ale_sign_column_always*
Type: |Number|
Default: `0`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
By default, the sign gutter will disappear when all warnings and errors have
been fixed for a file. When this option is set to `1`, the sign column will
remain open. This can be preferable if you don't want the text in your file
@ -2182,7 +2209,9 @@ g:ale_sign_column_always *g:ale_sign_column_always*
g:ale_sign_error *g:ale_sign_error*
Type: |String|
Default: `'>>'`
Default: `'E'`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
The sign for errors in the sign gutter.
@ -2190,7 +2219,9 @@ g:ale_sign_error *g:ale_sign_error*
g:ale_sign_info *g:ale_sign_info*
Type: |String|
Default: `g:ale_sign_warning`
Default: `'I'`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
The sign for "info" markers in the sign gutter.
@ -2200,6 +2231,8 @@ g:ale_sign_style_error *g:ale_sign_style_error*
Type: |String|
Default: `g:ale_sign_error`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
The sign for style errors in the sign gutter.
@ -2208,6 +2241,8 @@ g:ale_sign_style_warning *g:ale_sign_style_warning*
Type: |String|
Default: `g:ale_sign_warning`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
The sign for style warnings in the sign gutter.
@ -2216,6 +2251,8 @@ g:ale_sign_offset *g:ale_sign_offset*
Type: |Number|
Default: `1000000`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
This variable controls offset from which numeric IDs will be generated for
new signs. Signs cannot share the same ID values, so when two Vim plugins
set signs at the same time, the IDs have to be configured such that they do
@ -2228,7 +2265,9 @@ g:ale_sign_offset *g:ale_sign_offset*
g:ale_sign_warning *g:ale_sign_warning*
Type: |String|
Default: `'--'`
Default: `'W'`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
The sign for warnings in the sign gutter.
@ -2238,6 +2277,8 @@ g:ale_sign_highlight_linenrs *g:ale_sign_highlight_linenrs*
Type: |Number|
Default: `0`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
When set to `1`, this option enables highlighting problems on the 'number'
column in Vim versions that support `numhl` highlights. This option must be
configured before ALE is loaded.
@ -2295,16 +2336,13 @@ g:ale_use_global_executables *g:ale_use_global_executables*
g:ale_use_neovim_diagnostics_api *g:ale_use_neovim_diagnostics_api*
Type: |Number|
Default: `0`
Default: `has('nvim-0.6')`
If enabled, this option will disable ALE's standard UI, and instead send
all linter output to Neovim's diagnostics API. This allows you to collect
errors from nvim-lsp, ALE, and anything else that uses diagnostics all in
one place. The following options are ignored when using the diagnostics API:
- |g:ale_set_highlights|
- |g:ale_set_signs|
- |g:ale_virtualtext_cursor|
one place. Many options for configuring how problems appear on the screen
will not apply when the API is enabled.
To enable this option, set the value to `1`.
@ -2324,11 +2362,17 @@ g:ale_virtualtext_cursor *g:ale_virtualtext_cursor*
`'current'`, `'1'`, or `1` - Show problems for the current line.
`'disabled'`, `'0'`, or `0` - Do not show problems with virtual-text.
When |g:ale_use_neovim_diagnostics_api| is `1`, `'current'` will behave the
same as `'all'`.
Messages are only displayed after a short delay. See |g:ale_virtualtext_delay|.
Messages can be prefixed with a string. See |g:ale_virtualtext_prefix|.
Messages can be prefixed with a string if not using Neovim's diagnostics
API. See |g:ale_virtualtext_prefix|.
ALE will use the following highlight groups for problems:
If and only if not displaying problems via Neovim's diagnostics API,
highlights for configuring ALE's virtualtext messages can be configured with
custom highlight groups:
|ALEVirtualTextError| - Items with `'type': 'E'`
|ALEVirtualTextWarning| - Items with `'type': 'W'`
@ -2342,6 +2386,8 @@ g:ale_virtualtext_delay *g:ale_virtualtext_delay*
Type: |Number|
Default: `10`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
Given any integer, this option controls the number of milliseconds before
ALE will show a message for a problem near the cursor.
@ -2354,6 +2400,8 @@ g:ale_virtualtext_prefix *g:ale_virtualtext_prefix*
Type: |String|
Default: `'%comment% %type%: '`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
Prefix to be used with |g:ale_virtualtext_cursor|.
This setting can be changed in each buffer with `b:ale_virtualtext_prefix`.
@ -2375,6 +2423,8 @@ g:ale_virtualtext_maxcolumn *g:ale_virtualtext_maxcolumn*
Type: |String| or |Number|
Default: `0`
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
Virtualtext column range, from `column` to `maxcolumn`. If a line is
`column` or less characters long, the virtualtext message is shifted right
to `column`.
@ -2390,23 +2440,28 @@ g:ale_virtualtext_maxcolumn *g:ale_virtualtext_maxcolumn*
When `column` is set to zero, column positioning is disabled, when `maxcolumn`
is set to zero, no maximum line length is enforced.
g:ale_virtualtext_single *g:ale_virtualtext_single*
*b:ale_virtualtext_single*
Type: |Number|
Default: `0`
Default: `1`
Enable or disable concatenation of multiple virtualtext messages on a single
line. By default, if a line has multiple errors or warnings, each will be
This setting has no effect when |g:ale_use_neovim_diagnostics_api| is `1`.
Enable or disable concatenation of multiple virtual text messages on a single
line. By default, if a line has multiple errors or warnings, each will be
appended in turn.
With `single` set to a non-zero value, only the first message appears.
(No attempt is made to prefer message types such as errors over warnings)
With `single` set to a non-zero value, only the first problem on a line will
be printed with virtual text. The most severe problem on a line will be
printed. If two problems exist on a line of equal severity, the problem at
the left-most position will be printed.
g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
*b:ale_virtualenv_dir_names*
Type: |List|
Default: `['.env', '.venv', 'env', 've-py3', 've', 'virtualenv', 'venv']`
Default: `['.venv', 'env', 've', 'venv', 'virtualenv', '.env']`
A list of directory names to be used when searching upwards from Python
files to discover virtualenv directories with.
@ -2418,7 +2473,6 @@ g:ale_virtualenv_dir_names *g:ale_virtualenv_dir_names*
g:ale_warn_about_trailing_blank_lines *g:ale_warn_about_trailing_blank_lines*
*b:ale_warn_about_trailing_blank_lines*
Type: |Number|
Default: `1`
@ -2430,7 +2484,6 @@ g:ale_warn_about_trailing_blank_lines *g:ale_warn_about_trailing_blank_lines*
g:ale_warn_about_trailing_whitespace *g:ale_warn_about_trailing_whitespace*
*b:ale_warn_about_trailing_whitespace*
Type: |Number|
Default: `1`
@ -2447,7 +2500,6 @@ g:ale_warn_about_trailing_whitespace *g:ale_warn_about_trailing_whitespace*
g:ale_windows_node_executable_path *g:ale_windows_node_executable_path*
*b:ale_windows_node_executable_path*
Type: |String|
Default: `'node.exe'`
@ -2866,6 +2918,7 @@ documented in additional help files.
astyle................................|ale-c-astyle|
cc....................................|ale-c-cc|
ccls..................................|ale-c-ccls|
clangcheck............................|ale-c-clangcheck|
clangd................................|ale-c-clangd|
clang-format..........................|ale-c-clangformat|
clangtidy.............................|ale-c-clangtidy|
@ -2875,6 +2928,7 @@ documented in additional help files.
flawfinder............................|ale-c-flawfinder|
uncrustify............................|ale-c-uncrustify|
cairo...................................|ale-cairo-options|
scarb.................................|ale-cairo-scarb|
starknet..............................|ale-cairo-starknet|
chef....................................|ale-chef-options|
cookstyle.............................|ale-chef-cookstyle|
@ -2951,6 +3005,7 @@ documented in additional help files.
elixir-ls.............................|ale-elixir-elixir-ls|
credo.................................|ale-elixir-credo|
cspell................................|ale-elixir-cspell|
lexical...............................|ale-elixir-lexical|
elm.....................................|ale-elm-options|
elm-format............................|ale-elm-elm-format|
elm-ls................................|ale-elm-elm-ls|
@ -3134,6 +3189,8 @@ documented in additional help files.
mmc...................................|ale-mercury-mmc|
nasm....................................|ale-nasm-options|
nasm..................................|ale-nasm-nasm|
nickel..................................|ale-nickel-options|
nickel_format.........................|ale-nickel-nickel-format|
nim.....................................|ale-nim-options|
nimcheck..............................|ale-nim-nimcheck|
nimlsp................................|ale-nim-nimlsp|
@ -3250,6 +3307,7 @@ documented in additional help files.
refurb................................|ale-python-refurb|
reorder-python-imports................|ale-python-reorder_python_imports|
ruff..................................|ale-python-ruff|
ruff-format...........................|ale-python-ruff-format|
unimport..............................|ale-python-unimport|
vulture...............................|ale-python-vulture|
yapf..................................|ale-python-yapf|
@ -3281,6 +3339,7 @@ documented in additional help files.
brakeman..............................|ale-ruby-brakeman|
cspell................................|ale-ruby-cspell|
debride...............................|ale-ruby-debride|
packwerk..............................|ale-ruby-packwerk|
prettier..............................|ale-ruby-prettier|
rails_best_practices..................|ale-ruby-rails_best_practices|
reek..................................|ale-ruby-reek|
@ -3326,6 +3385,7 @@ documented in additional help files.
solc..................................|ale-solidity-solc|
solhint...............................|ale-solidity-solhint|
solium................................|ale-solidity-solium|
forge.................................|ale-solidity-forge|
spec....................................|ale-spec-options|
rpmlint...............................|ale-spec-rpmlint|
sql.....................................|ale-sql-options|
@ -3645,14 +3705,15 @@ 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.
The rename operation will not save modified buffers when 'hidden' is on
unless |g:ale_save_hidden| is `1`.
ALEFileRename *ALEFileRename*
Rename a file and fix imports using `tsserver`.
ALECodeAction *ALECodeAction*
Apply a code action via LSP servers or `tsserver`.
@ -3825,7 +3886,7 @@ ALEDetail *ALEDetail*
*:ALEInfo*
ALEInfo *ALEInfo*
ALEInfoToClipboard *ALEInfoToClipboard*
*ALEInfoToFile*
Print runtime information about ALE, including the values of global and
buffer-local settings for ALE, the linters that are enabled, the commands
@ -3837,8 +3898,17 @@ ALEInfoToClipboard *ALEInfoToClipboard*
|g:ale_history_log_output| to `1` to enable logging of output for commands.
ALE will only log the output captured for parsing problems, etc.
The command `:ALEInfoToClipboard` can be used to output ALEInfo directly to
your clipboard. This might not work on every machine.
You can pass options to the command to control how ALE displays the
information, such as `:ALEInfo -echo`, etc. >
-preview Show the info in a preview window.
-clip OR -clipboard Copy the information to your clipboard.
-echo echo all of the information with :echo
<
The default mode can be configured with |g:ale_info_default_mode|.
When shown in a preview window, syntax highlights can be defined for the
`ale-info` filetype.
`:ALEInfoToFile` will write the ALE runtime information to a given filename.
The filename works just like |:w|.
@ -3871,6 +3941,17 @@ ALEStopAllLSPs *ALEStopAllLSPs*
This command can be used when LSP clients mess up and need to be restarted.
ALEStopLSP `linter_name` *ALEStopLSP*
`ALEStopLSP` will stop a specific language server with a given linter name.
Completion is supported for currently running language servers. All language
servers with the given name will be stopped across all buffers for all
projects.
If the command is run with a bang (`:ALEStopLSP!`), all warnings will be
suppressed.
===============================================================================
9. API *ale-api*