Unnamed repository; edit this file 'description' to name the repository.
Merge pull request #20407 from A4-Tacks/remove-doc-for-gen-trait
Remove doc comments for generate_trait_from_impl
A4-Tacks 8 weeks ago
parent 6f293a3 · parent dbe9af6 · commit c19bfd2
-rw-r--r--crates/ide-assists/src/handlers/generate_trait_from_impl.rs54
1 files changed, 52 insertions, 2 deletions
diff --git a/crates/ide-assists/src/handlers/generate_trait_from_impl.rs b/crates/ide-assists/src/handlers/generate_trait_from_impl.rs
index 8bc4d50cf6..7e858cdc87 100644
--- a/crates/ide-assists/src/handlers/generate_trait_from_impl.rs
+++ b/crates/ide-assists/src/handlers/generate_trait_from_impl.rs
@@ -1,8 +1,10 @@
use crate::assist_context::{AssistContext, Assists};
use ide_db::assists::AssistId;
use syntax::{
- AstNode, SyntaxKind, T,
- ast::{self, HasGenericParams, HasName, HasVisibility, edit::AstNodeEdit, make},
+ AstNode, AstToken, SyntaxKind, T,
+ ast::{
+ self, HasDocComments, HasGenericParams, HasName, HasVisibility, edit::AstNodeEdit, make,
+ },
syntax_editor::{Position, SyntaxEditor},
};
@@ -133,6 +135,7 @@ pub(crate) fn generate_trait_from_impl(acc: &mut Assists, ctx: &AssistContext<'_
let mut editor = builder.make_editor(impl_ast.syntax());
impl_assoc_items.assoc_items().for_each(|item| {
remove_items_visibility(&mut editor, &item);
+ remove_doc_comments(&mut editor, &item);
});
editor.insert_all(Position::before(impl_name.syntax()), elements);
@@ -175,6 +178,17 @@ fn remove_items_visibility(editor: &mut SyntaxEditor, item: &ast::AssocItem) {
}
}
+fn remove_doc_comments(editor: &mut SyntaxEditor, item: &ast::AssocItem) {
+ for doc in item.doc_comments() {
+ if let Some(next) = doc.syntax().next_token()
+ && next.kind() == SyntaxKind::WHITESPACE
+ {
+ editor.delete(next);
+ }
+ editor.delete(doc.syntax());
+ }
+}
+
fn strip_body(editor: &mut SyntaxEditor, item: &ast::AssocItem) {
if let ast::AssocItem::Fn(f) = item
&& let Some(body) = f.body()
@@ -239,6 +253,42 @@ impl NewTrait for Foo {
}
#[test]
+ fn test_remove_doc_comments() {
+ check_assist_no_snippet_cap(
+ generate_trait_from_impl,
+ r#"
+struct Foo(f64);
+
+impl F$0oo {
+ /// Add `x`
+ ///
+ /// # Examples
+ #[cfg(true)]
+ fn add(&mut self, x: f64) {
+ self.0 += x;
+ }
+}"#,
+ r#"
+struct Foo(f64);
+
+trait NewTrait {
+ /// Add `x`
+ ///
+ /// # Examples
+ #[cfg(true)]
+ fn add(&mut self, x: f64);
+}
+
+impl NewTrait for Foo {
+ #[cfg(true)]
+ fn add(&mut self, x: f64) {
+ self.0 += x;
+ }
+}"#,
+ )
+ }
+
+ #[test]
fn test_assoc_item_macro() {
check_assist_no_snippet_cap(
generate_trait_from_impl,