bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Improve renaming suggestion for names with leading underscores

Browse source
This commit is contained in:
Lucas Scharenbroch 2024-05-30 21:39:12 -05:00
parent 434999efe6
commit 08fe940f0a
1 changed files with 24 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

22
compiler/rustc_resolve/src/diagnostics.rs
View file

@ -1562,6 +1562,9 @@ impl<'a, 'tcx> Resolver<'a, 'tcx> {
Some(suggestion) if suggestion.candidate == kw::Underscore => return false, Some(suggestion) if suggestion.candidate == kw::Underscore => return false,
Some(suggestion) => suggestion, Some(suggestion) => suggestion,
}; };
let mut did_label_def_span = false;
if let Some(def_span) = suggestion.res.opt_def_id().map(|def_id| self.def_span(def_id)) { if let Some(def_span) = suggestion.res.opt_def_id().map(|def_id| self.def_span(def_id)) {
if span.overlaps(def_span) { if span.overlaps(def_span) {
// Don't suggest typo suggestion for itself like in the following: // Don't suggest typo suggestion for itself like in the following:
@ -1595,25 +1598,30 @@ impl<'a, 'tcx> Resolver<'a, 'tcx> {
errors::DefinedHere::SingleItem { span, candidate_descr, candidate } errors::DefinedHere::SingleItem { span, candidate_descr, candidate }
} }
}; };
did_label_def_span = true;
err.subdiagnostic(self.tcx.dcx(), label); err.subdiagnostic(self.tcx.dcx(), label);
} }
let (span, sugg, post) = if let SuggestionTarget::SimilarlyNamed = suggestion.target let (span, msg, sugg) = if let SuggestionTarget::SimilarlyNamed = suggestion.target
&& let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span) && let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span)
&& let Some(span) = suggestion.span && let Some(span) = suggestion.span
&& let Some(candidate) = suggestion.candidate.as_str().strip_prefix('_') && let Some(candidate) = suggestion.candidate.as_str().strip_prefix('_')
&& snippet == candidate && snippet == candidate
{ {
let candidate = suggestion.candidate;
// When the suggested binding change would be from `x` to `_x`, suggest changing the // When the suggested binding change would be from `x` to `_x`, suggest changing the
// original binding definition instead. (#60164) // original binding definition instead. (#60164)
let post = format!(", consider renaming `{}` into `{snippet}`", suggestion.candidate); let msg = format!(
(span, snippet, post) "the leading underscore in `{candidate}` marks it as unused, consider renaming it to `{snippet}`"
);
if !did_label_def_span {
err.span_label(span, format!("`{candidate}` defined here"));
}
(span, msg, snippet)
} else { } else {
(span, suggestion.candidate.to_ident_string(), String::new())
};
let msg = match suggestion.target { let msg = match suggestion.target {
SuggestionTarget::SimilarlyNamed => format!( SuggestionTarget::SimilarlyNamed => format!(
"{} {} with a similar name exists{post}", "{} {} with a similar name exists",
suggestion.res.article(), suggestion.res.article(),
suggestion.res.descr() suggestion.res.descr()
), ),
@ -1621,6 +1629,8 @@ impl<'a, 'tcx> Resolver<'a, 'tcx> {
format!("maybe you meant this {}", suggestion.res.descr()) format!("maybe you meant this {}", suggestion.res.descr())
} }
}; };
(span, msg, suggestion.candidate.to_ident_string())
};
err.span_suggestion(span, msg, sugg, Applicability::MaybeIncorrect); err.span_suggestion(span, msg, sugg, Applicability::MaybeIncorrect);
true true
} }