From 506a8532d07fd7e15e9a6cc37d490f7b7088aef5 Mon Sep 17 00:00:00 2001
From: Ben Boeckel <mathstuf@gmail.com>
Date: Sun, 10 May 2020 08:21:02 -0400
Subject: [PATCH] rust/cargo: add support for a custom target directory

This can avoid having to wait for ALE or ALE being blocked on other
cargo actions within the same crate.
---
 ale_linters/rust/cargo.vim                    |  5 ++++
 doc/ale-rust.txt                              | 12 ++++++++++
 .../test_cargo_command_callbacks.vader        | 24 +++++++++++++++++--
 3 files changed, 39 insertions(+), 2 deletions(-)

diff --git a/ale_linters/rust/cargo.vim b/ale_linters/rust/cargo.vim
index 99178585..3407abed 100644
--- a/ale_linters/rust/cargo.vim
+++ b/ale_linters/rust/cargo.vim
@@ -11,6 +11,7 @@ call ale#Set('rust_cargo_default_feature_behavior', 'default')
 call ale#Set('rust_cargo_include_features', '')
 call ale#Set('rust_cargo_use_clippy', 0)
 call ale#Set('rust_cargo_clippy_options', '')
+call ale#Set('rust_cargo_target_dir', '')
 
 function! ale_linters#rust#cargo#GetCargoExecutable(bufnr) abort
     if ale#path#FindNearestFile(a:bufnr, 'Cargo.toml') isnot# ''
@@ -31,6 +32,9 @@ function! ale_linters#rust#cargo#GetCommand(buffer, version) abort
     \   && ale#semver#GTE(a:version, [0, 22, 0])
     let l:use_tests = ale#Var(a:buffer, 'rust_cargo_check_tests')
     \   && ale#semver#GTE(a:version, [0, 22, 0])
+    let l:target_dir = ale#Var(a:buffer, 'rust_cargo_target_dir')
+    let l:use_target_dir = !empty(l:target_dir)
+    \   && ale#semver#GTE(a:version, [0, 17, 0])
 
     let l:include_features = ale#Var(a:buffer, 'rust_cargo_include_features')
 
@@ -82,6 +86,7 @@ function! ale_linters#rust#cargo#GetCommand(buffer, version) abort
     \   . (l:use_all_targets ? ' --all-targets' : '')
     \   . (l:use_examples ? ' --examples' : '')
     \   . (l:use_tests ? ' --tests' : '')
+    \   . (l:use_target_dir ? (' --target-dir ' . ale#Escape(l:target_dir)) : '')
     \   . ' --frozen --message-format=json -q'
     \   . l:default_feature
     \   . l:include_features
diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt
index 46d4714b..2c0222b7 100644
--- a/doc/ale-rust.txt
+++ b/doc/ale-rust.txt
@@ -174,6 +174,18 @@ g:ale_rust_cargo_clippy_options
   only `cargo clippy` supports (e.g. `--deny`).
 
 
+g:ale_rust_cargo_target_dir
+                                                  *g:ale_rust_cargo_target_dir*
+                                                  *b:ale_rust_cargo_target_dir*
+
+  Type: |String|
+  Default: `''`
+
+  Use a custom target directory when running the commands for ALE. This can
+  help to avoid "waiting for file lock on build directory" messages when
+  running `cargo` commands manually while ALE is performing its checks.
+
+
 ===============================================================================
 rls                                                              *ale-rust-rls*
 
diff --git a/test/command_callback/test_cargo_command_callbacks.vader b/test/command_callback/test_cargo_command_callbacks.vader
index e56551ae..2d83351e 100644
--- a/test/command_callback/test_cargo_command_callbacks.vader
+++ b/test/command_callback/test_cargo_command_callbacks.vader
@@ -169,10 +169,11 @@ Execute(Build supports all cargo flags):
   let g:ale_rust_cargo_check_tests = 1
   let g:ale_rust_cargo_check_examples = 1
   let b:ale_rust_cargo_default_feature_behavior = 'all'
+  let b:ale_rust_cargo_target_dir = 'target/ale'
 
   AssertLinter 'cargo', [
   \ ale#Escape('cargo') . ' --version',
-  \ 'cargo build --all-targets --examples --tests --frozen --message-format=json -q --all-features',
+  \ 'cargo build --all-targets --examples --tests --target-dir ' . ale#Escape('target/ale') . ' --frozen --message-format=json -q --all-features',
   \]
 
 Execute(Clippy supports all cargo flags):
@@ -182,10 +183,11 @@ Execute(Clippy supports all cargo flags):
   let g:ale_rust_cargo_check_examples = 1
   let b:ale_rust_cargo_default_feature_behavior = 'all'
   let b:ale_rust_cargo_clippy_options = '-D warnings'
+  let b:ale_rust_cargo_target_dir = 'target/ale'
 
   AssertLinter 'cargo', [
   \ ale#Escape('cargo') . ' --version',
-  \ 'cargo clippy --all-targets --examples --tests --frozen --message-format=json -q --all-features -- -D warnings',
+  \ 'cargo clippy --all-targets --examples --tests --target-dir ' . ale#Escape('target/ale') . ' --frozen --message-format=json -q --all-features -- -D warnings',
   \]
 
 Execute(cargo-check does not refer ale_rust_cargo_clippy_options):
@@ -197,3 +199,21 @@ Execute(cargo-check does not refer ale_rust_cargo_clippy_options):
   \ ale#Escape('cargo') . ' --version',
   \ 'cargo check --frozen --message-format=json -q',
   \]
+
+Execute(`cargo --target-dir` should be used when the version is new enough and it is set):
+  let b:ale_rust_cargo_target_dir = 'target/ale'
+
+  GivenCommandOutput ['cargo 0.17.0 (3423351a5 2017-10-06)']
+  AssertLinter 'cargo', [
+  \ ale#Escape('cargo') . ' --version',
+  \ 'cargo check --target-dir ' . ale#Escape('target/ale') . g:suffix,
+  \]
+
+Execute(`cargo --target-dir` should not be used when the version is not new enough and it is set):
+  let b:ale_rust_cargo_target_dir = 'target/ale'
+
+  GivenCommandOutput ['cargo 0.16.0 (3423351a5 2017-10-06)']
+  AssertLinter 'cargo', [
+  \ ale#Escape('cargo') . ' --version',
+  \ 'cargo build' . g:suffix,
+  \]