Skip to content

Commit 8d4d572

Browse files
estebankestebank
committed
Fix msg for verbose suggestions with confusable capitalization
When encountering a verbose/multipart suggestion that has changes that are only caused by different capitalization of ASCII letters that have little differenciation, expand the message to highlight that fact (like we already do for inline suggestions). The logic to do this was already present, but implemented incorrectly.
1 parent eaff1af commit 8d4d572

9 files changed

+26
-24
lines changed

‎compiler/rustc_errors/src/emitter.rs

+10-9
Original file line numberDiff line numberDiff line change
@@ -1742,9 +1742,17 @@ impl HumanEmitter {
17421742
buffer.append(0, level.to_str(), Style::Level(*level));
17431743
buffer.append(0, ": ", Style::HeaderMsg);
17441744

1745+
let mut msg = vec![(suggestion.msg.to_owned(), Style::NoStyle)];
1746+
if suggestions
1747+
.iter()
1748+
.take(MAX_SUGGESTIONS)
1749+
.any(|(_, _, _, only_capitalization)| *only_capitalization)
1750+
{
1751+
msg.push((" (notice the capitalization difference)".into(), Style::NoStyle));
1752+
}
17451753
self.msgs_to_buffer(
17461754
&mut buffer,
1747-
&[(suggestion.msg.to_owned(), Style::NoStyle)],
1755+
&msg,
17481756
args,
17491757
max_line_num_len,
17501758
"suggestion",
@@ -1753,12 +1761,8 @@ impl HumanEmitter {
17531761

17541762
let mut row_num = 2;
17551763
draw_col_separator_no_space(&mut buffer, 1, max_line_num_len + 1);
1756-
let mut notice_capitalization = false;
1757-
for (complete, parts, highlights, only_capitalization) in
1758-
suggestions.iter().take(MAX_SUGGESTIONS)
1759-
{
1764+
for (complete, parts, highlights, _) in suggestions.iter().take(MAX_SUGGESTIONS) {
17601765
debug!(?complete, ?parts, ?highlights);
1761-
notice_capitalization |= only_capitalization;
17621766

17631767
let has_deletion = parts.iter().any(|p| p.is_deletion(sm));
17641768
let is_multiline = complete.lines().count() > 1;
@@ -2057,9 +2061,6 @@ impl HumanEmitter {
20572061
let others = suggestions.len() - MAX_SUGGESTIONS;
20582062
let msg = format!("and {} other candidate{}", others, pluralize!(others));
20592063
buffer.puts(row_num, max_line_num_len + 3, &msg, Style::NoStyle);
2060-
} else if notice_capitalization {
2061-
let msg = "notice the capitalization difference";
2062-
buffer.puts(row_num, max_line_num_len + 3, msg, Style::NoStyle);
20632064
}
20642065
emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?;
20652066
Ok(())

‎compiler/rustc_errors/src/lib.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,9 @@ impl CodeSuggestion {
319319
// We need to keep track of the difference between the existing code and the added
320320
// or deleted code in order to point at the correct column *after* substitution.
321321
let mut acc = 0;
322+
let mut only_capitalization = false;
322323
for part in &substitution.parts {
324+
only_capitalization |= is_case_difference(sm, &part.snippet, part.span);
323325
let cur_lo = sm.lookup_char_pos(part.span.lo());
324326
if prev_hi.line == cur_lo.line {
325327
let mut count =
@@ -392,7 +394,6 @@ impl CodeSuggestion {
392394
}
393395
}
394396
highlights.push(std::mem::take(&mut line_highlight));
395-
let only_capitalization = is_case_difference(sm, &buf, bounding_span);
396397
// if the replacement already ends with a newline, don't print the next line
397398
if !buf.ends_with('\n') {
398399
push_trailing(&mut buf, prev_line.as_ref(), &prev_hi, None);

‎src/tools/clippy/tests/ui/match_str_case_mismatch.stderr

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ error: this `match` arm has a differing case than its expression
1717
LL | "~!@#$%^&*()-_=+Foo" => {},
1818
| ^^^^^^^^^^^^^^^^^^^^
1919
|
20-
help: consider changing the case of this arm to respect `to_ascii_lowercase`
20+
help: consider changing the case of this arm to respect `to_ascii_lowercase` (notice the capitalization difference)
2121
|
2222
LL | "~!@#$%^&*()-_=+foo" => {},
2323
| ~~~~~~~~~~~~~~~~~~~~

‎tests/ui/error-codes/E0423.stderr

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ help: use struct literal syntax instead
5353
|
5454
LL | let f = Foo { a: val };
5555
| ~~~~~~~~~~~~~~
56-
help: a function with a similar name exists
56+
help: a function with a similar name exists (notice the capitalization difference)
5757
|
5858
LL | let f = foo();
5959
| ~~~

‎tests/ui/parser/kw-in-trait-bounds.stderr

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ error: expected identifier, found keyword `fn`
44
LL | fn _f<F: fn(), G>(_: impl fn(), _: &dyn fn())
55
| ^^
66
|
7-
help: use `Fn` to refer to the trait
7+
help: use `Fn` to refer to the trait (notice the capitalization difference)
88
|
99
LL | fn _f<F: Fn(), G>(_: impl fn(), _: &dyn fn())
1010
| ~~
@@ -15,7 +15,7 @@ error: expected identifier, found keyword `fn`
1515
LL | fn _f<F: fn(), G>(_: impl fn(), _: &dyn fn())
1616
| ^^
1717
|
18-
help: use `Fn` to refer to the trait
18+
help: use `Fn` to refer to the trait (notice the capitalization difference)
1919
|
2020
LL | fn _f<F: fn(), G>(_: impl Fn(), _: &dyn fn())
2121
| ~~
@@ -26,7 +26,7 @@ error: expected identifier, found keyword `fn`
2626
LL | fn _f<F: fn(), G>(_: impl fn(), _: &dyn fn())
2727
| ^^
2828
|
29-
help: use `Fn` to refer to the trait
29+
help: use `Fn` to refer to the trait (notice the capitalization difference)
3030
|
3131
LL | fn _f<F: fn(), G>(_: impl fn(), _: &dyn Fn())
3232
| ~~
@@ -37,7 +37,7 @@ error: expected identifier, found keyword `fn`
3737
LL | G: fn(),
3838
| ^^
3939
|
40-
help: use `Fn` to refer to the trait
40+
help: use `Fn` to refer to the trait (notice the capitalization difference)
4141
|
4242
LL | G: Fn(),
4343
| ~~

‎tests/ui/parser/recover/recover-fn-trait-from-fn-kw.stderr

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ error: expected identifier, found keyword `fn`
44
LL | fn foo(_: impl fn() -> i32) {}
55
| ^^
66
|
7-
help: use `Fn` to refer to the trait
7+
help: use `Fn` to refer to the trait (notice the capitalization difference)
88
|
99
LL | fn foo(_: impl Fn() -> i32) {}
1010
| ~~
@@ -15,7 +15,7 @@ error: expected identifier, found keyword `fn`
1515
LL | fn foo2<T: fn(i32)>(_: T) {}
1616
| ^^
1717
|
18-
help: use `Fn` to refer to the trait
18+
help: use `Fn` to refer to the trait (notice the capitalization difference)
1919
|
2020
LL | fn foo2<T: Fn(i32)>(_: T) {}
2121
| ~~

‎tests/ui/parser/typod-const-in-const-param-def.stderr

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ error: `const` keyword was mistyped as `Const`
44
LL | pub fn foo<Const N: u8>() {}
55
| ^^^^^
66
|
7-
help: use the `const` keyword
7+
help: use the `const` keyword (notice the capitalization difference)
88
|
99
LL | pub fn foo<const N: u8>() {}
1010
| ~~~~~
@@ -15,7 +15,7 @@ error: `const` keyword was mistyped as `Const`
1515
LL | pub fn baz<Const N: u8, T>() {}
1616
| ^^^^^
1717
|
18-
help: use the `const` keyword
18+
help: use the `const` keyword (notice the capitalization difference)
1919
|
2020
LL | pub fn baz<const N: u8, T>() {}
2121
| ~~~~~
@@ -26,7 +26,7 @@ error: `const` keyword was mistyped as `Const`
2626
LL | pub fn qux<T, Const N: u8>() {}
2727
| ^^^^^
2828
|
29-
help: use the `const` keyword
29+
help: use the `const` keyword (notice the capitalization difference)
3030
|
3131
LL | pub fn qux<T, const N: u8>() {}
3232
| ~~~~~
@@ -37,7 +37,7 @@ error: `const` keyword was mistyped as `Const`
3737
LL | pub fn quux<T, Const N: u8, U>() {}
3838
| ^^^^^
3939
|
40-
help: use the `const` keyword
40+
help: use the `const` keyword (notice the capitalization difference)
4141
|
4242
LL | pub fn quux<T, const N: u8, U>() {}
4343
| ~~~~~

‎tests/ui/suggestions/assoc-ct-for-assoc-method.stderr

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ LL | let x: i32 = MyS::foo;
88
|
99
= note: expected type `i32`
1010
found fn item `fn() -> MyS {MyS::foo}`
11-
help: try referring to the associated const `FOO` instead
11+
help: try referring to the associated const `FOO` instead (notice the capitalization difference)
1212
|
1313
LL | let x: i32 = MyS::FOO;
1414
| ~~~

‎tests/ui/suggestions/bool_typo_err_suggest.stderr

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ error[E0425]: cannot find value `False` in this scope
1515
LL | let y = False;
1616
| ^^^^^ not found in this scope
1717
|
18-
help: you may want to use a bool value instead
18+
help: you may want to use a bool value instead (notice the capitalization difference)
1919
|
2020
LL | let y = false;
2121
| ~~~~~

0 commit comments

Comments
 (0)