mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-11-02 04:48:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Avoid returning first-match for rule prefixes (#5511)

Browse source 
Closes #5495, but there's a TODO here to improve this further. The
current `from_code` implementation feels really indirect.
This commit is contained in:
Charlie Marsh 2023-07-04 15:23:05 -04:00 • committed by GitHub
parent 0a26201643
commit 952c623102
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
crates/ruff/src/registry.rs
View file

@ -19,7 +19,13 @@ impl Rule {
pub fn from_code(code: &str) -> Result<Self, FromCodeError> {
let (linter, code) = Linter::parse_code(code).ok_or(FromCodeError::Unknown)?;
let prefix: RuleCodePrefix = RuleCodePrefix::parse(&linter, code)?;
Ok(prefix.rules().next().unwrap())
let rule = prefix.rules().next().unwrap();
// TODO(charlie): Add a method to return an individual code, rather than matching on the
// prefix.
if rule.noqa_code().to_string() != format!("{}{}", linter.common_prefix(), code) {
return Err(FromCodeError::Prefix);
}
Ok(rule)
}
}
@ -27,6 +33,8 @@ impl Rule {
pub enum FromCodeError {
#[error("unknown rule code")]
Unknown,
#[error("expected a rule code (like `SIM101`), not a prefix (like `SIM` or `SIM1`)")]
Prefix,
}
#[derive(EnumIter, Debug, PartialEq, Eq, Clone, Hash, RuleNamespace)]

1
crates/ruff_cli/src/commands/rule.rs
View file

@ -31,7 +31,6 @@ pub(crate) fn rule(rule: Rule, format: HelpFormat) -> Result<()> {
output.push('\n');
output.push('\n');
let (linter, _) = Linter::parse_code(&rule.noqa_code().to_string()).unwrap();
output.push_str(&format!("Derived from the **{}** linter.", linter.name()));
output.push('\n');
output.push('\n');