use syntax::{ ast::{self, HasName, HasVisibility}, AstNode, SyntaxKind::{ self, ASSOC_ITEM_LIST, CONST, ENUM, FN, MACRO_DEF, MODULE, SOURCE_FILE, STATIC, STRUCT, TRAIT, TYPE_ALIAS, USE, VISIBILITY, }, SyntaxNode, T, }; use crate::{utils::vis_offset, AssistContext, AssistId, AssistKind, Assists}; // Assist: change_visibility // // Adds or changes existing visibility specifier. // // ``` // $0fn frobnicate() {} // ``` // -> // ``` // pub(crate) fn frobnicate() {} // ``` pub(crate) fn change_visibility(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> { if let Some(vis) = ctx.find_node_at_offset::() { return change_vis(acc, vis); } add_vis(acc, ctx) } fn add_vis(acc: &mut Assists, ctx: &AssistContext<'_>) -> Option<()> { let item_keyword = ctx.token_at_offset().find(|leaf| { matches!( leaf.kind(), T![const] | T![static] | T![fn] | T![mod] | T![struct] | T![enum] | T![trait] | T![type] | T![use] | T![macro] ) }); let (offset, target) = if let Some(keyword) = item_keyword { let parent = keyword.parent()?; if !can_add(&parent) { return None; } // Already has visibility, do nothing if parent.children().any(|child| child.kind() == VISIBILITY) { return None; } (vis_offset(&parent), keyword.text_range()) } else if let Some(field_name) = ctx.find_node_at_offset::() { let field = field_name.syntax().ancestors().find_map(ast::RecordField::cast)?; if field.name()? != field_name { cov_mark::hit!(change_visibility_field_false_positive); return None; } if field.visibility().is_some() { return None; } (vis_offset(field.syntax()), field_name.syntax().text_range()) } else if let Some(field) = ctx.find_node_at_offset::() { if field.visibility().is_some() { return None; } (vis_offset(field.syntax()), field.syntax().text_range()) } else { return None; }; acc.add( AssistId("change_visibility", AssistKind::RefactorRewrite), "Change visibility to pub(crate)", target, |edit| { edit.insert(offset, "pub(crate) "); }, ) } fn can_add(node: &SyntaxNode) -> bool { const LEGAL: &[SyntaxKind] = &[CONST, STATIC, TYPE_ALIAS, FN, MODULE, STRUCT, ENUM, TRAIT, USE, MACRO_DEF]; LEGAL.contains(&node.kind()) && { let Some(p) = node.parent() else { return false; }; if p.kind() == ASSOC_ITEM_LIST { p.parent() .and_then(|it| ast::Impl::cast(it)) // inherent impls i.e 'non-trait impls' have a non-local // effect, thus can have visibility even when nested. // so filter them out .filter(|imp| imp.for_token().is_none()) .is_some() } else { matches!(p.kind(), SOURCE_FILE | MODULE) } } } fn change_vis(acc: &mut Assists, vis: ast::Visibility) -> Option<()> { if vis.syntax().text() == "pub" { let target = vis.syntax().text_range(); return acc.add( AssistId("change_visibility", AssistKind::RefactorRewrite), "Change Visibility to pub(crate)", target, |edit| { edit.replace(vis.syntax().text_range(), "pub(crate)"); }, ); } if vis.syntax().text() == "pub(crate)" { let target = vis.syntax().text_range(); return acc.add( AssistId("change_visibility", AssistKind::RefactorRewrite), "Change visibility to pub", target, |edit| { edit.replace(vis.syntax().text_range(), "pub"); }, ); } None } #[cfg(test)] mod tests { use crate::tests::{check_assist, check_assist_not_applicable, check_assist_target}; use super::*; #[test] fn change_visibility_adds_pub_crate_to_items() { check_assist(change_visibility, "$0fn foo() {}", "pub(crate) fn foo() {}"); check_assist(change_visibility, "f$0n foo() {}", "pub(crate) fn foo() {}"); check_assist(change_visibility, "$0struct Foo {}", "pub(crate) struct Foo {}"); check_assist(change_visibility, "$0mod foo {}", "pub(crate) mod foo {}"); check_assist(change_visibility, "$0trait Foo {}", "pub(crate) trait Foo {}"); check_assist(change_visibility, "m$0od {}", "pub(crate) mod {}"); check_assist(change_visibility, "unsafe f$0n foo() {}", "pub(crate) unsafe fn foo() {}"); check_assist(change_visibility, "$0macro foo() {}", "pub(crate) macro foo() {}"); check_assist(change_visibility, "$0use foo;", "pub(crate) use foo;"); check_assist( change_visibility, "impl Foo { f$0n foo() {} }", "impl Foo { pub(crate) fn foo() {} }", ); check_assist( change_visibility, "fn bar() { impl Foo { f$0n foo() {} } }", "fn bar() { impl Foo { pub(crate) fn foo() {} } }", ); } #[test] fn change_visibility_works_with_struct_fields() { check_assist( change_visibility, r"struct S { $0field: u32 }", r"struct S { pub(crate) field: u32 }", ); check_assist(change_visibility, r"struct S ( $0u32 )", r"struct S ( pub(crate) u32 )"); } #[test] fn change_visibility_field_false_positive() { cov_mark::check!(change_visibility_field_false_positive); check_assist_not_applicable( change_visibility, r"struct S { field: [(); { let $0x = ();}] }", ) } #[test] fn change_visibility_pub_to_pub_crate() { check_assist(change_visibility, "$0pub fn foo() {}", "pub(crate) fn foo() {}") } #[test] fn change_visibility_pub_crate_to_pub() { check_assist(change_visibility, "$0pub(crate) fn foo() {}", "pub fn foo() {}") } #[test] fn change_visibility_const() { check_assist(change_visibility, "$0const FOO = 3u8;", "pub(crate) const FOO = 3u8;"); } #[test] fn change_visibility_static() { check_assist(change_visibility, "$0static FOO = 3u8;", "pub(crate) static FOO = 3u8;"); } #[test] fn change_visibility_type_alias() { check_assist(change_visibility, "$0type T = ();", "pub(crate) type T = ();"); } #[test] fn change_visibility_handles_comment_attrs() { check_assist( change_visibility, r" /// docs // comments #[derive(Debug)] $0struct Foo; ", r" /// docs // comments #[derive(Debug)] pub(crate) struct Foo; ", ) } #[test] fn not_applicable_for_enum_variants() { check_assist_not_applicable( change_visibility, r"mod foo { pub enum Foo {Foo1} } fn main() { foo::Foo::Foo1$0 } ", ); } #[test] fn change_visibility_target() { check_assist_target(change_visibility, "$0fn foo() {}", "fn"); check_assist_target(change_visibility, "pub(crate)$0 fn foo() {}", "pub(crate)"); check_assist_target(change_visibility, "struct S { $0field: u32 }", "field"); } #[test] fn not_applicable_for_items_within_traits() { check_assist_not_applicable(change_visibility, "trait Foo { f$0n run() {} }"); check_assist_not_applicable(change_visibility, "trait Foo { con$0st FOO: u8 = 69; }"); check_assist_not_applicable(change_visibility, "impl Foo for Bar { f$0n quox() {} }"); } #[test] fn not_applicable_for_items_within_fns() { check_assist_not_applicable(change_visibility, "fn foo() { f$0n inner() {} }"); check_assist_not_applicable(change_visibility, "fn foo() { unsafe f$0n inner() {} }"); check_assist_not_applicable(change_visibility, "fn foo() { const f$0n inner() {} }"); check_assist_not_applicable(change_visibility, "fn foo() { con$0st FOO: u8 = 69; }"); check_assist_not_applicable(change_visibility, "fn foo() { en$0um Foo {} }"); check_assist_not_applicable(change_visibility, "fn foo() { stru$0ct Foo {} }"); check_assist_not_applicable(change_visibility, "fn foo() { mo$0d foo {} }"); check_assist_not_applicable(change_visibility, "fn foo() { $0use foo; }"); check_assist_not_applicable(change_visibility, "fn foo() { $0type Foo = Bar; }"); check_assist_not_applicable(change_visibility, "fn foo() { tr$0ait Foo {} }"); check_assist_not_applicable( change_visibility, "fn foo() { impl Trait for Bar { f$0n bar() {} } }", ); check_assist_not_applicable( change_visibility, "fn foo() { impl Trait for Bar { con$0st FOO: u8 = 69; } }", ); } }