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

Add a suggestion if macro_rules is misspelled #91337

Merged
merged 1 commit into from Dec 9, 2021
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 25 additions & 4 deletions compiler/rustc_parse/src/parser/item.rs
Expand Up @@ -15,6 +15,7 @@ use rustc_ast::{MacArgs, MacCall, MacDelimiter};
use rustc_ast_pretty::pprust;
use rustc_errors::{struct_span_err, Applicability, PResult, StashKey};
use rustc_span::edition::{Edition, LATEST_STABLE_EDITION};
use rustc_span::lev_distance::lev_distance;
use rustc_span::source_map::{self, Span};
use rustc_span::symbol::{kw, sym, Ident, Symbol};

Expand Down Expand Up @@ -407,10 +408,30 @@ impl<'a> Parser<'a> {
fn parse_item_macro(&mut self, vis: &Visibility) -> PResult<'a, MacCall> {
let path = self.parse_path(PathStyle::Mod)?; // `foo::bar`
self.expect(&token::Not)?; // `!`
let args = self.parse_mac_args()?; // `( .. )` or `[ .. ]` (followed by `;`), or `{ .. }`.
self.eat_semi_for_macro_if_needed(&args);
self.complain_if_pub_macro(vis, false);
Ok(MacCall { path, args, prior_type_ascription: self.last_type_ascription })
match self.parse_mac_args() {
// `( .. )` or `[ .. ]` (followed by `;`), or `{ .. }`.
Ok(args) => {
self.eat_semi_for_macro_if_needed(&args);
self.complain_if_pub_macro(vis, false);
Ok(MacCall { path, args, prior_type_ascription: self.last_type_ascription })
}

Err(mut err) => {
// Maybe the user misspelled `macro_rules` (issue #91227)
if self.token.is_ident()
&& path.segments.len() == 1
&& lev_distance("macro_rules", &path.segments[0].ident.to_string()) <= 3
{
err.span_suggestion(
path.span,
"perhaps you meant to define a macro",
"macro_rules".to_string(),
Applicability::MachineApplicable,
);
}
Err(err)
}
}
}

/// Recover if we parsed attributes and expected an item but there was none.
Expand Down
13 changes: 13 additions & 0 deletions src/test/ui/parser/misspelled-macro-rules.fixed
@@ -0,0 +1,13 @@
// Regression test for issue #91227.

// run-rustfix

#![allow(unused_macros)]

macro_rules! thing {
//~^ ERROR: expected one of
//~| HELP: perhaps you meant to define a macro
() => {}
}

fn main() {}
13 changes: 13 additions & 0 deletions src/test/ui/parser/misspelled-macro-rules.rs
@@ -0,0 +1,13 @@
// Regression test for issue #91227.

// run-rustfix

#![allow(unused_macros)]

marco_rules! thing {
//~^ ERROR: expected one of
//~| HELP: perhaps you meant to define a macro
() => {}
}

fn main() {}
10 changes: 10 additions & 0 deletions src/test/ui/parser/misspelled-macro-rules.stderr
@@ -0,0 +1,10 @@
error: expected one of `(`, `[`, or `{`, found `thing`
--> $DIR/misspelled-macro-rules.rs:7:14
|
LL | marco_rules! thing {
| ----------- ^^^^^ expected one of `(`, `[`, or `{`
| |
| help: perhaps you meant to define a macro: `macro_rules`

error: aborting due to previous error