Retain only top level comments while transforming (#516)

aws · Jul 26, 2023 · 83832c8 · 83832c8
1 parent f4d2497
commit 83832c8
Show file tree

Hide file tree

Showing 25 changed files with 16 additions and 127 deletions.
diff --git a/.changeset/orange-trees-sit.md b/.changeset/orange-trees-sit.md
@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Retain only top level comments while transforming
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.block.input.ts b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.block.input.ts
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.block.output.ts b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.block.output.ts
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.inline.input.ts b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.inline.input.ts
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.inline.output.ts b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.inline.output.ts
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.block.input.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.block.input.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.block.output.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.block.output.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.inline.input.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.inline.input.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.inline.output.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.inline.output.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.block.input.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.block.input.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.block.output.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.block.output.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.inline.input.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.inline.input.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.inline.output.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.inline.output.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.block.input.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.block.input.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.block.output.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.block.output.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.inline.input.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.inline.input.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.inline.output.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.inline.output.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.block.input.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.block.input.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.block.output.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.block.output.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.inline.input.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.inline.input.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.inline.output.js b/src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.inline.output.js
diff --git a/src/transforms/v2-to-v3/modules/removeImportDeclaration.ts b/src/transforms/v2-to-v3/modules/removeImportDeclaration.ts
@@ -1,18 +1,18 @@
-import { ASTPath, ImportDeclaration, JSCodeshift } from "jscodeshift";
+import { ASTPath, Collection, ImportDeclaration, JSCodeshift } from "jscodeshift";
 
 /**
- * Removes import declaration, but preserves comments by adding them to next sibling.
+ * Removes import declaration, but preserves comments if they're top level comments.
  */
 export const removeImportDeclaration = (
   j: JSCodeshift,
+  source: Collection<unknown>,
   declarationPath: ASTPath<ImportDeclaration>
 ) => {
-  const { comments } = declarationPath.value;
-  if (comments?.length) {
-    const siblings = declarationPath.parent?.value.body;
-    if (siblings?.length) {
-      const nextSibling = siblings[siblings.indexOf(declarationPath.value) + 1];
-      nextSibling.comments = [...comments, ...(nextSibling.comments || [])];
+  const firstNode = source.find(j.Program).get("body", 0).node;
+  if (firstNode === declarationPath.node) {
+    const { comments } = declarationPath.value;
+    if (comments?.length) {
+      declarationPath.insertBefore(j.emptyStatement.from({ comments }));
     }
   }
   j(declarationPath).remove();

diff --git a/src/transforms/v2-to-v3/modules/removeImportDefault.ts b/src/transforms/v2-to-v3/modules/removeImportDefault.ts
@@ -27,7 +27,7 @@ export const removeImportDefault = (
 
       // Remove ImportDeclaration if there are no import specifiers.
       if (declarationPath.value.specifiers?.length === 0) {
-        removeImportDeclaration(j, declarationPath);
+        removeImportDeclaration(j, source, declarationPath);
       }
     });
 };
diff --git a/src/transforms/v2-to-v3/modules/removeImportEquals.ts b/src/transforms/v2-to-v3/modules/removeImportEquals.ts
@@ -20,6 +20,6 @@ export const removeImportEquals = (
     },
   });
   if (importEqualsDeclaration.length) {
-    removeImportDeclaration(j, importEqualsDeclaration.get());
+    removeImportDeclaration(j, source, importEqualsDeclaration.get());
   }
 };
diff --git a/src/transforms/v2-to-v3/modules/removeImportNamed.ts b/src/transforms/v2-to-v3/modules/removeImportNamed.ts
@@ -37,7 +37,7 @@ export const removeImportNamed = (
 
       // Remove ImportDeclaration if there are no import specifiers.
       if (declarationPath.value.specifiers?.length === 0) {
-        removeImportDeclaration(j, declarationPath);
+        removeImportDeclaration(j, source, declarationPath);
       }
     });
 };