Skip to content

Suggest renaming or escaping when fixing non-snake-case identifiers which would conflict with keywords #80592

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

Merged
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
19 changes: 17 additions & 2 deletions compiler/rustc_lint/src/nonstandard_style.rs
Original file line number Diff line number Diff line change
Expand Up @@ -275,10 +275,25 @@ impl NonSnakeCase {
// We have a valid span in almost all cases, but we don't have one when linting a crate
// name provided via the command line.
if !ident.span.is_dummy() {
let sc_ident = Ident::from_str_and_span(&sc, ident.span);
let (message, suggestion) = if sc_ident.is_reserved() {
// We shouldn't suggest a reserved identifier to fix non-snake-case identifiers.
// Instead, recommend renaming the identifier entirely or, if permitted,
// escaping it to create a raw identifier.
if sc_ident.name.can_be_raw() {
("rename the identifier or convert it to a snake case raw identifier", sc_ident.to_string())
} else {
err.note(&format!("`{}` cannot be used as a raw identifier", sc));
("rename the identifier", String::new())
}
} else {
("convert the identifier to snake case", sc)
};

err.span_suggestion(
ident.span,
"convert the identifier to snake case",
sc,
message,
suggestion,
Applicability::MaybeIncorrect,
);
} else {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#![warn(unused)]
#![allow(dead_code)]
#![deny(non_snake_case)]

mod Impl {}
//~^ ERROR module `Impl` should have a snake case name

fn While() {}
//~^ ERROR function `While` should have a snake case name

fn main() {
let Mod: usize = 0;
//~^ ERROR variable `Mod` should have a snake case name
//~^^ WARN unused variable: `Mod`

let Super: usize = 0;
//~^ ERROR variable `Super` should have a snake case name
//~^^ WARN unused variable: `Super`
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
warning: unused variable: `Mod`
--> $DIR/lint-non-snake-case-identifiers-suggestion-reserved.rs:12:9
|
LL | let Mod: usize = 0;
| ^^^ help: if this is intentional, prefix it with an underscore: `_Mod`
|
note: the lint level is defined here
--> $DIR/lint-non-snake-case-identifiers-suggestion-reserved.rs:1:9
|
LL | #![warn(unused)]
| ^^^^^^
= note: `#[warn(unused_variables)]` implied by `#[warn(unused)]`

warning: unused variable: `Super`
--> $DIR/lint-non-snake-case-identifiers-suggestion-reserved.rs:16:9
|
LL | let Super: usize = 0;
| ^^^^^ help: if this is intentional, prefix it with an underscore: `_Super`

error: module `Impl` should have a snake case name
--> $DIR/lint-non-snake-case-identifiers-suggestion-reserved.rs:5:5
|
LL | mod Impl {}
| ^^^^
|
note: the lint level is defined here
--> $DIR/lint-non-snake-case-identifiers-suggestion-reserved.rs:3:9
|
LL | #![deny(non_snake_case)]
| ^^^^^^^^^^^^^^
help: rename the identifier or convert it to a snake case raw identifier
|
LL | mod r#impl {}
| ^^^^^^

error: function `While` should have a snake case name
--> $DIR/lint-non-snake-case-identifiers-suggestion-reserved.rs:8:4
|
LL | fn While() {}
| ^^^^^
|
help: rename the identifier or convert it to a snake case raw identifier
|
LL | fn r#while() {}
| ^^^^^^^

error: variable `Mod` should have a snake case name
--> $DIR/lint-non-snake-case-identifiers-suggestion-reserved.rs:12:9
|
LL | let Mod: usize = 0;
| ^^^
|
help: rename the identifier or convert it to a snake case raw identifier
|
LL | let r#mod: usize = 0;
| ^^^^^

error: variable `Super` should have a snake case name
--> $DIR/lint-non-snake-case-identifiers-suggestion-reserved.rs:16:9
|
LL | let Super: usize = 0;
| ^^^^^ help: rename the identifier
Comment on lines +61 to +62
Copy link
Contributor

@PatchMixolydic PatchMixolydic Jan 2, 2021

Choose a reason for hiding this comment

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

It may be helpful to emit a note along the lines of super cannot be used as a raw identifier in this case so the user doesn't fruitlessly try to do so.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea, thanks! Added in 750c52a

|
= note: `super` cannot be used as a raw identifier

error: aborting due to 4 previous errors; 2 warnings emitted