Skip to content

Commit

Permalink
Rollup merge of #137356 - nik-rev:FERRIS, r=compiler-errors
Browse files Browse the repository at this point in the history
Ferris 🦀 Identifier naming conventions

You cannot use Ferris as an identifier in Rust, this code will suggest to correct the  🦀 to `ferris`:

```rs
fn main() {
  let  🦀 = 4;
}
```

But it also suggests to correct to `ferris` in these cases, too:

```rs
struct  🦀 {}
fn main() {}
```

^ suggests: `ferris`
~ with this PR: `Ferris`

```rs
static 🦀: &str = "ferris!";
fn main() {}
```

^ suggests: `ferris`
~ with this PR: `FERRIS`

This is my first pull requests here!
  • Loading branch information
matthiaskrgr authored Feb 22, 2025
2 parents 37e0d13 + ec88bc2 commit 72e41e5
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 2 deletions.
3 changes: 2 additions & 1 deletion compiler/rustc_interface/src/errors.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ pub(crate) struct CrateNameInvalid<'a> {
pub struct FerrisIdentifier {
#[primary_span]
pub spans: Vec<Span>,
#[suggestion(code = "ferris", applicability = "maybe-incorrect")]
#[suggestion(code = "{ferris_fix}", applicability = "maybe-incorrect")]
pub first_span: Span,
pub ferris_fix: &'static str,
}

#[derive(Diagnostic)]
Expand Down
35 changes: 34 additions & 1 deletion compiler/rustc_interface/src/passes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -305,8 +305,41 @@ fn early_lint_checks(tcx: TyCtxt<'_>, (): ()) {
for (ident, mut spans) in identifiers.drain(..) {
spans.sort();
if ident == sym::ferris {
enum FerrisFix {
SnakeCase,
ScreamingSnakeCase,
PascalCase,
}

impl FerrisFix {
const fn as_str(self) -> &'static str {
match self {
FerrisFix::SnakeCase => "ferris",
FerrisFix::ScreamingSnakeCase => "FERRIS",
FerrisFix::PascalCase => "Ferris",
}
}
}

let first_span = spans[0];
sess.dcx().emit_err(errors::FerrisIdentifier { spans, first_span });
let prev_source = sess.psess.source_map().span_to_prev_source(first_span);
let ferris_fix = prev_source
.map_or(FerrisFix::SnakeCase, |source| {
let mut source_before_ferris = source.trim_end().split_whitespace().rev();
match source_before_ferris.next() {
Some("struct" | "trait" | "mod" | "union" | "type" | "enum") => {
FerrisFix::PascalCase
}
Some("const" | "static") => FerrisFix::ScreamingSnakeCase,
Some("mut") if source_before_ferris.next() == Some("static") => {
FerrisFix::ScreamingSnakeCase
}
_ => FerrisFix::SnakeCase,
}
})
.as_str();

sess.dcx().emit_err(errors::FerrisIdentifier { spans, first_span, ferris_fix });
} else {
sess.dcx().emit_err(errors::EmojiIdentifier { spans, ident });
}
Expand Down
3 changes: 3 additions & 0 deletions tests/ui/parser/ferris-static-mut.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
static mut 🦀: &str = "ferris!";//~ ERROR Ferris cannot be used as an identifier

fn main() {}
8 changes: 8 additions & 0 deletions tests/ui/parser/ferris-static-mut.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
error: Ferris cannot be used as an identifier
--> $DIR/ferris-static-mut.rs:1:12
|
LL | static mut 🦀: &str = "ferris!";
| ^^ help: try using their name instead: `FERRIS`

error: aborting due to 1 previous error

3 changes: 3 additions & 0 deletions tests/ui/parser/ferris-struct.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
struct 🦀 {}//~ ERROR Ferris cannot be used as an identifier

fn main() {}
8 changes: 8 additions & 0 deletions tests/ui/parser/ferris-struct.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
error: Ferris cannot be used as an identifier
--> $DIR/ferris-struct.rs:1:8
|
LL | struct 🦀 {}
| ^^ help: try using their name instead: `Ferris`

error: aborting due to 1 previous error

0 comments on commit 72e41e5

Please sign in to comment.