feat(rmdir-import-alias): handle rmdir import with alias (#166)

Co-authored-by: Bruno Rodrigues <[email protected]>

Author: 0xlakshan

package-lock.json

@@ -1,6 +1,6 @@
 schema_version: "1.0"
 name: "@nodejs/rmdir"
-version: 1.0.0
+version: 1.1.0
 description: Handle DEP0147 via transforming `fs.rmdir` to `fs.rm`
 author: Augustin Mauroy
 license: MIT

recipes/rmdir/codemod.yaml

@@ -1,6 +1,6 @@
 {
   "name": "@nodejs/rmdir",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Handle DEP0147 via transforming `fs.rmdir` to `fs.rm` with the appropriate options.",
   "type": "module",
   "scripts": {

recipes/rmdir/package.json

@@ -1,5 +1,6 @@
 import { getNodeImportStatements } from "@nodejs/codemod-utils/ast-grep/import-statement";
 import { getNodeRequireCalls } from "@nodejs/codemod-utils/ast-grep/require-call";
+import { resolveBindingPath } from "@nodejs/codemod-utils/ast-grep/resolve-binding-path";
 import type { SgRoot, Edit } from "@codemod.com/jssg-types/main";
 
 /**
@@ -139,6 +140,75 @@ export default function transform(root: SgRoot): string | null {
 		hasChanges = true;
 	}
 
+	// Transform named alias import when recursive set to true
+	// @ts-ignore - ast-grep types are not fully compatible with JSSG types
+	const importStatements = getNodeImportStatements(root, "fs");
+
+	for (const eachNode of importStatements) {
+		// Get in file reference alias name (import {rmdir as foo} from "node:fs" -> foo)
+		const referenceNameInFile = resolveBindingPath(eachNode, "$.rmdir");
+		if (!referenceNameInFile) continue;
+		// Get in file reference node
+		const referenceFunctionNode = rootNode.find({
+			rule: {
+				any: [
+					{
+						pattern: `${referenceNameInFile}($PATH, $OPTIONS, $CALLBACK)`,
+					},
+					{
+						pattern: `${referenceNameInFile}($PATH, $OPTIONS)`,
+					},
+				],
+			},
+		});
+		if (!referenceFunctionNode) continue;
+		const optionsMatch = referenceFunctionNode.getMatch("OPTIONS");
+		if (!optionsMatch) continue;
+		const optionsText = optionsMatch.text();
+		if (!optionsText.includes("recursive") || !optionsText.includes("true")) {
+			continue;
+		}
+		// Proceed with the change since { recursive: true }
+		const aliasNodes = eachNode.findAll({
+			rule: {
+				any: [
+					{
+						kind: "import_specifier",
+						all: [
+							{
+								has: {
+									field: "alias",
+									pattern: "$ALIAS",
+								},
+							},
+							{
+								has: {
+									field: "name",
+									pattern: "$ORIGINAL",
+								},
+							},
+						],
+					},
+				],
+			},
+		});
+
+		for (const eachAliasNode of aliasNodes) {
+			// Narrow down to rmdir alias
+			if (eachAliasNode.text().includes("rmdir")) {
+				const rmdirNode = eachAliasNode.find({
+					rule: {
+						pattern: "rmdir",
+						kind: "identifier",
+					},
+				});
+				// Change rmdir to rm
+				edits.push(rmdirNode!.replace("rm"));
+				hasChanges = true;
+			}
+		}
+	}
+
 	// Update imports/requires only if we have destructured calls that need new imports
 	if (needsRmImport || needsRmSyncImport) {
 		// @ts-ignore - ast-grep types are not fully compatible with JSSG types

recipes/rmdir/src/workflow.ts

@@ -0,0 +1,5 @@
+import { rm as foo } from "node:fs";
+
+const pathName = "path/to/directory";
+
+foo(pathName, { recursive: true }, () => {});

recipes/rmdir/tests/expected/file-3.js

@@ -0,0 +1,5 @@
+import { rm as foo } from "node:fs";
+
+const pathName = "path/to/directory";
+
+foo(pathName, { recursive: true });

recipes/rmdir/tests/expected/file-4.js

@@ -0,0 +1,5 @@
+import { rmdir as foo } from "node:fs"; // should not be transformed
+
+const pathName = "path/to/directory";
+
+foo(pathName, { recursive: false });

recipes/rmdir/tests/expected/file-5.js

@@ -0,0 +1,5 @@
+import { rmdir as foo } from "node:fs"; // should not be transformed
+
+const pathName = "path/to/directory";
+
+foo(pathName);

recipes/rmdir/tests/expected/file-6.js

@@ -0,0 +1,28 @@
+import {
+	cp as copy,
+	rm as foo,
+	mkdirSync as makeDir,
+	readdirSync as readDir
+} from "node:fs";
+
+import * as fileSystem from "node:fs";
+
+const sourcePath = "path/to/source";
+const targetPath = "path/to/target";
+const dirPath = "path/to/directory";
+
+copy(sourcePath, targetPath, () => {
+  console.log("File copied!");
+});
+
+foo(dirPath, { recursive: true }, () => {
+  console.log("Directory removed!");
+});
+
+fileSystem.move(targetPath, "path/to/renamed", () => {
+  console.log("File renamed!");
+});
+
+makeDir(dirPath);
+
+const files = readDir(dirPath);

recipes/rmdir/tests/expected/file-7.js

@@ -0,0 +1,5 @@
+import { rmdir as foo } from "node:fs";
+
+const pathName = "path/to/directory";
+
+foo(pathName, { recursive: true }, () => {});