language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-10-02 06:42:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Fix handling of Applicability::Display fixes when generating summary messages (#7932)

Browse source 
We were including `Display` fixes in the summary counts for unapplicable
fixes resulting in incorrect prompts to the user that a fix could be
enabled.
This commit is contained in:
Zanie Blue 2023-10-12 20:33:31 -05:00 • committed by GitHub
parent c03a693ebc
commit 889117ea87
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 112 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -128,17 +128,23 @@ impl Printer {
let fix_prefix = format!("[{}]", "*".cyan());
if self.unsafe_fixes.is_enabled() {
writeln!(
writer,
"{fix_prefix} {} fixable with the --fix option.",
fixables.applicable
)?;
if fixables.applicable > 0 {
writeln!(
writer,
"{fix_prefix} {} fixable with the --fix option.",
fixables.applicable
)?;
}
} else {
if fixables.applicable > 0 && fixables.unapplicable > 0 {
let es = if fixables.unapplicable == 1 { "" } else { "es" };
if fixables.applicable > 0 && fixables.unapplicable_unsafe > 0 {
let es = if fixables.unapplicable_unsafe == 1 {
""
} else {
"es"
};
writeln!(writer,
"{fix_prefix} {} fixable with the `--fix` option ({} hidden fix{es} can be enabled with the `--unsafe-fixes` option).",
fixables.applicable, fixables.unapplicable
fixables.applicable, fixables.unapplicable_unsafe
)?;
} else if fixables.applicable > 0 {
// Only applicable fixes
@ -149,10 +155,14 @@ impl Printer {
)?;
} else {
// Only unapplicable fixes
let es = if fixables.unapplicable == 1 { "" } else { "es" };
let es = if fixables.unapplicable_unsafe == 1 {
""
} else {
"es"
};
writeln!(writer,
"{} hidden fix{es} can be enabled with the `--unsafe-fixes` option.",
fixables.unapplicable
fixables.unapplicable_unsafe
)?;
}
}
@ -161,7 +171,7 @@ impl Printer {
// Check if there are unapplied fixes
let unapplied = {
if let Some(fixables) = fixables {
fixables.unapplicable
fixables.unapplicable_unsafe
} else {
0
}
@ -497,30 +507,33 @@ fn print_fix_summary(writer: &mut dyn Write, fixed: &FxHashMap<String, FixTable>
#[derive(Debug)]
struct FixableStatistics {
applicable: u32,
unapplicable: u32,
unapplicable_unsafe: u32,
}
impl FixableStatistics {
fn try_from(diagnostics: &Diagnostics, unsafe_fixes: UnsafeFixes) -> Option<Self> {
let mut applicable = 0;
let mut unapplicable = 0;
let mut unapplicable_unsafe = 0;
for message in &diagnostics.messages {
if let Some(fix) = &message.fix {
if fix.applies(unsafe_fixes.required_applicability()) {
applicable += 1;
} else {
unapplicable += 1;
// Do not include unapplicable fixes at other levels that do not provide an opt-in
if fix.applicability().is_unsafe() {
unapplicable_unsafe += 1;
}
}
}
}
if applicable == 0 && unapplicable == 0 {
if applicable == 0 && unapplicable_unsafe == 0 {
None
} else {
Some(Self {
applicable,
unapplicable,
unapplicable_unsafe,
})
}
}

88
crates/ruff_cli/tests/integration_test.rs
View file

@ -986,7 +986,7 @@ fn fix_applies_safe_fixes_by_default() {
"--output-format",
"text",
"--isolated",
"--no-cache",
"--no-cache",
"--select",
"F601,UP034",
"--fix",
@ -1015,7 +1015,7 @@ fn fix_applies_unsafe_fixes_with_opt_in() {
"--output-format",
"text",
"--isolated",
"--no-cache",
"--no-cache",
"--select",
"F601,UP034",
"--fix",
@ -1034,6 +1034,59 @@ fn fix_applies_unsafe_fixes_with_opt_in() {
"###);
}
#[test]
fn fix_does_not_apply_display_only_fixes() {
assert_cmd_snapshot!(
Command::new(get_cargo_bin(BIN_NAME))
.args([
"-",
"--output-format",
"text",
"--isolated",
"--no-cache",
"--select",
"B006",
"--fix",
])
.pass_stdin("def add_to_list(item, some_list=[]): ..."),
@r###"
success: false
exit_code: 1
----- stdout -----
def add_to_list(item, some_list=[]): ...
----- stderr -----
-:1:33: B006 Do not use mutable data structures for argument defaults
Found 1 error.
"###);
}
#[test]
fn fix_does_not_apply_display_only_fixes_with_unsafe_fixes_enabled() {
assert_cmd_snapshot!(
Command::new(get_cargo_bin(BIN_NAME))
.args([
"-",
"--output-format",
"text",
"--isolated",
"--no-cache",
"--select",
"B006",
"--fix",
"--unsafe-fixes",
])
.pass_stdin("def add_to_list(item, some_list=[]): ..."),
@r###"
success: false
exit_code: 1
----- stdout -----
def add_to_list(item, some_list=[]): ...
----- stderr -----
-:1:33: B006 Do not use mutable data structures for argument defaults
Found 1 error.
"###);
}
#[test]
fn fix_only_unsafe_fixes_available() {
assert_cmd_snapshot!(
@ -1043,7 +1096,7 @@ fn fix_only_unsafe_fixes_available() {
"--output-format",
"text",
"--isolated",
"--no-cache",
"--no-cache",
"--select",
"F601",
"--fix",
@ -1072,7 +1125,7 @@ fn fix_only_flag_applies_safe_fixes_by_default() {
"--output-format",
"text",
"--isolated",
"--no-cache",
"--no-cache",
"--select",
"F601,UP034",
"--fix-only",
@ -1099,7 +1152,7 @@ fn fix_only_flag_applies_unsafe_fixes_with_opt_in() {
"--output-format",
"text",
"--isolated",
"--no-cache",
"--no-cache",
"--select",
"F601,UP034",
"--fix-only",
@ -1182,6 +1235,31 @@ fn diff_shows_unsafe_fixes_with_opt_in() {
);
}
#[test]
fn diff_does_not_show_display_only_fixes_with_unsafe_fixes_enabled() {
assert_cmd_snapshot!(
Command::new(get_cargo_bin(BIN_NAME))
.args([
"-",
"--output-format",
"text",
"--isolated",
"--no-cache",
"--select",
"B006",
"--diff",
"--unsafe-fixes",
])
.pass_stdin("def add_to_list(item, some_list=[]): ..."),
@r###"
success: false
exit_code: 1
----- stdout -----
----- stderr -----
"###);
}
#[test]
fn diff_only_unsafe_fixes_available() {
assert_cmd_snapshot!(