feat: preserve comment style

nikku · Feb 26, 2024 · 9a10b17 · 9a10b17
1 parent b708ad4
commit 9a10b17
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 7 deletions.
diff --git a/lib/post-transform.js b/lib/post-transform.js
@@ -531,12 +531,24 @@ declare function p${
     // remove entirely, if empty
     if (!newDoc.replace(/[/*\s]/g, '')) {
       return null;
-    } else {
-      return b.commentBlock.from({
-        leading: true,
-        value: newDoc
-      });
     }
+
+    // leave comment unchanged
+    if (newDoc === comment.value) {
+      return comment;
+    }
+
+    const commentBuilder = {
+      'CommentLine': b.commentLine,
+      'CommentBlock': b.commentBlock
+    };
+
+    return commentBuilder[comment.type].from({
+      leading: comment.leading,
+      trailing: comment.trailing,
+      loc: comment.loc,
+      value: newDoc
+    });
   }
 
   /**
@@ -551,9 +563,12 @@ declare function p${
       const comment = comments.get(key);
 
       const newComment = cleanComment(comment.value);
-      if (newComment) {
+
+      if (newComment && newComment !== comment.value) {
         replace(comment, newComment);
-      } else {
+      }
+
+      if (!newComment) {
         replace(comment);
       }
     }

diff --git a/test/fixtures/post/comments-source-map.d.ts b/test/fixtures/post/comments-source-map.d.ts
@@ -0,0 +1,5 @@
+export type Element = import('../model/Types').Element;
+export type Closure = {
+    enclosedElements: Record<string, Element>;
+};
+//# sourceMappingURL=Elements.d.ts.map
diff --git a/test/fixtures/post/comments-source-map.expected.d.ts b/test/fixtures/post/comments-source-map.expected.d.ts
@@ -0,0 +1,6 @@
+type Element = import('../model/Types').Element;
+
+export type Closure = {
+    enclosedElements: Record<string, Element>;
+};
+//# sourceMappingURL=Elements.d.ts.map
diff --git a/test/fixtures/post/comments.d.ts b/test/fixtures/post/comments.d.ts
@@ -0,0 +1,17 @@
+// initial comment
+
+/** some comment */
+
+/* */
+//
+
+
+/** @type { number } */
+declare const foo = 1;
+
+/** some other comment */
+
+/* */
+//
+
+// trailing
diff --git a/test/fixtures/post/comments.expected.d.ts b/test/fixtures/post/comments.expected.d.ts
@@ -0,0 +1,10 @@
+// initial comment
+
+/** some comment */
+
+/** @type { number } */
+declare const foo = 1;
+
+/** some other comment */
+
+// trailing
diff --git a/test/transform.test.js b/test/transform.test.js
@@ -69,6 +69,9 @@ describe('transform', function() {
 
     testPostTransform('post/undocumented-param');
 
+    testPostTransform('post/comments');
+    testPostTransform('post/comments-source-map');
+
 
     describe('error handling', function() {