Add support for `cargo clippy` (#2001)

* Add support for `cargo clippy`
* Add tests for cargo-clippy support
* Add an example to doc for how to configure ale_rust_cargo_use_clippy

1 files changed, 31 insertions, 0 deletions

diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt
index 13e5f6f0..ce5634ae 100644
--- a/doc/ale-rust.txt
+++ b/doc/ale-rust.txt
@@ -109,6 +109,7 @@ g:ale_rust_cargo_include_features           *g:ale_rust_cargo_include_features*
   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*
                                        *b:ale_rust_cargo_avoid_whole_workspace*
   Type: |Number|
@@ -119,6 +120,36 @@ g:ale_rust_cargo_avoid_whole_workspace *g:ale_rust_cargo_avoid_whole_workspace*
   in the crate's directory. Otherwise, behave as usual.
 
 
+g:ale_rust_cargo_use_clippy
+                                                  *g:ale_rust_cargo_use_clippy*
+                                                  *b:ale_rust_cargo_use_clippy*
+  Type: |Number|
+  Default: `0`
+
+  When set to 1, `cargo clippy` will be used instead of `cargo check` or
+  `cargo build` as linter.
+  For details of `cargo clippy`, please visit the following link:
+
+  https://github.com/rust-lang-nursery/rust-clippy
+
+  Since `cargo clippy` is optional toolchain, it's safer to check whether
+  `cargo-clippy` is executable as follows:
+>
+    let g:ale_rust_cargo_use_clippy = executable('cargo-clippy')
+<
+
+g:ale_rust_cargo_clippy_options
+                                              *g:ale_rust_cargo_clippy_options*
+                                              *b:ale_rust_cargo_clippy_options*
+
+  Type: |String|
+  Default: `''`
+
+  When `cargo clippy` is used, this value will be added to a command line to run
+  it. This variable is useful when you want to add some extra options which
+  only `cargo clippy` supports (e.g. `--deny`).
+
+
 ===============================================================================
 rls                                                              *ale-rust-rls*