Preserve import comments when transforming code (#514)

.changeset/dirty-owls-turn.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Preserve import comments when transforming code

src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.block.input.ts

@@ -0,0 +1,6 @@
+/*
+ * Example comment which should not be removed.
+ */
+import AWS = require("aws-sdk");
+
+const client = new AWS.DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.block.output.ts

@@ -0,0 +1,10 @@
+/*
+ * Example comment which should not be removed.
+ */
+import AWS_DynamoDB = require("@aws-sdk/client-dynamodb");
+
+const {
+ DynamoDB
+} = AWS_DynamoDB;
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.inline.input.ts

@@ -0,0 +1,4 @@
+// Example comment which should not be removed.
+import AWS = require("aws-sdk");
+
+const client = new AWS.DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/global-import-equals.inline.output.ts

@@ -0,0 +1,8 @@
+// Example comment which should not be removed.
+import AWS_DynamoDB = require("@aws-sdk/client-dynamodb");
+
+const {
+  DynamoDB
+} = AWS_DynamoDB;
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.block.input.js

@@ -0,0 +1,6 @@
+/*
+ * Example comment which should not be removed.
+ */
+import AWS from "aws-sdk";
+
+const client = new AWS.DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.block.output.js

@@ -0,0 +1,6 @@
+/*
+ * Example comment which should not be removed.
+ */
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.inline.input.js

@@ -0,0 +1,4 @@
+// Example comment which should not be removed.
+import AWS from "aws-sdk";
+
+const client = new AWS.DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/global-import.inline.output.js

@@ -0,0 +1,4 @@
+// Example comment which should not be removed.
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.block.input.js

@@ -0,0 +1,6 @@
+/*
+ * Example comment which should not be removed.
+ */
+const AWS = require("aws-sdk");
+
+const client = new AWS.DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.block.output.js

@@ -0,0 +1,8 @@
+/*
+ * Example comment which should not be removed.
+ */
+const {
+ DynamoDB
+} = require("@aws-sdk/client-dynamodb");
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.inline.input.js

@@ -0,0 +1,4 @@
+// Example comment which should not be removed.
+const AWS = require("aws-sdk");
+
+const client = new AWS.DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/global-require.inline.output.js

@@ -0,0 +1,6 @@
+// Example comment which should not be removed.
+const {
+  DynamoDB
+} = require("@aws-sdk/client-dynamodb");
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.block.input.js

@@ -0,0 +1,6 @@
+/*
+ * Example comment which should not be removed.
+ */
+import { DynamoDB } from "aws-sdk";
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.block.output.js

@@ -0,0 +1,6 @@
+/*
+ * Example comment which should not be removed.
+ */
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.inline.input.js

@@ -0,0 +1,4 @@
+// Example comment which should not be removed.
+import { DynamoDB } from "aws-sdk";
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/service-import.inline.output.js

@@ -0,0 +1,4 @@
+// Example comment which should not be removed.
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.block.input.js

@@ -0,0 +1,6 @@
+/*
+ * Example comment which should not be removed.
+ */
+const { DynamoDB } = require("aws-sdk");
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.block.output.js

@@ -0,0 +1,8 @@
+/*
+ * Example comment which should not be removed.
+ */
+const {
+ DynamoDB
+} = require("@aws-sdk/client-dynamodb");
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.inline.input.js

@@ -0,0 +1,4 @@
+// Example comment which should not be removed.
+const { DynamoDB } = require("aws-sdk");
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/import-comments/service-require.inline.output.js

@@ -0,0 +1,6 @@
+// Example comment which should not be removed.
+const {
+  DynamoDB
+} = require("@aws-sdk/client-dynamodb");
+
+const client = new DynamoDB();

src/transforms/v2-to-v3/modules/removeImportDeclaration.ts

@@ -0,0 +1,19 @@
+import { ASTPath, ImportDeclaration, JSCodeshift } from "jscodeshift";
+
+/**
+ * Removes import declaration, but preserves comments by adding them to next sibling.
+ */
+export const removeImportDeclaration = (
+  j: JSCodeshift,
+  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 || [])];
+    }
+  }
+  j(declarationPath).remove();
+};

src/transforms/v2-to-v3/modules/removeImportDefault.ts

@@ -1,4 +1,5 @@
 import { Collection, JSCodeshift } from "jscodeshift";
+import { removeImportDeclaration } from "./removeImportDeclaration";
 
 export interface RemoveImportDefaultOptions {
   localName: string;
@@ -26,7 +27,7 @@ export const removeImportDefault = (
 
       // Remove ImportDeclaration if there are no import specifiers.
       if (declarationPath.value.specifiers?.length === 0) {
-        j(declarationPath).remove();
+        removeImportDeclaration(j, declarationPath);
       }
     });
 };

src/transforms/v2-to-v3/modules/removeImportEquals.ts

@@ -1,4 +1,5 @@
 import { Collection, JSCodeshift } from "jscodeshift";
+import { removeImportDeclaration } from "./removeImportDeclaration";
 
 export interface RemoveImportEqualsOptions {
   localName: string;
@@ -10,14 +11,15 @@ export const removeImportEquals = (
   source: Collection<unknown>,
   { localName, sourceValue }: RemoveImportEqualsOptions
 ) => {
-  source
-    .find(j.TSImportEqualsDeclaration, {
-      type: "TSImportEqualsDeclaration",
-      id: { name: localName },
-      moduleReference: {
-        type: "TSExternalModuleReference",
-        expression: { type: "StringLiteral", value: sourceValue },
-      },
-    })
-    .remove();
+  const importEqualsDeclaration = source.find(j.TSImportEqualsDeclaration, {
+    type: "TSImportEqualsDeclaration",
+    id: { name: localName },
+    moduleReference: {
+      type: "TSExternalModuleReference",
+      expression: { type: "StringLiteral", value: sourceValue },
+    },
+  });
+  if (importEqualsDeclaration.length) {
+    removeImportDeclaration(j, importEqualsDeclaration.get());
+  }
 };

src/transforms/v2-to-v3/modules/removeImportNamed.ts

@@ -1,4 +1,5 @@
 import { Collection, JSCodeshift } from "jscodeshift";
+import { removeImportDeclaration } from "./removeImportDeclaration";
 
 export interface RemoveImportNamedOptions {
   importedName?: string;
@@ -36,7 +37,7 @@ export const removeImportNamed = (
 
       // Remove ImportDeclaration if there are no import specifiers.
       if (declarationPath.value.specifiers?.length === 0) {
-        j(declarationPath).remove();
+        removeImportDeclaration(j, declarationPath);
       }
     });
 };