fix(create-require-from-path): handle require/import with alias (#165)

Author: brunocroh

package-lock.json

@@ -1,6 +1,6 @@
 schema_version: "1.0"
 name: "@nodejs/create-require-from-path"
-version: 1.0.0
+version: 1.1.0
 description: Handle DEP0130 via transforming `createRequireFromPath` to `createRequire`.
 author: Augustin Mauroy
 license: MIT

recipes/create-require-from-path/codemod.yaml

@@ -1,6 +1,6 @@
 {
   "name": "@nodejs/create-require-from-path",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Handle DEP0130 via transforming `createRequireFromPath` to `createRequire`.",
   "type": "module",
   "scripts": {

recipes/create-require-from-path/package.json

@@ -21,73 +21,136 @@ import type { SgRoot, Edit } from "@codemod.com/jssg-types/main";
  * 3. Preserves original variable names and declaration types.
  */
 export default function transform(root: SgRoot): string | null {
-  const rootNode = root.root();
-  const edits: Edit[] = [];
-  let hasChanges = false;
+	const rootNode = root.root();
+	const edits: Edit[] = [];
+	let hasChanges = false;
 
-  // Step 1: Find and update destructuring assignments from require('module') or require('node:module')
+	// Step 1: Find and update destructuring assignments from require('module') or require('node:module')
 	// @ts-ignore - ast-grep types are not fully compatible with JSSG types
-  const requireStatements = getNodeRequireCalls(root, "module")
-
-  for (const statement of requireStatements) {
-    // Find the object pattern (destructuring)
-    const objectPattern = statement.find({
-      rule: {
-        kind: "object_pattern"
-      }
-    });
-
-    if (objectPattern) {
-      const originalText = objectPattern.text();
-
-      if (originalText.includes("createRequireFromPath")) {
-        const newText = originalText.replace(/\bcreateRequireFromPath\b/g, "createRequire");
-        edits.push(objectPattern.replace(newText));
-        hasChanges = true;
-      }
-    }
-  }
+	const requireStatements = getNodeRequireCalls(root, "module");
+
+	for (const statement of requireStatements) {
+		// Find the object pattern (destructuring)
+		const objectPattern = statement.find({
+			rule: {
+				kind: "object_pattern",
+			},
+		});
+
+		if (objectPattern) {
+			const originalText = objectPattern.text();
+
+			if (originalText.includes("createRequireFromPath")) {
+				const newText = originalText.replace(/\bcreateRequireFromPath\b/g, "createRequire");
+				edits.push(objectPattern.replace(newText));
+				hasChanges = true;
+			}
+		}
+	}
 
 	// @ts-ignore - ast-grep types are not fully compatible with JSSG types
-  const importStatements = getNodeImportStatements(root, "module");
-
-  for (const statement of importStatements) {
-    // Find the named imports
-    const namedImports = statement.find({
-      rule: {
-        kind: "named_imports"
-      }
-    });
-
-    if (namedImports) {
-      const originalText = namedImports.text();
-
-      if (originalText.includes("createRequireFromPath")) {
-        const newText = originalText.replace(/\bcreateRequireFromPath\b/g, "createRequire");
-        edits.push(namedImports.replace(newText));
-        hasChanges = true;
-      }
-    }
-  }
-
-  // Step 2: Find and replace createRequireFromPath function calls
-  const functionCalls = rootNode.findAll({
-    rule: {
-      pattern: "createRequireFromPath($ARG)"
-    }
-  });
-
-  for (const call of functionCalls) {
-    const argMatch = call.getMatch("ARG");
-    if (argMatch) {
-      const arg = argMatch.text();
-      const replacement = `createRequire(${arg})`;
-      edits.push(call.replace(replacement));
-      hasChanges = true;
-    }
-  }
-
-  if (!hasChanges) return null;
-
-  return rootNode.commitEdits(edits);
+	const importStatements = getNodeImportStatements(root, "module");
+
+	for (const statement of importStatements) {
+		// Find the named imports
+		const namedImports = statement.find({
+			rule: {
+				kind: "named_imports",
+			},
+		});
+
+		if (namedImports) {
+			const originalText = namedImports.text();
+
+			if (originalText.includes("createRequireFromPath")) {
+				const newText = originalText.replace(/\bcreateRequireFromPath\b/g, "createRequire");
+				edits.push(namedImports.replace(newText));
+				hasChanges = true;
+			}
+		}
+	}
+
+	const renamedImports = rootNode.findAll({
+		rule: {
+			any: [
+				{
+					kind: "pair_pattern",
+					all: [
+						{
+							has: {
+								field: "key",
+								kind: "property_identifier",
+							},
+						},
+						{
+							has: {
+								field: "value",
+								kind: "identifier",
+							},
+						},
+					],
+				},
+				{
+					kind: "import_specifier",
+					all: [
+						{
+							has: {
+								field: "alias",
+								kind: "identifier",
+							},
+						},
+						{
+							has: {
+								field: "name",
+								kind: "identifier",
+							},
+						},
+					],
+				},
+			],
+		},
+	});
+
+	for (const rename of renamedImports) {
+		if (rename?.text().includes("createRequireFromPath")) {
+			const key = rename.find({
+				rule: {
+					has:
+						rename.kind() === "import_specifier"
+							? {
+									field: "name",
+									kind: "identifier",
+								}
+							: {
+									field: "key",
+									kind: "property_identifier",
+								},
+				},
+			});
+
+			edits.push(key.replace("createRequire"));
+			hasChanges = true;
+		}
+	}
+
+	// Step 2: Find and replace createRequireFromPath function calls
+	const functionCalls = rootNode.findAll({
+		rule: {
+			pattern: "createRequireFromPath($ARG)",
+		},
+	});
+
+	for (const call of functionCalls) {
+		const argMatch = call.getMatch("ARG");
+		if (argMatch) {
+			const arg = argMatch.text();
+			const replacement = `createRequire(${arg})`;
+			edits.push(call.replace(replacement));
+			hasChanges = true;
+		}
+	}
+
+	if (!hasChanges) return null;
+
+	return rootNode.commitEdits(edits);
 }

recipes/create-require-from-path/src/workflow.ts

@@ -0,0 +1,3 @@
+import { other as bar, createRequire as foo } from "../index.mjs";
+
+const r3 = foo("/path/to/module");

recipes/create-require-from-path/tests/expected/import-with-alias.mjs

@@ -0,0 +1,3 @@
+const { createRequire: foo } = require("../index.cjs");
+
+const r3 = foo("/path/to/module");

recipes/create-require-from-path/tests/expected/require-with-alias.cjs

@@ -0,0 +1,3 @@
+import { other as bar, createRequireFromPath as foo } from "../index.mjs";
+
+const r3 = foo("/path/to/module");

recipes/create-require-from-path/tests/input/import-with-alias.mjs

@@ -0,0 +1,3 @@
+const { createRequireFromPath: foo } = require("../index.cjs");
+
+const r3 = foo("/path/to/module");

recipes/create-require-from-path/tests/input/require-with-alias.cjs

@@ -37,7 +37,7 @@ const supportedKinds = [...requireKinds, ...importKinds];
  * ```
  */
 export function resolveBindingPath(node: SgNode<TypesMap, Kinds<TypesMap>>, path: string) {
-	let activeNode = node;
+	const activeNode = node;
 	const rootKind = activeNode.kind().toString();
 
 	if (!supportedKinds.includes(rootKind.toString())) {