Skip to content

Commit

Permalink
Add support for rust-analyzer
Browse files Browse the repository at this point in the history
Fixes #2832
  • Loading branch information
jonhoo committed Oct 16, 2019
1 parent 7c5825e commit f5c289d
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 0 deletions.
24 changes: 24 additions & 0 deletions ale_linters/rust/analyzer.vim
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
" Author: Jon Gjengset <jon@thesquareplanet.com>
" Description: The next generation language server for Rust

call ale#Set('rust_analyzer_executable', 'ra_lsp_server')
call ale#Set('rust_analyzer_config', {})

function! ale_linters#rust#analyzer#GetCommand(buffer) abort
return '%e'
endfunction

function! ale_linters#rust#analyzer#GetProjectRoot(buffer) abort
let l:cargo_file = ale#path#FindNearestFile(a:buffer, 'Cargo.toml')

return !empty(l:cargo_file) ? fnamemodify(l:cargo_file, ':h') : ''
endfunction

call ale#linter#Define('rust', {
\ 'name': 'rust-analyzer',
\ 'lsp': 'stdio',
\ 'lsp_config': {b -> ale#Var(b, 'rust_analyzer_config')},
\ 'executable': {b -> ale#Var(b, 'rust_analyzer_executable')},
\ 'command': function('ale_linters#rust#analyzer#GetCommand'),
\ 'project_root': function('ale_linters#rust#analyzer#GetProjectRoot'),
\})
24 changes: 24 additions & 0 deletions doc/ale-rust.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ 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.
3. 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.
4. rustfmt -- If you have `rustfmt` installed, you can use it as a fixer to
consistently reformat your Rust code.

Expand Down Expand Up @@ -190,6 +195,25 @@ g:ale_rust_rls_config *g:ale_rust_rls_config*
\ }
===============================================================================
analyzer *ale-rust-analyzer*

g:ale_rust_analyzer_executable *g:ale_rust_analyzer_executable*
*b:ale_rust_analyzer_executable*
Type: |String|
Default: `'ra_lsp_server'`

This comment has been minimized.

Copy link
@alok

alok May 5, 2020

I thought RA changed the binary name to rust-analyzer recently?

This comment has been minimized.

Copy link
@jonhoo

jonhoo May 5, 2020

Author Contributor

You're looking at just one commit. If you look at the full PR (#2837) you'll see that that change was already made :)

This comment has been minimized.

Copy link
@alok

alok May 5, 2020

Noticed it a second too late. D'oh.


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.

===============================================================================
rustc *ale-rust-rustc*

Expand Down
1 change: 1 addition & 0 deletions doc/ale.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2411,6 +2411,7 @@ documented in additional help files.
rust....................................|ale-rust-options|
cargo.................................|ale-rust-cargo|
rls...................................|ale-rust-rls|
rust-analyzer.........................|ale-rust-analyzer|
rustc.................................|ale-rust-rustc|
rustfmt...............................|ale-rust-rustfmt|
sass....................................|ale-sass-options|
Expand Down
1 change: 1 addition & 0 deletions supported-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,7 @@ formatting.
* Rust
* [cargo](https://github.com/rust-lang/cargo) :floppy_disk: (see `:help ale-integration-rust` for configuration instructions)
* [rls](https://github.com/rust-lang-nursery/rls) :warning:
* [rust-analyzer](https://github.com/rust-analyzer/rust-analyzer) :warning:
* [rustc](https://www.rust-lang.org/) :warning:
* [rustfmt](https://github.com/rust-lang-nursery/rustfmt)
* Sass
Expand Down
20 changes: 20 additions & 0 deletions test/command_callback/test_rust_analyzer_callbacks.vader
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Before:
call ale#assert#SetUpLinterTest('rust', 'analyzer')

After:
call ale#assert#TearDownLinterTest()

Execute(The default executable path should be correct):
AssertLinter 'analyzer', ale#Escape('ra_lsp_server')

Execute(The project root should be detected correctly):
AssertLSPProject ''

call ale#test#SetFilename('rust-rls-project/test.rs')

AssertLSPProject ale#path#Simplify(g:dir . '/rust-rls-project')

Execute(Should accept configuration settings):
AssertLSPConfig {}
let b:ale_rust_analyzer_config = {'rust': {'clippy_preference': 'on'}}
AssertLSPConfig {'rust': {'clippy_preference': 'on'}}

0 comments on commit f5c289d

Please sign in to comment.