summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRyanSquared <vandor2012@gmail.com>2020-05-05 09:21:49 -0500
committerRyanSquared <vandor2012@gmail.com>2020-05-05 09:21:49 -0500
commit70005134e5b2d40d176ee5b851ac64a296b22201 (patch)
tree097c07a596e3c6641ab65fef9e2cdc46151c1d07 /doc
parent36e5337e30095afb10d02ef2ae362c8d6055e70d (diff)
parent6087765cad9271a54d3a29c0c0e6582332461451 (diff)
downloadale-70005134e5b2d40d176ee5b851ac64a296b22201.zip
Merge branch 'rust-analyzer' of https://github.com/jonhoo/ale into jonhoo-rust-analyzer
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-rust.txt28
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale.txt1
3 files changed, 28 insertions, 2 deletions
diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt
index 44a79b18..46d4714b 100644
--- a/doc/ale-rust.txt
+++ b/doc/ale-rust.txt
@@ -9,7 +9,7 @@ Integration Information
files for Rust distributed in Vim >=8.0.0501 or upstream:
https://github.com/rust-lang/rust.vim
- Note that there are three possible linters for Rust files:
+ Note that there are several possible linters and fixers for Rust files:
1. rustc -- The Rust compiler is used to check the currently edited file.
So, if your project consists of multiple files, you will get some errors
@@ -23,7 +23,12 @@ Integration Information
over cargo. rls implements the Language Server Protocol for incremental
compilation of Rust code, and can check Rust files while you type. `rls`
requires Rust files to contained in Cargo projects.
- 4. rustfmt -- If you have `rustfmt` installed, you can use it as a fixer to
+ 4. analyzer -- If you have rust-analyzer installed, you might prefer using
+ this linter over cargo and rls. rust-analyzer also implements the
+ Language Server Protocol for incremental compilation of Rust code, and is
+ the next iteration of rls. rust-analyzer, like rls, requires Rust files
+ to contained in Cargo projects.
+ 5. rustfmt -- If you have `rustfmt` installed, you can use it as a fixer to
consistently reformat your Rust code.
Only cargo is enabled by default. To switch to using rustc instead of cargo,
@@ -37,6 +42,25 @@ Integration Information
===============================================================================
+analyzer *ale-rust-analyzer*
+
+g:ale_rust_analyzer_executable *g:ale_rust_analyzer_executable*
+ *b: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*
+ *b:ale_rust_analyzer_config*
+ Type: |Dictionary|
+ Default: `{}`
+
+ Dictionary with configuration settings for rust-analyzer.
+
+===============================================================================
cargo *ale-rust-cargo*
g:ale_rust_cargo_use_check *g:ale_rust_cargo_use_check*
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 636985fb..1ca06c47 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -408,6 +408,7 @@ Notes:
* Rust
* `cargo`!!
* `rls`
+ * `rust-analyzer`
* `rustc` (see |ale-integration-rust|)
* `rustfmt`
* Sass
diff --git a/doc/ale.txt b/doc/ale.txt
index 16b204a4..53ec69fc 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2579,6 +2579,7 @@ documented in additional help files.
sorbet................................|ale-ruby-sorbet|
standardrb............................|ale-ruby-standardrb|
rust....................................|ale-rust-options|
+ analyzer..............................|ale-rust-analyzer|
cargo.................................|ale-rust-cargo|
rls...................................|ale-rust-rls|
rustc.................................|ale-rust-rustc|