Add utility removeImportDefault & removeImportNamed (#296)

Author: trivikr

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

@@ -0,0 +1,32 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+export interface RemoveImportDefaultOptions {
+  localName: string;
+  sourceValue: string;
+}
+
+export const removeImportDefault = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { localName, sourceValue }: RemoveImportDefaultOptions
+) => {
+  source
+    .find(j.ImportDeclaration, {
+      specifiers: [{ local: { name: localName } }],
+      source: { value: sourceValue },
+    })
+    .forEach((declarationPath) => {
+      // Remove default/namespace import from ImportDeclaration if there is a match
+      declarationPath.value.specifiers = declarationPath.value.specifiers?.filter((specifier) => {
+        if (!["ImportDefaultSpecifier", "ImportNamespaceSpecifier"].includes(specifier.type)) {
+          return true;
+        }
+        return specifier.local?.name !== localName;
+      });
+
+      // Remove ImportDeclaration if there are no import specifiers.
+      if (declarationPath.value.specifiers?.length === 0) {
+        j(declarationPath).remove();
+      }
+    });
+};

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

@@ -1,32 +1,34 @@
 import { Collection, JSCodeshift } from "jscodeshift";
 
-export interface RemoveImportIdentifierNameOptions {
+export interface RemoveImportNamedOptions {
   importedName?: string;
   localName: string;
   sourceValue: string;
 }
 
-export const removeImportIdentifierName = (
+export const removeImportNamed = (
   j: JSCodeshift,
   source: Collection<unknown>,
-  { importedName, localName, sourceValue }: RemoveImportIdentifierNameOptions
+  { importedName, localName, sourceValue }: RemoveImportNamedOptions
 ) => {
   source
     .find(j.ImportDeclaration, {
       specifiers: [{ local: { name: localName } }],
       source: { value: sourceValue },
     })
     .forEach((declarationPath) => {
-      // Remove import from ImportDeclaration.
+      // Remove named import from ImportDeclaration if there is a match.
       declarationPath.value.specifiers = declarationPath.value.specifiers?.filter((specifier) => {
-        if (specifier.local?.name === localName) {
-          if (specifier.type === "ImportSpecifier" && importedName) {
-            return specifier.imported?.name === importedName;
-          }
-          return false;
+        if (specifier.type !== "ImportSpecifier") {
+          return true;
         }
+        return (
+          specifier.local?.name !== localName ||
+          (importedName && specifier.imported?.name !== importedName)
+        );
       });
-      // Remove ImportDeclaration if there are no other imports.
+
+      // Remove ImportDeclaration if there are no import specifiers.
       if (declarationPath.value.specifiers?.length === 0) {
         j(declarationPath).remove();
       }

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

@@ -5,8 +5,9 @@ import { getV2ClientTypeNames } from "../ts-type";
 import { getV2ServiceModulePath } from "../utils";
 import { hasImportEquals } from "./hasImportEquals";
 import { hasRequire } from "./hasRequire";
+import { removeImportDefault } from "./removeImportDefault";
 import { removeImportEqualsIdentifierName } from "./removeImportEqualsIdentifierName";
-import { removeImportIdentifierName } from "./removeImportIdentifierName";
+import { removeImportNamed } from "./removeImportNamed";
 import { removeRequireIdentifier } from "./removeRequireIdentifier";
 import { removeRequireObjectProperty } from "./removeRequireObjectProperty";
 
@@ -23,37 +24,24 @@ export const removeV2ClientModule = (
 ) => {
   const { v2ClientName, v2ClientLocalName } = options;
   const serviceModulePath = getV2ServiceModulePath(v2ClientName);
-  const sourceValues = [PACKAGE_NAME, serviceModulePath];
+
+  const defaultOptions = { localName: v2ClientLocalName, sourceValue: serviceModulePath };
+  const namedOptions = { localName: v2ClientLocalName, sourceValue: PACKAGE_NAME };
 
   if (hasRequire(j, source)) {
-    removeRequireIdentifier(j, source, {
-      localName: v2ClientLocalName,
-      sourceValue: serviceModulePath,
-    });
-    removeRequireObjectProperty(j, source, {
-      localName: v2ClientLocalName,
-      sourceValue: PACKAGE_NAME,
-    });
+    removeRequireIdentifier(j, source, defaultOptions);
+    removeRequireObjectProperty(j, source, namedOptions);
   } else if (hasImportEquals(j, source)) {
-    removeImportEqualsIdentifierName(j, source, {
-      localName: v2ClientLocalName,
-      sourceValue: serviceModulePath,
-    });
+    removeImportEqualsIdentifierName(j, source, defaultOptions);
   } else {
-    sourceValues.forEach((sourceValue) => {
-      removeImportIdentifierName(j, source, {
-        localName: v2ClientLocalName,
-        sourceValue,
-      });
-    });
+    removeImportDefault(j, source, defaultOptions);
+    removeImportNamed(j, source, namedOptions);
 
     const v2ClientTypeNames = getV2ClientTypeNames(j, source, options);
     for (const v2ClientTypeName of v2ClientTypeNames) {
-      sourceValues.forEach((sourceValue) => {
-        removeImportIdentifierName(j, source, {
-          localName: v2ClientTypeName,
-          sourceValue,
-        });
+      removeImportNamed(j, source, {
+        localName: v2ClientTypeName,
+        sourceValue: serviceModulePath,
       });
     }
   }

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

@@ -3,8 +3,8 @@ import { Collection, JSCodeshift } from "jscodeshift";
 import { PACKAGE_NAME } from "../config";
 import { hasImportEquals } from "./hasImportEquals";
 import { hasRequire } from "./hasRequire";
+import { removeImportDefault } from "./removeImportDefault";
 import { removeImportEqualsIdentifierName } from "./removeImportEqualsIdentifierName";
-import { removeImportIdentifierName } from "./removeImportIdentifierName";
 import { removeRequireIdentifier } from "./removeRequireIdentifier";
 
 export const removeV2GlobalModule = (
@@ -16,16 +16,13 @@ export const removeV2GlobalModule = (
 
   // Only usage is import/require.
   if (identifierUsages.size() === 1) {
-    const removeIdentifierNameOptions = {
-      localName: v2GlobalName,
-      sourceValue: PACKAGE_NAME,
-    };
+    const defaultOptions = { localName: v2GlobalName, sourceValue: PACKAGE_NAME };
     if (hasRequire(j, source)) {
-      removeRequireIdentifier(j, source, removeIdentifierNameOptions);
+      removeRequireIdentifier(j, source, defaultOptions);
     } else if (hasImportEquals(j, source)) {
-      removeImportEqualsIdentifierName(j, source, removeIdentifierNameOptions);
+      removeImportEqualsIdentifierName(j, source, defaultOptions);
     } else {
-      removeImportIdentifierName(j, source, removeIdentifierNameOptions);
+      removeImportDefault(j, source, defaultOptions);
     }
   }
 };