Skip to content

Give a better diagnostic for keywords with incorrect capitalization #79746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 37 additions & 10 deletions compiler/rustc_parse/src/parser/diagnostics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,12 @@ impl<'a> Parser<'a> {
})
}

let prev_token_to_string = pprust::token_kind_to_string(&self.prev_token.kind);
let prev_token_seems_reserved_token = !self.prev_token.is_path_segment_keyword()
&& self.prev_token.is_ident()
&& Ident::from_str(&prev_token_to_string.to_lowercase()).is_reserved()
&& prev_token_to_string != prev_token_to_string.to_lowercase();

let mut expected = edible
.iter()
.map(|x| TokenType::Token(x.clone()))
Expand All @@ -246,15 +252,28 @@ impl<'a> Parser<'a> {
let expect = tokens_to_string(&expected[..]);
let actual = super::token_descr(&self.token);
let (msg_exp, (label_sp, label_exp)) = if expected.len() > 1 {
let short_expect = if expected.len() > 6 {
format!("{} possible tokens", expected.len())
if prev_token_seems_reserved_token {
(
format!("`{:?}` is not a keyword", prev_token_to_string),
(
self.prev_token.span,
format!("try `{:?}` instead", prev_token_to_string.to_lowercase()),
),
)
} else {
expect.clone()
};
(
format!("expected one of {}, found {}", expect, actual),
(self.prev_token.span.shrink_to_hi(), format!("expected one of {}", short_expect)),
)
let short_expect = if expected.len() > 6 {
format!("{} possible tokens", expected.len())
} else {
expect.clone()
};
(
format!("expected one of {}, found {}", expect, actual),
(
self.prev_token.span.shrink_to_hi(),
format!("expected one of {}", short_expect),
),
)
}
} else if expected.is_empty() {
(
format!("unexpected token: {}", actual),
Expand All @@ -267,13 +286,19 @@ impl<'a> Parser<'a> {
)
};
self.last_unexpected_token_span = Some(self.token.span);
let mut err = self.struct_span_err(self.token.span, &msg_exp);
let mut err = if !prev_token_seems_reserved_token {
self.struct_span_err(self.token.span, &msg_exp)
} else {
self.struct_span_err(self.prev_token.span, &msg_exp)
};

let sp = if self.token == token::Eof {
// This is EOF; don't want to point at the following char, but rather the last token.
self.prev_token.span
} else {
label_sp
};

match self.recover_closing_delimiter(
&expected
.iter()
Expand All @@ -295,7 +320,9 @@ impl<'a> Parser<'a> {
}

let sm = self.sess.source_map();
if self.prev_token.span == DUMMY_SP {
if prev_token_seems_reserved_token {
err.span_label(self.prev_token.span, label_exp);
} else if self.prev_token.span == DUMMY_SP {
// Account for macro context where the previous span might not be
// available to avoid incorrect output (#54841).
err.span_label(self.token.span, label_exp);
Expand Down
5 changes: 5 additions & 0 deletions src/test/ui/parser/mistyped_reserved_token.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
fn main() {
let a = While true { //~ ERROR
break;
};
}
8 changes: 8 additions & 0 deletions src/test/ui/parser/mistyped_reserved_token.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
error: `"While"` is not a keyword
--> $DIR/mistyped_reserved_token.rs:2:13
|
LL | let a = While true {
| ^^^^^ try `"while"` instead

error: aborting due to previous error