fix: Add missing fields diagnostic fix for patterns

This commit is contained in:
Lukas Wirth 2022-04-03 15:11:04 +02:00
parent 1da2d82f58
commit dd3f7664fd
4 changed files with 184 additions and 62 deletions

View file

@ -9,7 +9,7 @@ use stdx::format_to;
use syntax::{ use syntax::{
algo, algo,
ast::{self, make}, ast::{self, make},
AstNode, SyntaxNodePtr, AstNode, SyntaxNode, SyntaxNodePtr,
}; };
use text_edit::TextEdit; use text_edit::TextEdit;
@ -55,70 +55,95 @@ fn fixes(ctx: &DiagnosticsContext<'_>, d: &hir::MissingFields) -> Option<Vec<Ass
} }
let root = ctx.sema.db.parse_or_expand(d.file)?; let root = ctx.sema.db.parse_or_expand(d.file)?;
let field_list_parent = match &d.field_list_parent {
Either::Left(record_expr) => record_expr.to_node(&root),
// FIXE: patterns should be fixable as well.
Either::Right(_) => return None,
};
let old_field_list = field_list_parent.record_expr_field_list()?;
let new_field_list = old_field_list.clone_for_update(); let build_text_edit = |parent_syntax, new_syntax: &SyntaxNode, old_syntax| {
let mut locals = FxHashMap::default(); let edit = {
ctx.sema.scope(field_list_parent.syntax())?.process_all_names(&mut |name, def| { let mut builder = TextEdit::builder();
if let hir::ScopeDef::Local(local) = def { if d.file.is_macro() {
locals.insert(name, local); // we can't map the diff up into the macro input unfortunately, as the macro loses all
} // whitespace information so the diff wouldn't be applicable no matter what
}); // This has the downside that the cursor will be moved in macros by doing it without a diff
let missing_fields = ctx.sema.record_literal_missing_fields(&field_list_parent); // but that is a trade off we can make.
// FIXME: this also currently discards a lot of whitespace in the input... we really need a formatter here
let generate_fill_expr = |ty: &Type| match ctx.config.expr_fill_default { let range = ctx.sema.original_range_opt(old_syntax)?;
crate::ExprFillDefaultMode::Todo => Some(make::ext::expr_todo()), builder.replace(range.range, new_syntax.to_string());
crate::ExprFillDefaultMode::Default => {
let default_constr = get_default_constructor(ctx, d, ty);
match default_constr {
Some(default_constr) => Some(default_constr),
_ => Some(make::ext::expr_todo()),
}
}
};
for (f, ty) in missing_fields.iter() {
let field_expr = if let Some(local_candidate) = locals.get(&f.name(ctx.sema.db)) {
cov_mark::hit!(field_shorthand);
let candidate_ty = local_candidate.ty(ctx.sema.db);
if ty.could_unify_with(ctx.sema.db, &candidate_ty) {
None
} else { } else {
generate_fill_expr(ty) algo::diff(old_syntax, new_syntax).into_text_edit(&mut builder);
} }
} else { builder.finish()
generate_fill_expr(ty)
}; };
let field = Some(vec![fix(
make::record_expr_field(make::name_ref(&f.name(ctx.sema.db).to_smol_str()), field_expr) "fill_missing_fields",
.clone_for_update(); "Fill struct fields",
new_field_list.add_field(field); SourceChange::from_text_edit(d.file.original_file(ctx.sema.db), edit),
} ctx.sema.original_range(parent_syntax).range,
)])
};
let mut builder = TextEdit::builder(); match &d.field_list_parent {
if d.file.is_macro() { Either::Left(record_expr) => {
// we can't map the diff up into the macro input unfortunately, as the macro loses all let field_list_parent = record_expr.to_node(&root);
// whitespace information so the diff wouldn't be applicable no matter what let missing_fields = ctx.sema.record_literal_missing_fields(&field_list_parent);
// This has the downside that the cursor will be moved in macros by doing it without a diff
// but that is a trade off we can make. let mut locals = FxHashMap::default();
// FIXE: this also currently discards a lot of whitespace in the input... we really need a formatter here ctx.sema.scope(field_list_parent.syntax())?.process_all_names(&mut |name, def| {
let range = ctx.sema.original_range_opt(old_field_list.syntax())?; if let hir::ScopeDef::Local(local) = def {
builder.replace(range.range, new_field_list.to_string()); locals.insert(name, local);
} else { }
algo::diff(old_field_list.syntax(), new_field_list.syntax()).into_text_edit(&mut builder); });
let generate_fill_expr = |ty: &Type| match ctx.config.expr_fill_default {
crate::ExprFillDefaultMode::Todo => make::ext::expr_todo(),
crate::ExprFillDefaultMode::Default => {
get_default_constructor(ctx, d, ty).unwrap_or_else(|| make::ext::expr_todo())
}
};
let old_field_list = field_list_parent.record_expr_field_list()?;
let new_field_list = old_field_list.clone_for_update();
for (f, ty) in missing_fields.iter() {
let field_expr = if let Some(local_candidate) = locals.get(&f.name(ctx.sema.db)) {
cov_mark::hit!(field_shorthand);
let candidate_ty = local_candidate.ty(ctx.sema.db);
if ty.could_unify_with(ctx.sema.db, &candidate_ty) {
None
} else {
Some(generate_fill_expr(ty))
}
} else {
Some(generate_fill_expr(ty))
};
let field = make::record_expr_field(
make::name_ref(&f.name(ctx.sema.db).to_smol_str()),
field_expr,
);
new_field_list.add_field(field.clone_for_update());
}
build_text_edit(
field_list_parent.syntax(),
new_field_list.syntax(),
old_field_list.syntax(),
)
}
Either::Right(record_pat) => {
let field_list_parent = record_pat.to_node(&root);
let missing_fields = ctx.sema.record_pattern_missing_fields(&field_list_parent);
let old_field_list = field_list_parent.record_pat_field_list()?;
let new_field_list = old_field_list.clone_for_update();
for (f, _) in missing_fields.iter() {
let field = make::record_pat_field_shorthand(make::name_ref(
&f.name(ctx.sema.db).to_smol_str(),
));
new_field_list.add_field(field.clone_for_update());
}
build_text_edit(
field_list_parent.syntax(),
new_field_list.syntax(),
old_field_list.syntax(),
)
}
} }
let edit = builder.finish();
Some(vec![fix(
"fill_missing_fields",
"Fill struct fields",
SourceChange::from_text_edit(d.file.original_file(ctx.sema.db), edit),
ctx.sema.original_range(field_list_parent.syntax()).range,
)])
} }
fn make_ty(ty: &hir::Type, db: &dyn HirDatabase, module: hir::Module) -> ast::Type { fn make_ty(ty: &hir::Type, db: &dyn HirDatabase, module: hir::Module) -> ast::Type {
@ -190,7 +215,7 @@ mod tests {
struct S { foo: i32, bar: () } struct S { foo: i32, bar: () }
fn baz(s: S) { fn baz(s: S) {
let S { foo: _ } = s; let S { foo: _ } = s;
//^ error: missing structure fields: //^ 💡 error: missing structure fields:
//| - bar //| - bar
} }
"#, "#,
@ -581,6 +606,56 @@ fn f() {
); );
} }
#[test]
fn test_fill_struct_pat_fields() {
check_fix(
r#"
struct S { a: &'static str, b: i32 }
fn f() {
let S {
$0
};
}
"#,
r#"
struct S { a: &'static str, b: i32 }
fn f() {
let S {
a,
b,
};
}
"#,
);
}
#[test]
fn test_fill_struct_pat_fields_partial() {
check_fix(
r#"
struct S { a: &'static str, b: i32 }
fn f() {
let S {
a,$0
};
}
"#,
r#"
struct S { a: &'static str, b: i32 }
fn f() {
let S {
a,
b,
};
}
"#,
);
}
#[test] #[test]
fn import_extern_crate_clash_with_inner_item() { fn import_extern_crate_clash_with_inner_item() {
// This is more of a resolver test, but doesn't really work with the hir_def testsuite. // This is more of a resolver test, but doesn't really work with the hir_def testsuite.

View file

@ -396,14 +396,14 @@ fn main() {
//^ error: missing match arm //^ error: missing match arm
match a { match a {
Either::A { } => (), Either::A { } => (),
//^^^^^^^^^ error: missing structure fields: //^^^^^^^^^ 💡 error: missing structure fields:
// | - foo // | - foo
Either::B => (), Either::B => (),
} }
match a { match a {
//^ error: missing match arm //^ error: missing match arm
Either::A { } => (), Either::A { } => (),
} //^^^^^^^^^ error: missing structure fields: } //^^^^^^^^^ 💡 error: missing structure fields:
// | - foo // | - foo
match a { match a {

View file

@ -546,6 +546,49 @@ impl ast::RecordExprField {
} }
} }
impl ast::RecordPatFieldList {
pub fn add_field(&self, field: ast::RecordPatField) {
let is_multiline = self.syntax().text().contains_char('\n');
let whitespace = if is_multiline {
let indent = IndentLevel::from_node(self.syntax()) + 1;
make::tokens::whitespace(&format!("\n{}", indent))
} else {
make::tokens::single_space()
};
if is_multiline {
normalize_ws_between_braces(self.syntax());
}
let position = match self.fields().last() {
Some(last_field) => {
let comma = match last_field
.syntax()
.siblings_with_tokens(Direction::Next)
.filter_map(|it| it.into_token())
.find(|it| it.kind() == T![,])
{
Some(it) => it,
None => {
let comma = ast::make::token(T![,]);
ted::insert(Position::after(last_field.syntax()), &comma);
comma
}
};
Position::after(comma)
}
None => match self.l_curly_token() {
Some(it) => Position::after(it),
None => Position::last_child_of(self.syntax()),
},
};
ted::insert_all(position, vec![whitespace.into(), field.syntax().clone().into()]);
if is_multiline {
ted::insert(Position::after(field.syntax()), ast::make::token(T![,]));
}
}
}
impl ast::StmtList { impl ast::StmtList {
pub fn push_front(&self, statement: ast::Stmt) { pub fn push_front(&self, statement: ast::Stmt) {
ted::insert(Position::after(self.l_curly_token().unwrap()), statement.syntax()); ted::insert(Position::after(self.l_curly_token().unwrap()), statement.syntax());

View file

@ -555,6 +555,10 @@ pub fn record_pat_field(name_ref: ast::NameRef, pat: ast::Pat) -> ast::RecordPat
ast_from_text(&format!("fn f(S {{ {}: {} }}: ()))", name_ref, pat)) ast_from_text(&format!("fn f(S {{ {}: {} }}: ()))", name_ref, pat))
} }
pub fn record_pat_field_shorthand(name_ref: ast::NameRef) -> ast::RecordPatField {
ast_from_text(&format!("fn f(S {{ {} }}: ()))", name_ref))
}
/// Returns a `BindPat` if the path has just one segment, a `PathPat` otherwise. /// Returns a `BindPat` if the path has just one segment, a `PathPat` otherwise.
pub fn path_pat(path: ast::Path) -> ast::Pat { pub fn path_pat(path: ast::Path) -> ast::Pat {
return from_text(&path.to_string()); return from_text(&path.to_string());