flycheck: initial implementation of $saved_file

Author: davidbarsky

crates/flycheck/src/lib.rs

@@ -55,6 +55,7 @@ pub enum FlycheckConfig {
         extra_env: FxHashMap<String, String>,
         invocation_strategy: InvocationStrategy,
         invocation_location: InvocationLocation,
+        invoke_with_saved_file: bool,
     },
 }
 
@@ -69,6 +70,15 @@ impl fmt::Display for FlycheckConfig {
     }
 }
 
+impl FlycheckConfig {
+    pub fn invoke_with_saved_file(&self) -> bool {
+        match self {
+            FlycheckConfig::CustomCommand { invoke_with_saved_file, .. } => *invoke_with_saved_file,
+            _ => false,
+        }
+    }
+}
+
 /// Flycheck wraps the shared state and communication machinery used for
 /// running `cargo check` (or other compatible command) and providing
 /// diagnostics based on the output.
@@ -98,8 +108,8 @@ impl FlycheckHandle {
     }
 
     /// Schedule a re-start of the cargo check worker.
-    pub fn restart(&self) {
-        self.sender.send(StateChange::Restart).unwrap();
+    pub fn restart(&self, saved_file: Option<AbsPathBuf>) {
+        self.sender.send(StateChange::Restart { saved_file }).unwrap();
     }
 
     /// Stop this cargo check worker.
@@ -150,7 +160,7 @@ pub enum Progress {
 }
 
 enum StateChange {
-    Restart,
+    Restart { saved_file: Option<AbsPathBuf> },
     Cancel,
 }
 
@@ -210,7 +220,7 @@ impl FlycheckActor {
                     tracing::debug!(flycheck_id = self.id, "flycheck cancelled");
                     self.cancel_check_process();
                 }
-                Event::RequestStateChange(StateChange::Restart) => {
+                Event::RequestStateChange(StateChange::Restart { saved_file }) => {
                     // Cancel the previously spawned process
                     self.cancel_check_process();
                     while let Ok(restart) = inbox.recv_timeout(Duration::from_millis(50)) {
@@ -220,12 +230,15 @@ impl FlycheckActor {
                         }
                     }
 
-                    let command = self.check_command();
-                    tracing::debug!(?command, "will restart flycheck");
+                    let command = self.check_command(saved_file);
+                    let command_string = format!("{:?}", command);
+
+                    tracing::debug!(?command, "restarting flycheck");
+
                     match CargoHandle::spawn(command) {
                         Ok(cargo_handle) => {
                             tracing::debug!(
-                                command = ?self.check_command(),
+                                command = ?command_string,
                                 "did  restart flycheck"
                             );
                             self.cargo_handle = Some(cargo_handle);
@@ -234,8 +247,7 @@ impl FlycheckActor {
                         Err(error) => {
                             self.report_progress(Progress::DidFailToRestart(format!(
                                 "Failed to run the following command: {:?} error={}",
-                                self.check_command(),
-                                error
+                                command_string, error
                             )));
                         }
                     }
@@ -249,7 +261,7 @@ impl FlycheckActor {
                     if res.is_err() {
                         tracing::error!(
                             "Flycheck failed to run the following command: {:?}",
-                            self.check_command()
+                            self.check_command(None)
                         );
                     }
                     self.report_progress(Progress::DidFinish(res));
@@ -285,16 +297,13 @@ impl FlycheckActor {
 
     fn cancel_check_process(&mut self) {
         if let Some(cargo_handle) = self.cargo_handle.take() {
-            tracing::debug!(
-                command = ?self.check_command(),
-                "did  cancel flycheck"
-            );
+            tracing::debug!(command = ?self.check_command(None), "did  cancel flycheck");
             cargo_handle.cancel();
             self.report_progress(Progress::DidCancel);
         }
     }
 
-    fn check_command(&self) -> Command {
+    fn check_command(&self, saved_file: Option<AbsPathBuf>) -> Command {
         let (mut cmd, args) = match &self.config {
             FlycheckConfig::CargoCommand {
                 command,
@@ -339,14 +348,15 @@ impl FlycheckActor {
                     }
                 }
                 cmd.envs(extra_env);
-                (cmd, extra_args)
+                (cmd, extra_args.clone())
             }
             FlycheckConfig::CustomCommand {
                 command,
                 args,
                 extra_env,
                 invocation_strategy,
                 invocation_location,
+                invoke_with_saved_file,
             } => {
                 let mut cmd = Command::new(command);
                 cmd.envs(extra_env);
@@ -368,11 +378,23 @@ impl FlycheckActor {
                     }
                 }
 
-                (cmd, args)
+                if *invoke_with_saved_file {
+                    match (args.iter().position(|arg| arg == "$saved_file"), saved_file) {
+                        (Some(i), Some(saved_file)) => {
+                            let mut args = args.clone();
+                            args[i] = saved_file.to_string();
+                            (cmd, args)
+                        },
+                        _ => unreachable!("this code should not be reachable. An invariant inside of rust-analyzer has been broken.")
+                    }
+                } else {
+                    (cmd, args.clone())
+                }
             }
         };
 
         cmd.args(args);
+
         cmd
     }
 
@@ -464,23 +486,28 @@ impl CargoActor {
             // Try to deserialize a message from Cargo or Rustc.
             let mut deserializer = serde_json::Deserializer::from_str(line);
             deserializer.disable_recursion_limit();
-            if let Ok(message) = JsonMessage::deserialize(&mut deserializer) {
-                match message {
-                    // Skip certain kinds of messages to only spend time on what's useful
-                    JsonMessage::Cargo(message) => match message {
-                        cargo_metadata::Message::CompilerArtifact(artifact) if !artifact.fresh => {
-                            self.sender.send(CargoMessage::CompilerArtifact(artifact)).unwrap();
-                        }
-                        cargo_metadata::Message::CompilerMessage(msg) => {
-                            self.sender.send(CargoMessage::Diagnostic(msg.message)).unwrap();
+            match JsonMessage::deserialize(&mut deserializer) {
+                Ok(message) => {
+                    match message {
+                        // Skip certain kinds of messages to only spend time on what's useful
+                        JsonMessage::Cargo(message) => match message {
+                            cargo_metadata::Message::CompilerArtifact(artifact)
+                                if !artifact.fresh =>
+                            {
+                                self.sender.send(CargoMessage::CompilerArtifact(artifact)).unwrap();
+                            }
+                            cargo_metadata::Message::CompilerMessage(msg) => {
+                                self.sender.send(CargoMessage::Diagnostic(msg.message)).unwrap();
+                            }
+                            _ => (),
+                        },
+                        JsonMessage::Rustc(message) => {
+                            self.sender.send(CargoMessage::Diagnostic(message)).unwrap();
                         }
-                        _ => (),
-                    },
-                    JsonMessage::Rustc(message) => {
-                        self.sender.send(CargoMessage::Diagnostic(message)).unwrap();
                     }
+                    return true;
                 }
-                return true;
+                Err(e) => tracing::error!(?e, "unable to deserialize message"),
             }
 
             error.push_str(line);

crates/rust-analyzer/src/config.rs

@@ -181,6 +181,10 @@ config_data! {
         /// each of them, with the working directory being the project root
         /// (i.e., the folder containing the `Cargo.toml`).
         ///
+        /// If `$saved_file` is part of the command, rust-analyzer will pass
+        /// the absolute path of the saved file to the provided command. This is
+        /// intended to be used with non-Cargo build systems.
+        ///
         /// An example command would be:
         ///
         /// ```bash
@@ -1264,6 +1268,9 @@ impl Config {
             Some(args) if !args.is_empty() => {
                 let mut args = args.clone();
                 let command = args.remove(0);
+
+                let use_saved_file = args.contains(&"$saved_file".to_string());
+
                 FlycheckConfig::CustomCommand {
                     command,
                     args,
@@ -1280,6 +1287,7 @@ impl Config {
                         }
                         InvocationLocation::Workspace => flycheck::InvocationLocation::Workspace,
                     },
+                    invoke_with_saved_file: use_saved_file,
                 }
             }
             Some(_) | None => FlycheckConfig::CargoCommand {

crates/rust-analyzer/src/handlers/notification.rs

@@ -137,7 +137,7 @@ pub(crate) fn handle_did_save_text_document(
     } else if state.config.check_on_save() {
         // No specific flycheck was triggered, so let's trigger all of them.
         for flycheck in state.flycheck.iter() {
-            flycheck.restart();
+            flycheck.restart(None);
         }
     }
     Ok(())
@@ -273,20 +273,25 @@ fn run_flycheck(state: &mut GlobalState, vfs_path: VfsPath) -> bool {
                 project_model::ProjectWorkspace::DetachedFiles { .. } => false,
             });
 
+            let path = vfs_path
+                .as_path()
+                .expect("unable to convert to a path; this is a bug in rust-analyzer")
+                .to_owned();
+
             // Find and trigger corresponding flychecks
             for flycheck in world.flycheck.iter() {
                 for (id, _) in workspace_ids.clone() {
                     if id == flycheck.id() {
                         updated = true;
-                        flycheck.restart();
+                        flycheck.restart(Some(path.clone()));
                         continue;
                     }
                 }
             }
             // No specific flycheck was triggered, so let's trigger all of them.
             if !updated {
                 for flycheck in world.flycheck.iter() {
-                    flycheck.restart();
+                    flycheck.restart(None);
                 }
             }
             Ok(())
@@ -328,7 +333,7 @@ pub(crate) fn handle_run_flycheck(
     }
     // No specific flycheck was triggered, so let's trigger all of them.
     for flycheck in state.flycheck.iter() {
-        flycheck.restart();
+        flycheck.restart(None);
     }
     Ok(())
 }

crates/rust-analyzer/src/main_loop.rs

@@ -7,7 +7,6 @@ use std::{
 
 use always_assert::always;
 use crossbeam_channel::{select, Receiver};
-use flycheck::FlycheckHandle;
 use ide_db::base_db::{SourceDatabaseExt, VfsPath};
 use lsp_server::{Connection, Notification, Request};
 use lsp_types::notification::Notification as _;
@@ -296,7 +295,9 @@ impl GlobalState {
             if became_quiescent {
                 if self.config.check_on_save() {
                     // Project has loaded properly, kick off initial flycheck
-                    self.flycheck.iter().for_each(FlycheckHandle::restart);
+                    if !self.config.flycheck().invoke_with_saved_file() {
+                        self.flycheck.iter().for_each(|flycheck| flycheck.restart(None));
+                    }
                 }
                 if self.config.prefill_caches() {
                     self.prime_caches_queue.request_op("became quiescent".to_string(), ());

crates/rust-analyzer/src/reload.rs

@@ -577,6 +577,7 @@ impl GlobalState {
     fn reload_flycheck(&mut self) {
         let _p = profile::span("GlobalState::reload_flycheck");
         let config = self.config.flycheck();
+
         let sender = self.flycheck_sender.clone();
         let invocation_strategy = match config {
             FlycheckConfig::CargoCommand { .. } => flycheck::InvocationStrategy::PerWorkspace,

docs/user/generated_config.adoc

@@ -203,6 +203,10 @@ If there are multiple linked projects, this command is invoked for
 each of them, with the working directory being the project root
 (i.e., the folder containing the `Cargo.toml`).
 
+If `$saved_file` is part of the command, rust-analyzer will pass
+the absolute path of the saved file to the provided command. This is
+intended to be used with non-Cargo build systems.
+
 An example command would be:
 
 ```bash

editors/code/package.json

@@ -735,7 +735,7 @@
                     ]
                 },
                 "rust-analyzer.check.overrideCommand": {
-                    "markdownDescription": "Override the command rust-analyzer uses instead of `cargo check` for\ndiagnostics on save. The command is required to output json and\nshould therefore include `--message-format=json` or a similar option\n(if your client supports the `colorDiagnosticOutput` experimental\ncapability, you can use `--message-format=json-diagnostic-rendered-ansi`).\n\nIf you're changing this because you're using some tool wrapping\nCargo, you might also want to change\n`#rust-analyzer.cargo.buildScripts.overrideCommand#`.\n\nIf there are multiple linked projects, this command is invoked for\neach of them, with the working directory being the project root\n(i.e., the folder containing the `Cargo.toml`).\n\nAn example command would be:\n\n```bash\ncargo check --workspace --message-format=json --all-targets\n```\n.",
+                    "markdownDescription": "Override the command rust-analyzer uses instead of `cargo check` for\ndiagnostics on save. The command is required to output json and\nshould therefore include `--message-format=json` or a similar option\n(if your client supports the `colorDiagnosticOutput` experimental\ncapability, you can use `--message-format=json-diagnostic-rendered-ansi`).\n\nIf you're changing this because you're using some tool wrapping\nCargo, you might also want to change\n`#rust-analyzer.cargo.buildScripts.overrideCommand#`.\n\nIf there are multiple linked projects, this command is invoked for\neach of them, with the working directory being the project root\n(i.e., the folder containing the `Cargo.toml`).\n\nIf `$saved_file` is part of the command, rust-analyzer will pass\nthe absolute path of the saved file to the provided command. This is\nintended to be used with non-Cargo build systems.\n\nAn example command would be:\n\n```bash\ncargo check --workspace --message-format=json --all-targets\n```\n.",
                     "default": null,
                     "type": [
                         "null",