language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-28 12:55:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

many-to-one 1/9: Rename Rule::code to Rule::noqa_code

Browse source 
Post this commit series several codes can be mapped to a single rule,
this commit therefore renames Rule::code to Rule::noqa_code,
which is the code that --add-noqa will add to ignore a rule.
This commit is contained in:
Martin Fischer 2023-01-30 06:30:36 +01:00 • committed by Charlie Marsh
parent 502ce80c91
commit d451c7a506
36 changed files with 66 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -22,17 +22,17 @@ struct Explanation<'a> {
/// Explain a `Rule` to the user.
pub fn rule(rule: &Rule, format: HelpFormat) -> Result<()> {
let (linter, _) = Linter::parse_code(rule.code()).unwrap();
let (linter, _) = Linter::parse_code(rule.noqa_code()).unwrap();
let mut stdout = BufWriter::new(io::stdout().lock());
let mut output = String::new();
match format {
HelpFormat::Text | HelpFormat::Pretty => {
output.push_str(&format!("# {} ({})", rule.as_ref(), rule.code()));
output.push_str(&format!("# {} ({})", rule.as_ref(), rule.noqa_code()));
output.push('\n');
output.push('\n');
let (linter, _) = Linter::parse_code(rule.code()).unwrap();
let (linter, _) = Linter::parse_code(rule.noqa_code()).unwrap();
output.push_str(&format!("Derived from the **{}** linter.", linter.name()));
output.push('\n');
output.push('\n');
@ -58,7 +58,7 @@ pub fn rule(rule: &Rule, format: HelpFormat) -> Result<()> {
}
HelpFormat::Json => {
output.push_str(&serde_json::to_string_pretty(&Explanation {
code: rule.code(),
code: rule.noqa_code(),
linter: linter.name(),
summary: rule.message_formats()[0],
})?);

26
crates/ruff_cli/src/printer.rs
View file

@ -67,7 +67,7 @@ impl Serialize for SerializeRuleAsCode<'_> {
where
S: serde::Serializer,
{
serializer.serialize_str(self.0.code())
serializer.serialize_str(self.0.noqa_code())
}
}
@ -221,7 +221,7 @@ impl Printer {
message.kind.body()
));
let mut case = TestCase::new(
format!("org.ruff.{}", message.kind.rule().code()),
format!("org.ruff.{}", message.kind.rule().noqa_code()),
status,
);
let file_path = Path::new(filename);
@ -313,14 +313,14 @@ impl Printer {
":",
message.location.column(),
":",
message.kind.rule().code(),
message.kind.rule().noqa_code(),
message.kind.body(),
);
writeln!(
stdout,
"::error title=Ruff \
({}),file={},line={},col={},endLine={},endColumn={}::{}",
message.kind.rule().code(),
message.kind.rule().noqa_code(),
message.filename,
message.location.row(),
message.location.column(),
@ -341,9 +341,9 @@ impl Printer {
.iter()
.map(|message| {
json!({
"description": format!("({}) {}", message.kind.rule().code(), message.kind.body()),
"description": format!("({}) {}", message.kind.rule().noqa_code(), message.kind.body()),
"severity": "major",
"fingerprint": message.kind.rule().code(),
"fingerprint": message.kind.rule().noqa_code(),
"location": {
"path": message.filename,
"lines": {
@ -366,7 +366,7 @@ impl Printer {
"{}:{}: [{}] {}",
relativize_path(Path::new(&message.filename)),
message.location.row(),
message.kind.rule().code(),
message.kind.rule().noqa_code(),
message.kind.body(),
);
writeln!(stdout, "{label}")?;
@ -394,7 +394,7 @@ impl Printer {
let statistics = violations
.iter()
.map(|rule| ExpandedStatistics {
code: rule.code(),
code: rule.noqa_code(),
count: diagnostics
.messages
.iter()
@ -538,7 +538,7 @@ impl Display for CodeAndBody<'_> {
write!(
f,
"{code} {autofix}{body}",
code = self.0.kind.rule().code().red().bold(),
code = self.0.kind.rule().noqa_code().red().bold(),
autofix = format_args!("[{}] ", "*".cyan()),
body = self.0.kind.body(),
)
@ -546,7 +546,7 @@ impl Display for CodeAndBody<'_> {
write!(
f,
"{code} {body}",
code = self.0.kind.rule().code().red().bold(),
code = self.0.kind.rule().noqa_code().red().bold(),
body = self.0.kind.body(),
)
}
@ -601,7 +601,7 @@ fn print_message<T: Write>(
source: &source.contents,
line_start: message.location.row(),
annotations: vec![SourceAnnotation {
label: message.kind.rule().code(),
label: message.kind.rule().noqa_code(),
annotation_type: AnnotationType::Error,
range: source.range,
}],
@ -656,7 +656,7 @@ fn print_fixed<T: Write>(stdout: &mut T, fixed: &FxHashMap<String, FixTable>) ->
writeln!(
stdout,
" {count:>num_digits$} × {} ({})",
rule.code().red().bold(),
rule.noqa_code().red().bold(),
rule.as_ref(),
)?;
}
@ -706,7 +706,7 @@ fn print_grouped_message<T: Write>(
source: &source.contents,
line_start: message.location.row(),
annotations: vec![SourceAnnotation {
label: message.kind.rule().code(),
label: message.kind.rule().noqa_code(),
annotation_type: AnnotationType::Error,
range: source.range,
}],