mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-03 18:28:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add rule deprecation infrastructure (#9689)

Browse source 
Adds a new `Deprecated` rule group in addition to `Stable` and
`Preview`.

Deprecated rules:
- Warn on explicit selection without preview
- Error on explicit selection with preview
- Are excluded when selected by prefix with preview

Deprecates `TRY200`, `ANN101`, and `ANN102` as a proof of concept. We
can consider deprecating them separately.
This commit is contained in:
Zanie Blue 2024-01-30 11:38:25 -06:00
parent c86e14d1d4
commit a0ef087e73
10 changed files with 279 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

46
crates/ruff_workspace/src/configuration.rs
View file

@ -755,6 +755,7 @@ impl LintConfiguration {
// Store selectors for displaying warnings
let mut redirects = FxHashMap::default();
let mut deprecated_nursery_selectors = FxHashSet::default();
let mut deprecated_selectors = FxHashSet::default();
let mut ignored_preview_selectors = FxHashSet::default();
// Track which docstring rules are specifically enabled
@ -895,8 +896,10 @@ impl LintConfiguration {
return Err(anyhow!("The `NURSERY` selector was removed.{suggestion}"));
};
// Only warn for the following selectors if used to enable rules
// e.g. use with `--ignore` or `--fixable` is okay
// Some of these checks are only for `Kind::Enable` which means only `--select` will warn
// and use with, e.g., `--ignore` or `--fixable` is okay
// Unstable rules
if preview.mode.is_disabled() && kind.is_enable() {
if let RuleSelector::Rule { prefix, .. } = selector {
if prefix.rules().any(|rule| rule.is_nursery()) {
@ -910,6 +913,16 @@ impl LintConfiguration {
}
}
// Deprecated rules
if kind.is_enable() {
if let RuleSelector::Rule { prefix, .. } = selector {
if prefix.rules().any(|rule| rule.is_deprecated()) {
deprecated_selectors.insert(selector);
}
}
}
// Redirected rules
if let RuleSelector::Prefix {
prefix,
redirected_from: Some(redirect_from),
@ -950,6 +963,35 @@ impl LintConfiguration {
}
}
if preview.mode.is_disabled() {
for selection in deprecated_selectors {
let (prefix, code) = selection.prefix_and_code();
warn_user!(
"Rule `{prefix}{code}` is deprecated and will be removed in a future release.",
);
}
} else {
let deprecated_selectors = deprecated_selectors.iter().collect::<Vec<_>>();
match deprecated_selectors.as_slice() {
[] => (),
[selection] => {
let (prefix, code) = selection.prefix_and_code();
return Err(anyhow!("Selection of deprecated rule `{prefix}{code}` is not allowed when preview mode is enabled."));
}
[..] => {
let mut message = "Selection of deprecated rules is not allowed when preview mode is enabled. Remove selection of:".to_string();
for selection in deprecated_selectors {
let (prefix, code) = selection.prefix_and_code();
message.push_str("\n\t- ");
message.push_str(prefix);
message.push_str(code);
}
message.push('\n');
return Err(anyhow!(message));
}
}
}
for selection in ignored_preview_selectors {
let (prefix, code) = selection.prefix_and_code();
warn_user!(