Skip to content
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

Fix let keyword removal suggestion in structs #102927

Merged
merged 1 commit into from
Oct 12, 2022
Merged
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
17 changes: 11 additions & 6 deletions compiler/rustc_parse/src/parser/item.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1789,20 +1789,25 @@ impl<'a> Parser<'a> {
}
} else {
let mut err = self.expected_ident_found();
if let Some((ident, _)) = self.token.ident() && ident.as_str() == "let" {
self.bump(); // `let`
let span = self.prev_token.span.until(self.token.span);
if self.eat_keyword_noexpect(kw::Let)
&& let removal_span = self.prev_token.span.until(self.token.span)
&& let Ok(ident) = self.parse_ident_common(false)
// Cancel this error, we don't need it.
.map_err(|err| err.cancel())
&& self.token.kind == TokenKind::Colon
{
err.span_suggestion(
span,
"remove the let, the `let` keyword is not allowed in struct field definitions",
removal_span,
"remove this `let` keyword",
String::new(),
Applicability::MachineApplicable,
);
err.note("the `let` keyword is not allowed in `struct` fields");
err.note("see <https://doc.rust-lang.org/book/ch05-01-defining-structs.html> for more information");
err.emit();
self.bump();
return Ok(ident);
} else {
self.restore_snapshot(snapshot);
}
err
};
Expand Down
6 changes: 6 additions & 0 deletions src/test/ui/parser/bad-let-as-field.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
struct Foo {
let: i32,
//~^ ERROR expected identifier, found keyword
}

fn main() {}
15 changes: 15 additions & 0 deletions src/test/ui/parser/bad-let-as-field.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
error: expected identifier, found keyword `let`
--> $DIR/bad-let-as-field.rs:2:5
|
LL | struct Foo {
| --- while parsing this struct
LL | let: i32,
| ^^^ expected identifier, found keyword
|
help: escape `let` to use it as an identifier
|
LL | r#let: i32,
| ++

error: aborting due to previous error

12 changes: 12 additions & 0 deletions src/test/ui/parser/removed-syntax-field-let-2.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
struct Foo {
let x: i32,
//~^ ERROR expected identifier, found keyword
let y: i32,
//~^ ERROR expected identifier, found keyword
}

fn main() {
let _ = Foo {
//~^ ERROR missing fields `x` and `y` in initializer of `Foo`
};
}
33 changes: 33 additions & 0 deletions src/test/ui/parser/removed-syntax-field-let-2.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
error: expected identifier, found keyword `let`
--> $DIR/removed-syntax-field-let-2.rs:2:5
|
LL | let x: i32,
Copy link
Member Author

@compiler-errors compiler-errors Oct 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm actually not a fan of this 4-character wide removal span that overlaps (but isn't equal to) the let keyword span -- I feel like we don't usually care that spacing gets messed up by suggestions anyways, which is what this span is trying to account for.

I think we should just adjust the "remove this let keyword" span to remove just the let keyword, and the user can run rustfmt to fix the leftover spaces 😝 thoughts?

Copy link
Contributor

@gimbling-away gimbling-away Oct 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The running rustfmt part might not be ideal :P

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestions are not aware of global formatting rules, nor are they typically designed to handle cases where spacing, newlines, etc. are messed up because of code suggestions. At least, as long as the suggestion renders in a way that the user can understand, I feel like this is not the responsibility of the parser's error messages.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, for just diagnostics that makes sense. I'm more worried about cargo-fix fixing this and resulting in non-formatted code.

Copy link
Member Author

@compiler-errors compiler-errors Oct 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that rustfmt absolutely refuses to format a struct *file that has let ident: ty inside of it, I think formatting is a step that will need to be done regardless 😅

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a strong preference here - I'd probably bias towards keeping the four-character span. Feel free to change it if you want.

| ^^^-
| |
| expected identifier, found keyword
| help: remove this `let` keyword
|
= note: the `let` keyword is not allowed in `struct` fields
= note: see <https://doc.rust-lang.org/book/ch05-01-defining-structs.html> for more information

error: expected identifier, found keyword `let`
--> $DIR/removed-syntax-field-let-2.rs:4:5
|
LL | let y: i32,
| ^^^-
| |
| expected identifier, found keyword
| help: remove this `let` keyword
|
= note: the `let` keyword is not allowed in `struct` fields
= note: see <https://doc.rust-lang.org/book/ch05-01-defining-structs.html> for more information

error[E0063]: missing fields `x` and `y` in initializer of `Foo`
--> $DIR/removed-syntax-field-let-2.rs:9:13
|
LL | let _ = Foo {
| ^^^ missing `x` and `y`

error: aborting due to 3 previous errors

For more information about this error, try `rustc --explain E0063`.
10 changes: 4 additions & 6 deletions src/test/ui/parser/removed-syntax-field-let.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,13 @@ error: expected identifier, found keyword `let`
--> $DIR/removed-syntax-field-let.rs:2:5
|
LL | let foo: (),
| ^^^ expected identifier, found keyword
| ^^^-
| |
| expected identifier, found keyword
| help: remove this `let` keyword
|
= note: the `let` keyword is not allowed in `struct` fields
= note: see <https://doc.rust-lang.org/book/ch05-01-defining-structs.html> for more information
help: remove the let, the `let` keyword is not allowed in struct field definitions
|
LL - let foo: (),
LL + foo: (),
|

error: aborting due to previous error