Add utility removeRequireObjectProperty (#295)

Author: trivikr

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

@@ -0,0 +1,30 @@
+import { Collection, Identifier, JSCodeshift } from "jscodeshift";
+
+import { getRequireVariableDeclarators } from "./getRequireVariableDeclarators";
+
+export interface RemoveRequireIdentifierOptions {
+  localName: string;
+  sourceValue: string;
+}
+
+export const removeRequireIdentifier = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { localName, sourceValue }: RemoveRequireIdentifierOptions
+) => {
+  const id = { type: "Identifier", name: localName } as Identifier;
+  const requireDeclarators = getRequireVariableDeclarators(j, source, sourceValue, id);
+
+  requireDeclarators.forEach((varDeclarator) => {
+    const varDeclarationCollection = j(varDeclarator).closest(j.VariableDeclaration);
+
+    // Remove VariableDeclarator as it contains the only identifier.
+    j(varDeclarator).remove();
+
+    // Remove VariableDeclaration if there are no declarations.
+    const varDeclaration = varDeclarationCollection.nodes()[0];
+    if (varDeclaration && varDeclaration.declarations?.length === 0) {
+      varDeclarationCollection.remove();
+    }
+  });
+};

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

@@ -0,0 +1,44 @@
+import { Collection, JSCodeshift, ObjectPattern } from "jscodeshift";
+
+import { getRequireVariableDeclarators } from "./getRequireVariableDeclarators";
+
+export interface RemoveRequireObjectPropertyOptions {
+  localName: string;
+  sourceValue: string;
+}
+
+export const removeRequireObjectProperty = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { localName, sourceValue }: RemoveRequireObjectPropertyOptions
+) => {
+  const id = {
+    type: "ObjectPattern",
+    properties: [{ type: "Property", value: { type: "Identifier", name: localName } }],
+  } as ObjectPattern;
+  const requireDeclarators = getRequireVariableDeclarators(j, source, sourceValue, id);
+
+  requireDeclarators.forEach((varDeclarator) => {
+    const varDeclarationCollection = j(varDeclarator).closest(j.VariableDeclaration);
+
+    // Remove ObjectProperty from Variable Declarator.
+    const varDeclaratorId = varDeclarator.value.id as ObjectPattern;
+    varDeclaratorId.properties = varDeclaratorId.properties.filter(
+      (property) =>
+        property.type !== "Property" ||
+        property.value.type !== "Identifier" ||
+        property.value.name !== localName
+    );
+
+    // Remove VariableDeclarator if there are no properties.
+    if (varDeclaratorId.properties.length === 0) {
+      j(varDeclarator).remove();
+
+      // Remove VariableDeclaration if there are no declarations.
+      const varDeclaration = varDeclarationCollection.nodes()[0];
+      if (varDeclaration && varDeclaration.declarations?.length === 0) {
+        varDeclarationCollection.remove();
+      }
+    }
+  });
+};

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

@@ -7,7 +7,8 @@ import { hasImportEquals } from "./hasImportEquals";
 import { hasRequire } from "./hasRequire";
 import { removeImportEqualsIdentifierName } from "./removeImportEqualsIdentifierName";
 import { removeImportIdentifierName } from "./removeImportIdentifierName";
-import { removeRequireIdentifierName } from "./removeRequireIdentifierName";
+import { removeRequireIdentifier } from "./removeRequireIdentifier";
+import { removeRequireObjectProperty } from "./removeRequireObjectProperty";
 
 export interface RemoveV2ClientModuleOptions {
   v2ClientName: string;
@@ -25,11 +26,13 @@ export const removeV2ClientModule = (
   const sourceValues = [PACKAGE_NAME, serviceModulePath];
 
   if (hasRequire(j, source)) {
-    sourceValues.forEach((sourceValue) => {
-      removeRequireIdentifierName(j, source, {
-        localName: v2ClientLocalName,
-        sourceValue,
-      });
+    removeRequireIdentifier(j, source, {
+      localName: v2ClientLocalName,
+      sourceValue: serviceModulePath,
+    });
+    removeRequireObjectProperty(j, source, {
+      localName: v2ClientLocalName,
+      sourceValue: PACKAGE_NAME,
     });
   } else if (hasImportEquals(j, source)) {
     removeImportEqualsIdentifierName(j, source, {

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

@@ -5,7 +5,7 @@ import { hasImportEquals } from "./hasImportEquals";
 import { hasRequire } from "./hasRequire";
 import { removeImportEqualsIdentifierName } from "./removeImportEqualsIdentifierName";
 import { removeImportIdentifierName } from "./removeImportIdentifierName";
-import { removeRequireIdentifierName } from "./removeRequireIdentifierName";
+import { removeRequireIdentifier } from "./removeRequireIdentifier";
 
 export const removeV2GlobalModule = (
   j: JSCodeshift,
@@ -21,7 +21,7 @@ export const removeV2GlobalModule = (
       sourceValue: PACKAGE_NAME,
     };
     if (hasRequire(j, source)) {
-      removeRequireIdentifierName(j, source, removeIdentifierNameOptions);
+      removeRequireIdentifier(j, source, removeIdentifierNameOptions);
     } else if (hasImportEquals(j, source)) {
       removeImportEqualsIdentifierName(j, source, removeIdentifierNameOptions);
     } else {