Skip to content

fix: skip the generate function assist when dealing with an enum variant #11995

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

Closed
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
169 changes: 169 additions & 0 deletions crates/ide_assists/src/handlers/generate_enum_variant.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
use hir::HasSource;
use ide_db::assists::{AssistId, AssistKind};
use syntax::{
ast::{self, edit::IndentLevel},
AstNode, TextRange, TextSize,
};

use crate::assist_context::{AssistContext, Assists};

pub(crate) fn generate_enum_variant(acc: &mut Assists, ctx: &AssistContext) -> Option<()> {
let path_expr: ast::PathExpr = ctx.find_node_at_offset()?;
let path = path_expr.path()?;

if ctx.sema.resolve_path(&path).is_some() {
// No need to generate anything if the path resolves.
return None;
}

let name_ref = path.segment()?.name_ref()?;
if let Some(hir::PathResolution::Def(hir::ModuleDef::Adt(hir::Adt::Enum(e)))) =
ctx.sema.resolve_path(&path.qualifier()?)
{
let target = path.syntax().text_range();
return add_variant_to_accumulator(acc, ctx, target, e, &name_ref);
}

None
}

fn add_variant_to_accumulator(
acc: &mut Assists,
ctx: &AssistContext,
target: TextRange,
adt: hir::Enum,
name_ref: &ast::NameRef,
) -> Option<()> {
let adt_ast = get_enum_ast(ctx, adt)?;

let enum_indent_level = IndentLevel::from_node(&adt_ast.syntax());

let offset = adt_ast.variant_list()?.syntax().text_range().end() - TextSize::of('}');

let prefix = if adt_ast.variant_list()?.variants().next().is_none() {
format!("\n{}", IndentLevel(1))
} else {
format!("{}", IndentLevel(1))
};
let text = format!("{}{},\n{}", prefix, name_ref, enum_indent_level);

acc.add(
AssistId("generate_variant", AssistKind::Generate),
"Generate variant",
target,
|builder| {
builder.insert(offset, text);
},
)
}

fn get_enum_ast(ctx: &AssistContext, adt: hir::Enum) -> Option<ast::Enum> {
let range = adt.source(ctx.db())?.syntax().original_file_range(ctx.db());
let file = ctx.sema.parse(range.file_id);
let adt_ast: ast::Enum =
ctx.sema.find_node_at_offset_with_macros(file.syntax(), range.range.start())?;

Some(adt_ast)
Comment on lines +61 to +66
Copy link
Member

Choose a reason for hiding this comment

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

This can be simplified with

adt.source(ctx.db())?.original_ast_node(ctx.db())?

}

#[cfg(test)]
mod tests {
use crate::tests::{check_assist, check_assist_not_applicable};

use super::*;

#[test]
fn generate_basic_enum_variant_in_empty_enum() {
check_assist(
generate_enum_variant,
r"
enum Foo {}

fn main() {
Foo::Bar$0
}
",
r"
enum Foo {
Bar,
}

fn main() {
Foo::Bar
}
",
)
}

#[test]
fn generate_basic_enum_variant_in_non_empty_enum() {
check_assist(
generate_enum_variant,
r"
enum Foo {
Bar,
}

fn main() {
Foo::Baz$0
}
",
r"
enum Foo {
Bar,
Baz,
}

fn main() {
Foo::Baz
}
",
)
}

#[test]
fn not_applicable_for_existing_variant() {
check_assist_not_applicable(
generate_enum_variant,
r"
enum Foo {
Bar,
}

fn main() {
Foo::Bar$0
}
",
)
}

#[test]
fn indentation_level_is_correct() {
check_assist(
generate_enum_variant,
r"
mod m {
enum Foo {
Bar,
}
}

fn main() {
m::Foo::Baz$0
}
",
r"
mod m {
enum Foo {
Bar,
Baz,
}
}

fn main() {
m::Foo::Baz
}
",
)
}
}
18 changes: 18 additions & 0 deletions crates/ide_assists/src/handlers/generate_function.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ fn gen_fn(acc: &mut Assists, ctx: &AssistContext) -> Option<()> {
get_fn_target(ctx, &target_module, call.clone())?
}
Some(hir::PathResolution::Def(hir::ModuleDef::Adt(adt))) => {
if let hir::Adt::Enum(_) = adt {
return None;
}

Comment on lines +76 to +79
Copy link
Member

Choose a reason for hiding this comment

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

We shouldn't disable this assist for enums in general, we should disable it if the type is an enum and the function name is PascalCase, that is the function name starts with an uppercase letter

Copy link
Member

Choose a reason for hiding this comment

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

Likewise the generate_enum_variant assist should only trigger on enums when the function name starts with an uppercase letter

let current_module = ctx.sema.scope(call.syntax())?.module();
let module = adt.module(ctx.sema.db);
target_module = if current_module == module { None } else { Some(module) };
Expand Down Expand Up @@ -1740,4 +1744,18 @@ fn foo(value: usize) ${0:-> _} {
",
)
}

#[test]
fn not_applicable_for_enum_variant() {
check_assist_not_applicable(
generate_function,
r"
enum Foo {}

fn main() {
Foo::Bar$0(true)
}
",
);
}
}
2 changes: 2 additions & 0 deletions crates/ide_assists/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ mod handlers {
mod generate_documentation_template;
mod generate_enum_is_method;
mod generate_enum_projection_method;
mod generate_enum_variant;
mod generate_from_impl_for_enum;
mod generate_function;
mod generate_getter;
Expand Down Expand Up @@ -225,6 +226,7 @@ mod handlers {
generate_enum_is_method::generate_enum_is_method,
generate_enum_projection_method::generate_enum_as_method,
generate_enum_projection_method::generate_enum_try_into_method,
generate_enum_variant::generate_enum_variant,
generate_from_impl_for_enum::generate_from_impl_for_enum,
generate_function::generate_function,
generate_impl::generate_impl,
Expand Down