Improve unexpected_cfgs lint when their is no value expected

This commit is contained in:
Loïc BRANSTETT 2022-03-03 15:56:19 +01:00
parent 86067bb461
commit 92544f43b0
7 changed files with 52 additions and 29 deletions

View File

@ -476,7 +476,7 @@ pub fn cfg_matches(
cfg.span, cfg.span,
lint_node_id, lint_node_id,
"unexpected `cfg` condition name", "unexpected `cfg` condition name",
BuiltinLintDiagnostics::UnexpectedCfg(ident.span, name, None), BuiltinLintDiagnostics::UnexpectedCfg((name, ident.span), None),
); );
} }
} }
@ -489,9 +489,8 @@ pub fn cfg_matches(
lint_node_id, lint_node_id,
"unexpected `cfg` condition value", "unexpected `cfg` condition value",
BuiltinLintDiagnostics::UnexpectedCfg( BuiltinLintDiagnostics::UnexpectedCfg(
cfg.name_value_literal_span().unwrap(), (name, ident.span),
name, Some((value, cfg.name_value_literal_span().unwrap())),
Some(value),
), ),
); );
} }

View File

@ -779,37 +779,43 @@ pub trait LintContext: Sized {
db.help(&help); db.help(&help);
db.note("see the asm section of Rust By Example <https://doc.rust-lang.org/nightly/rust-by-example/unsafe/asm.html#labels> for more information"); db.note("see the asm section of Rust By Example <https://doc.rust-lang.org/nightly/rust-by-example/unsafe/asm.html#labels> for more information");
}, },
BuiltinLintDiagnostics::UnexpectedCfg(span, name, value) => { BuiltinLintDiagnostics::UnexpectedCfg((name, name_span), None) => {
let possibilities: Vec<Symbol> = if value.is_some() { let Some(names_valid) = &sess.parse_sess.check_config.names_valid else {
let Some(values) = &sess.parse_sess.check_config.values_valid.get(&name) else { bug!("it shouldn't be possible to have a diagnostic on a name if name checking is not enabled");
bug!("it shouldn't be possible to have a diagnostic on a value whose name is not in values");
};
values.iter().map(|&s| s).collect()
} else {
let Some(names_valid) = &sess.parse_sess.check_config.names_valid else {
bug!("it shouldn't be possible to have a diagnostic on a name if name checking is not enabled");
};
names_valid.iter().map(|s| *s).collect()
}; };
let possibilities: Vec<Symbol> = names_valid.iter().map(|s| *s).collect();
// Suggest the most probable if we found one
if let Some(best_match) = find_best_match_for_name(&possibilities, name, None) {
db.span_suggestion(name_span, "did you mean", format!("{best_match}"), Applicability::MaybeIncorrect);
}
},
BuiltinLintDiagnostics::UnexpectedCfg((name, name_span), Some((value, value_span))) => {
let Some(values) = &sess.parse_sess.check_config.values_valid.get(&name) else {
bug!("it shouldn't be possible to have a diagnostic on a value whose name is not in values");
};
let possibilities: Vec<Symbol> = values.iter().map(|&s| s).collect();
// Show the full list if all possible values for a given name, but don't do it // Show the full list if all possible values for a given name, but don't do it
// for names as the possibilities could be very long // for names as the possibilities could be very long
if value.is_some() { if !possibilities.is_empty() {
if !possibilities.is_empty() { {
let mut possibilities = possibilities.iter().map(Symbol::as_str).collect::<Vec<_>>(); let mut possibilities = possibilities.iter().map(Symbol::as_str).collect::<Vec<_>>();
possibilities.sort(); possibilities.sort();
let possibilities = possibilities.join(", "); let possibilities = possibilities.join(", ");
db.note(&format!("expected values for `{name}` are: {possibilities}")); db.note(&format!("expected values for `{name}` are: {possibilities}"));
} else {
db.note(&format!("no expected value for `{name}`"));
} }
}
// Suggest the most probable if we found one // Suggest the most probable if we found one
if let Some(best_match) = find_best_match_for_name(&possibilities, value.unwrap_or(name), None) { if let Some(best_match) = find_best_match_for_name(&possibilities, value, None) {
let punctuation = if value.is_some() { "\"" } else { "" }; db.span_suggestion(value_span, "did you mean", format!("\"{best_match}\""), Applicability::MaybeIncorrect);
db.span_suggestion(span, "did you mean", format!("{punctuation}{best_match}{punctuation}"), Applicability::MaybeIncorrect); }
} else {
db.note(&format!("no expected value for `{name}`"));
if name != sym::feature {
db.span_suggestion(name_span.shrink_to_hi().to(value_span), "remove the value", String::new(), Applicability::MaybeIncorrect);
}
} }
}, },
} }

View File

@ -426,7 +426,7 @@ pub enum BuiltinLintDiagnostics {
BreakWithLabelAndLoop(Span), BreakWithLabelAndLoop(Span),
NamedAsmLabel(String), NamedAsmLabel(String),
UnicodeTextFlow(Span, String), UnicodeTextFlow(Span, String),
UnexpectedCfg(Span, Symbol, Option<Symbol>), UnexpectedCfg((Symbol, Span), Option<(Symbol, Span)>),
} }
/// Lints that are buffered up early on in the `Session` before the /// Lints that are buffered up early on in the `Session` before the

View File

@ -2,7 +2,9 @@ warning: unexpected `cfg` condition value
--> $DIR/empty-values.rs:6:7 --> $DIR/empty-values.rs:6:7
| |
LL | #[cfg(test = "value")] LL | #[cfg(test = "value")]
| ^^^^^^^^^^^^^^ | ^^^^----------
| |
| help: remove the value
| |
= note: `#[warn(unexpected_cfgs)]` on by default = note: `#[warn(unexpected_cfgs)]` on by default
= note: no expected value for `test` = note: no expected value for `test`

View File

@ -1,10 +1,14 @@
// Check that we detect unexpected value when none are allowed // Check that we detect unexpected value when none are allowed
// //
// check-pass // check-pass
// compile-flags: --check-cfg=values(feature) -Z unstable-options // compile-flags: --check-cfg=values(test) --check-cfg=values(feature) -Z unstable-options
#[cfg(feature = "foo")] #[cfg(feature = "foo")]
//~^ WARNING unexpected `cfg` condition value //~^ WARNING unexpected `cfg` condition value
fn do_foo() {} fn do_foo() {}
#[cfg(test = "foo")]
//~^ WARNING unexpected `cfg` condition value
fn do_foo() {}
fn main() {} fn main() {}

View File

@ -7,5 +7,15 @@ LL | #[cfg(feature = "foo")]
= note: `#[warn(unexpected_cfgs)]` on by default = note: `#[warn(unexpected_cfgs)]` on by default
= note: no expected value for `feature` = note: no expected value for `feature`
warning: 1 warning emitted warning: unexpected `cfg` condition value
--> $DIR/no-values.rs:10:7
|
LL | #[cfg(test = "foo")]
| ^^^^--------
| |
| help: remove the value
|
= note: no expected value for `test`
warning: 2 warnings emitted

View File

@ -23,7 +23,9 @@ warning: unexpected `cfg` condition value
--> $DIR/well-known-values.rs:21:7 --> $DIR/well-known-values.rs:21:7
| |
LL | #[cfg(unix = "aa")] LL | #[cfg(unix = "aa")]
| ^^^^^^^^^^^ | ^^^^-------
| |
| help: remove the value
| |
= note: no expected value for `unix` = note: no expected value for `unix`