VimPlug/ale
1
0
Fork 0
mirror of https://github.com/dense-analysis/ale.git synced 2026-05-16 21:45:07 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Implement Lua ALE setup & overhaul documentation

Browse Source 
1. Add ale.setup and ale.setup.buffer for pure Lua configuration.
2. Update many global settings to use Booleans instead of numbers to
   make types easiert to work with in Lua.
3. Radically reformat documentation and fix errors to make
   documentation more usable for Neovim users.
This commit is contained in:
w0rp
2025-03-20 21:33:12 +00:00
parent 53f036fe9f
commit bcd1a12949
146 changed files with 5469 additions and 2642 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/ale-rust.txt
+110 -54
View File
@@ -40,35 +40,43 @@ Integration Information
" See the help text for the option for more information.
let b:ale_linters = ['analyzer', 'rustc']
<
Or in Lua: >
require("ale").setup.buffer({linters = {"analyzer", "rustc"}})
<
Also note that rustc 1.18. or later is needed.
===============================================================================
analyzer *ale-rust-analyzer*
g:ale_rust_analyzer_executable *g:ale_rust_analyzer_executable*
*ale-options.rust_analyzer_executable*
*g:ale_rust_analyzer_executable*
*b:ale_rust_analyzer_executable*
rust_analyzer_executable
g:ale_rust_analyzer_executable
Type: |String|
Default: `'rust-analyzer'`
This variable can be modified to change the executable path for
`rust-analyzer`.
g:ale_rust_analyzer_config *g:ale_rust_analyzer_config*
*ale-options.rust_analyzer_config*
*g:ale_rust_analyzer_config*
*b:ale_rust_analyzer_config*
rust_analyzer_config
g:ale_rust_analyzer_config
Type: |Dictionary|
Default: `{}`
Dictionary with configuration settings for rust-analyzer. Keys of the
dictionary are components of configuration keys. For example:
>
let g:ale_rust_analyzer_config = {
\ 'server': {
\ 'extraEnv': { 'RUSTUP_TOOLCHAIN': 'stable' },
\ }
\}
dictionary are components of configuration keys. For example: >
let g:ale_rust_analyzer_config = {
\ 'server': {
\ 'extraEnv': { 'RUSTUP_TOOLCHAIN': 'stable' },
\ }
\}
<
corresponds to `rust-analyzer.server.extraEnv = { 'RUSTUP_TOOLCHAIN': 'stable' }`
@@ -76,11 +84,15 @@ g:ale_rust_analyzer_config *g:ale_rust_analyzer_config*
https://rust-analyzer.github.io/manual.html#configuration
===============================================================================
cargo *ale-rust-cargo*
g:ale_rust_cargo_use_check *g:ale_rust_cargo_use_check*
*ale-options.rust_cargo_use_check*
*g:ale_rust_cargo_use_check*
*b:ale_rust_cargo_use_check*
rust_cargo_use_check
g:ale_rust_cargo_use_check
Type: |Number|
Default: `1`
@@ -90,18 +102,22 @@ g:ale_rust_cargo_use_check *g:ale_rust_cargo_use_check*
ALE will never use `cargo check` when the version of `cargo` is less than
0.17.0.
g:ale_rust_cargo_check_all_targets *g:ale_rust_cargo_check_all_targets*
*ale-options.rust_cargo_check_all_targets*
*g:ale_rust_cargo_check_all_targets*
*b:ale_rust_cargo_check_all_targets*
rust_cargo_check_all_targets
g:ale_rust_cargo_check_all_targets
Type: |Number|
Default: `0`
When set to `1`, ALE will set the `--all-targets` option when `cargo check`
is used. See |g:ale_rust_cargo_use_check|,
g:ale_rust_cargo_check_tests *g:ale_rust_cargo_check_tests*
*ale-options.rust_cargo_check_tests*
*g:ale_rust_cargo_check_tests*
*b:ale_rust_cargo_check_tests*
rust_cargo_check_tests
g:ale_rust_cargo_check_tests
Type: |Number|
Default: `0`
@@ -109,9 +125,11 @@ g:ale_rust_cargo_check_tests *g:ale_rust_cargo_check_tests*
is used. This allows for linting of tests which are normally excluded.
See |g:ale_rust_cargo_use_check|,
g:ale_rust_cargo_check_examples *g:ale_rust_cargo_check_examples*
*ale-options.rust_cargo_check_examples*
*g:ale_rust_cargo_check_examples*
*b:ale_rust_cargo_check_examples*
rust_cargo_check_examples
g:ale_rust_cargo_check_examples
Type: |Number|
Default: `0`
@@ -119,10 +137,11 @@ g:ale_rust_cargo_check_examples *g:ale_rust_cargo_check_examples*
is used. This allows for linting of examples which are normally excluded.
See |g:ale_rust_cargo_use_check|,
g:ale_rust_cargo_default_feature_behavior
*ale-options.rust_cargo_default_feature_behavior*
*g:ale_rust_cargo_default_feature_behavior*
*b:ale_rust_cargo_default_feature_behavior*
rust_cargo_default_feature_behavior
g:ale_rust_cargo_default_feature_behavior
Type: |String|
Default: `default`
@@ -140,18 +159,22 @@ g:ale_rust_cargo_default_feature_behavior
invoking `cargo`, which will include all features defined in the project's
`Cargo.toml` file when performing the lint check.
g:ale_rust_cargo_include_features *g:ale_rust_cargo_include_features*
*ale-options.rust_cargo_include_features*
*g:ale_rust_cargo_include_features*
*b:ale_rust_cargo_include_features*
rust_cargo_include_features
g:ale_rust_cargo_include_features
Type: |String|
Default: `''`
When defined, ALE will set the `--features` option when invoking `cargo` to
perform the lint check. See |g:ale_rust_cargo_default_feature_behavior|.
g:ale_rust_cargo_avoid_whole_workspace *g:ale_rust_cargo_avoid_whole_workspace*
*ale-options.rust_cargo_avoid_whole_workspace*
*g:ale_rust_cargo_avoid_whole_workspace*
*b:ale_rust_cargo_avoid_whole_workspace*
rust_cargo_avoid_whole_workspace
g:ale_rust_cargo_avoid_whole_workspace
Type: |Number|
Default: `1`
@@ -159,9 +182,11 @@ g:ale_rust_cargo_avoid_whole_workspace *g:ale_rust_cargo_avoid_whole_workspace*
workspace, avoid building the entire workspace by invoking `cargo` directly
in the crate's directory. Otherwise, behave as usual.
g:ale_rust_cargo_use_clippy *g:ale_rust_cargo_use_clippy*
*ale-options.rust_cargo_use_clippy*
*g:ale_rust_cargo_use_clippy*
*b:ale_rust_cargo_use_clippy*
rust_cargo_use_clippy
g:ale_rust_cargo_use_clippy
Type: |Number|
Default: `0`
@@ -176,10 +201,11 @@ g:ale_rust_cargo_use_clippy *g:ale_rust_cargo_use_clippy*
>
let g:ale_rust_cargo_use_clippy = executable('cargo-clippy')
<
g:ale_rust_cargo_clippy_options *g:ale_rust_cargo_clippy_options*
*ale-options.rust_cargo_clippy_options*
*g:ale_rust_cargo_clippy_options*
*b:ale_rust_cargo_clippy_options*
rust_cargo_clippy_options
g:ale_rust_cargo_clippy_options
Type: |String|
Default: `''`
@@ -187,10 +213,11 @@ g:ale_rust_cargo_clippy_options *g:ale_rust_cargo_clippy_options*
it. This variable is useful when you want to add some extra options which
only `cargo clippy` supports (e.g. `--deny`).
g:ale_rust_cargo_target_dir *g:ale_rust_cargo_target_dir*
*ale-options.rust_cargo_target_dir*
*g:ale_rust_cargo_target_dir*
*b:ale_rust_cargo_target_dir*
rust_cargo_target_dir
g:ale_rust_cargo_target_dir
Type: |String|
Default: `''`
@@ -208,16 +235,21 @@ See |ale-cspell-options|
===============================================================================
rls *ale-rust-rls*
g:ale_rust_rls_executable *g:ale_rust_rls_executable*
*ale-options.rust_rls_executable*
*g:ale_rust_rls_executable*
*b:ale_rust_rls_executable*
rust_rls_executable
g:ale_rust_rls_executable
Type: |String|
Default: `'rls'`
This variable can be modified to change the executable path for `rls`.
g:ale_rust_rls_toolchain *g:ale_rust_rls_toolchain*
*ale-options.rust_rls_toolchain*
*g:ale_rust_rls_toolchain*
*b:ale_rust_rls_toolchain*
rust_rls_toolchain
g:ale_rust_rls_toolchain
Type: |String|
Default: `''`
@@ -230,27 +262,42 @@ g:ale_rust_rls_toolchain *g:ale_rust_rls_toolchain*
The `rls` server will only be started once per executable.
g:ale_rust_rls_config *g:ale_rust_rls_config*
*ale-options.rust_rls_config*
*g:ale_rust_rls_config*
*b:ale_rust_rls_config*
rust_rls_config
g:ale_rust_rls_config
Type: |Dictionary|
Default: `{}`
Dictionary with configuration settings for rls. For example, to force
using clippy as linter: >
{
\ 'rust': {
\ 'clippy_preference': 'on'
\ }
\ }
using clippy as linter in your ftplugin file: >
let b:ale_rust_rls_config = {
\ 'rust': {
\ 'clippy_preference': 'on'
\ },
\}
<
Or in Lua: >
require("ale").setup.buffer({
rust_rls_config = {
rust = {
clippy_preference = "on",
},
},
})
<
===============================================================================
rustc *ale-rust-rustc*
g:ale_rust_rustc_options *g:ale_rust_rustc_options*
*ale-options.rust_rustc_options*
*g:ale_rust_rustc_options*
*b:ale_rust_rustc_options*
rust_rustc_options
g:ale_rust_rustc_options
Type: |String|
Default: `'--emit=mir -o /dev/null'`
@@ -260,20 +307,24 @@ g:ale_rust_rustc_options *g:ale_rust_rustc_options*
Be careful when setting the options, as running `rustc` could execute code
or generate binary files.
g:ale_rust_ignore_error_codes *g:ale_rust_ignore_error_codes*
*ale-options.rust_ignore_error_codes*
*g:ale_rust_ignore_error_codes*
*b:ale_rust_ignore_error_codes*
rust_ignore_error_codes
g:ale_rust_ignore_error_codes
Type: |List| of |String|s
Default: `[]`
This variable can contain error codes which will be ignored. For example, to
ignore most errors regarding failed imports, put this in your .vimrc
>
ignore most errors regarding failed imports, put this in your .vimrc >
let g:ale_rust_ignore_error_codes = ['E0432', 'E0433']
g:ale_rust_ignore_secondary_spans *g:ale_rust_ignore_secondary_spans*
<
*ale-options.rust_ignore_secondary_spans*
*g:ale_rust_ignore_secondary_spans*
*b:ale_rust_ignore_secondary_spans*
rust_ignore_secondary_spans
g:ale_rust_ignore_secondary_spans
Type: |Number|
Default: `0`
@@ -293,16 +344,21 @@ g:ale_rust_ignore_secondary_spans *g:ale_rust_ignore_secondary_spans*
===============================================================================
rustfmt *ale-rust-rustfmt*
g:ale_rust_rustfmt_options *g:ale_rust_rustfmt_options*
*ale-options.rust_rustfmt_options*
*g:ale_rust_rustfmt_options*
*b:ale_rust_rustfmt_options*
rust_rustfmt_options
g:ale_rust_rustfmt_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to the rustfmt fixer.
g:ale_rust_rustfmt_executable *g:ale_rust_rustfmt_executable*
*ale-options.rust_rustfmt_executable*
*g:ale_rust_rustfmt_executable*
*b:ale_rust_rustfmt_executable*
rust_rustfmt_executable
g:ale_rust_rustfmt_executable
Type: |String|
Default: `'rustfmt'`