Skip to content

Better error message on Flycheck Error message #11891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 5, 2022
Merged

Better error message on Flycheck Error message #11891

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
635270d
Better error message hinting about `cargo clippy`
flipbit03 Apr 3, 2022
8e5c57f
wordsmithing.
flipbit03 Apr 3, 2022
ca9718a
Made error output the contents of Cargo's stderr as well.
flipbit03 Apr 4, 2022
84cf6ad
Using `error` instead of `output.stderr` in failure mode.
flipbit03 Apr 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions crates/flycheck/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//! another compatible command (f.x. clippy) in a background thread and provide
//! LSP diagnostics based on the output of the command.

use std::{fmt, io, process::Command, time::Duration};
use std::{fmt, io, process::Command, time::Duration, str::from_utf8};

use crossbeam_channel::{never, select, unbounded, Receiver, Sender};
use paths::AbsPathBuf;
Expand Down Expand Up @@ -329,8 +329,8 @@ impl CargoActor {
Ok(output) if output.status.success() => Ok(()),
Ok(output) => {
Err(io::Error::new(io::ErrorKind::Other, format!(
"Cargo watcher failed, the command produced no valid metadata (exit code: {:?})",
output.status
"Cargo watcher failed, the command produced no valid metadata (exit code: {:?})\nCargo's stderr output:\n{}",
output.status, from_utf8(&output.stderr).unwrap_or("(Error: Could not fetch Cargo's stderr output)")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe use from_utf8_lossy instead? That is infallible. In any case the error should say that the stderr is not valid UTF-8 if you keep using from_utf8.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't want to use output.stderr here, we use streaming_output to fill in the error output into the error local here which is what contains the error (See the Err(e) branch below this one).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your time @bjorn3 and @Veykril. I have updated my PR, now using error String variable to build the final output message.

)))
}
Err(e) => Err(io::Error::new(e.kind(), format!("{:?}: {}", e, error))),
Expand Down