Skip to content

Improve error for nightly-only '--message-format' args #6780

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

Open
matthewhughes934 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve error for nightly-only '--message-format' args #6780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 25 additions & 3 deletions src/cargo-fmt/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,19 @@ use clap::{CommandFactory, Parser};
#[cfg(test)]
mod cargo_fmt_tests;

const fn is_nightly() -> bool {
match option_env!("CFG_RELEASE_CHANNEL") {
None => true,
Some(c) => matches!(c.as_bytes(), b"nightly" | b"dev"),
}
}

const MESSAGE_FORMATS: &str = if is_nightly() {
"short|json|human"
} else {
"short|human"
};

#[derive(Parser)]
#[command(
disable_version_flag = true,
Expand Down Expand Up @@ -54,8 +67,11 @@ pub struct Opts {
#[arg(long = "manifest-path", value_name = "manifest-path")]
manifest_path: Option<String>,

/// Specify message-format: short|json|human
#[arg(long = "message-format", value_name = "message-format")]
#[arg(
long = "message-format",
value_name = "message-format",
help = format!("Specify message-format: {MESSAGE_FORMATS}")
)]
message_format: Option<String>,

/// Options passed to rustfmt
Expand Down Expand Up @@ -186,6 +202,11 @@ fn convert_message_format_to_rustfmt_args(
Ok(())
}
"json" => {
if !is_nightly() {
return Err(String::from(
"--message-format json is only supported in nightly builds",
));
}
if contains_emit_mode {
return Err(String::from(
"cannot include --emit arg when --message-format is set to json",
Expand All @@ -202,7 +223,8 @@ fn convert_message_format_to_rustfmt_args(
}
"human" => Ok(()),
_ => Err(format!(
"invalid --message-format value: {message_format}. Allowed values are: short|json|human"
"invalid --message-format value: {message_format}. Allowed values are: \
{MESSAGE_FORMATS}"
)),
}
}
Expand Down
30 changes: 29 additions & 1 deletion src/cargo-fmt/test/message_format.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
use super::*;

use rustfmt_config_proc_macro::{nightly_only_test, stable_only_test};

#[nightly_only_test]
#[test]
fn invalid_message_format() {
fn invalid_message_format_nightly() {
assert_eq!(
convert_message_format_to_rustfmt_args("awesome", &mut vec![]),
Err(String::from(
Expand All @@ -10,6 +13,18 @@ fn invalid_message_format() {
);
}

#[stable_only_test]
#[test]
fn invalid_message_format_stable() {
assert_eq!(
convert_message_format_to_rustfmt_args("awesome", &mut vec![]),
Err(String::from(
"invalid --message-format value: awesome. Allowed values are: short|human"
)),
);
}

#[nightly_only_test]
#[test]
fn json_message_format_and_check_arg() {
let mut args = vec![String::from("--check")];
Expand All @@ -21,6 +36,7 @@ fn json_message_format_and_check_arg() {
);
}

#[nightly_only_test]
#[test]
fn json_message_format_and_emit_arg() {
let mut args = vec![String::from("--emit"), String::from("checkstyle")];
Expand All @@ -32,6 +48,18 @@ fn json_message_format_and_emit_arg() {
);
}

#[stable_only_test]
#[test]
fn json_message_format_non_nightly() {
assert_eq!(
convert_message_format_to_rustfmt_args("json", &mut vec![]),
Err(String::from(
"--message-format json is only supported in nightly builds"
)),
);
}

#[nightly_only_test]
#[test]
fn json_message_format() {
let mut args = vec![String::from("--edition"), String::from("2018")];
Expand Down
Loading