fix(fs-access-mode-constants): don't modify other thing

recipes/fs-access-mode-constants/codemod.yaml

@@ -1,6 +1,6 @@
 schema_version: "1.0"
 name: "@nodejs/fs-access-mode-constants"
-version: "1.0.2"
+version: "1.0.3"
 description: Handle DEP0176 via transforming imports of `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` from the root `fs` module to `fs.constants`.
 author: nekojanai (Jana)
 license: MIT

recipes/fs-access-mode-constants/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nodejs/fs-access-mode-constants",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Handle DEP0176 via transforming imports of `fs.F_OK`, `fs.R_OK`, `fs.W_OK`, `fs.X_OK` from the root `fs` module to `fs.constants`.",
   "type": "module",
   "scripts": {

recipes/fs-access-mode-constants/src/workflow.ts

@@ -1,79 +1,277 @@
-import { getNodeRequireCalls } from '@nodejs/codemod-utils/ast-grep/require-call';
-import { getNodeImportStatements } from '@nodejs/codemod-utils/ast-grep/import-statement';
-import type { Edit, SgRoot } from '@codemod.com/jssg-types/main';
+import { resolveBindingPath } from '@nodejs/codemod-utils/ast-grep/resolve-binding-path';
+import { getModuleDependencies } from '@nodejs/codemod-utils/ast-grep/module-dependencies';
+import { updateBinding } from '@nodejs/codemod-utils/ast-grep/update-binding';
+import type { Edit, SgNode, SgRoot } from '@codemod.com/jssg-types/main';
 import type Js from '@codemod.com/jssg-types/langs/javascript';
 
-const patterns = ['F_OK', 'R_OK', 'W_OK', 'X_OK'];
+const PATTERN_SET = new Set(['F_OK', 'R_OK', 'W_OK', 'X_OK']);
 
-export default function tranform(root: SgRoot<Js>): string | null {
+type BindingMapping = {
+	local: string;
+	replacement: string;
+};
+
+type RemovedBinding = {
+	imported: string;
+	local: string;
+};
+
+export default function transform(root: SgRoot<Js>): string | null {
 	const rootNode = root.root();
 	const edits: Edit[] = [];
+	const localBindings = new Map<string, string>();
+	const namespaceBindings = new Map<string, string>();
 
-	const requireStatements = getNodeRequireCalls(root, 'fs');
+	const importStatements = getModuleDependencies(root, 'fs');
 
-	for (const statement of requireStatements) {
-		const objectPattern = statement.find({
-			rule: { kind: 'object_pattern' },
-		});
+	if (!importStatements) return null;
+
+	for (const statement of importStatements) {
+		const promisesBinding = resolveBindingPath(statement, '$.promises');
+		const rewritten = rewriteBindings(statement, promisesBinding);
+		edits.push(...rewritten.edits);
+
+		for (const mapping of rewritten.mappings) {
+			localBindings.set(mapping.local, mapping.replacement);
+		}
+
+		for (const pattern of PATTERN_SET) {
+			const resolved = resolveBindingPath(statement, `$.${pattern}`);
+			if (!resolved?.includes('.') || resolved.includes('.constants.')) {
+				continue;
+			}
 
-		if (objectPattern) {
-			let objPatArr = objectPattern
-				.findAll({
-					rule: { kind: 'shorthand_property_identifier_pattern' },
-				})
-				.map((v) => v.text());
-			objPatArr = objPatArr.filter((v) => !patterns.includes(v));
-			objPatArr.push('constants');
-			edits.push(objectPattern.replace(`{ ${objPatArr.join(', ')} }`));
+			namespaceBindings.set(
+				resolved,
+				resolved.replace(`.${pattern}`, `.constants.${pattern}`),
+			);
 		}
 	}
 
-	const importStatements = getNodeImportStatements(root, 'fs');
-	let promisesImportName = '';
+	applyNamespaceReplacements(rootNode, edits, namespaceBindings);
+	applyLocalReplacements(rootNode, edits, localBindings);
 
-	for (const statement of importStatements) {
-		const objectPattern = statement.find({
-			rule: { kind: 'named_imports' },
+	if (edits.length === 0) return null;
+
+	return rootNode.commitEdits(edits);
+}
+
+function rewriteBindings(
+	statement: SgNode<Js>,
+	promisesBinding: string,
+): { edits: Edit[]; mappings: BindingMapping[] } {
+	const objectPattern = statement.find({
+		rule: { kind: 'object_pattern' },
+	});
+
+	if (objectPattern)
+		return rewriteObjectPattern(statement, objectPattern, promisesBinding);
+
+	const namedImports = statement.find({
+		rule: { kind: 'named_imports' },
+	});
+
+	if (namedImports)
+		return rewriteNamedImports(statement, namedImports, promisesBinding);
+
+	return { edits: [], mappings: [] };
+}
+
+function rewriteObjectPattern(
+	statement: SgNode<Js>,
+	pattern: SgNode<Js>,
+	promisesBinding: string,
+): { edits: Edit[]; mappings: BindingMapping[] } {
+	const shorthandBindings = pattern
+		.findAll({
+			rule: { kind: 'shorthand_property_identifier_pattern' },
+		})
+		.map((node) => node.text());
+
+	const aliasedBindings = pattern
+		.findAll({
+			rule: {
+				kind: 'pair_pattern',
+				has: {
+					field: 'key',
+					kind: 'property_identifier',
+				},
+			},
+		})
+		.map((pair) => {
+			const imported = pair.field('key')?.text() ?? '';
+			const local = pair.field('value')?.text() ?? imported;
+
+			return {
+				imported,
+				local,
+				text: pair.text(),
+			};
 		});
 
-		if (objectPattern) {
-			let objPatArr = objectPattern
-				.findAll({
-					rule: { kind: 'import_specifier' },
-				})
-				.map((v) => v.text());
-			objPatArr = objPatArr.filter((v) => !patterns.includes(v));
-			const promisesImport = objPatArr.find((v) => v.startsWith('promises'));
-			if (promisesImport) {
-				if (promisesImport.includes('as')) {
-					const m = promisesImport.matchAll(/promises as (\w+)/g);
-					m.forEach((v) => {
-						promisesImportName = v[1] ?? 'promises';
-					});
-				} else {
-					promisesImportName = promisesImport;
-				}
-				promisesImportName = `${promisesImportName}.`;
-			} else {
-				objPatArr.push('constants');
-			}
-			edits.push(objectPattern.replace(`{ ${objPatArr.join(', ')} }`));
+	const kept: string[] = [];
+	const removed: RemovedBinding[] = [];
+	let removedShorthandCount = 0;
+	let removedAliasedCount = 0;
+
+	for (const name of shorthandBindings) {
+		if (PATTERN_SET.has(name)) {
+			removedShorthandCount += 1;
+			removed.push({
+				imported: name,
+				local: name,
+			});
+			continue;
 		}
+
+		kept.push(name);
 	}
 
-	for (const _OK of patterns) {
-		for (const [prefix, replacement] of [
-			['fs.', 'fs.constants.'],
-			['', `${promisesImportName ? promisesImportName : ''}constants.`],
-		]) {
-			const patterns = rootNode.findAll({
-				rule: { pattern: `${prefix}${_OK}` },
+	for (const binding of aliasedBindings) {
+		if (PATTERN_SET.has(binding.imported)) {
+			removedAliasedCount += 1;
+			removed.push({
+				imported: binding.imported,
+				local: binding.local,
 			});
-			for (const pattern of patterns) {
-				edits.push(pattern.replace(`${replacement}${_OK}`));
+			continue;
+		}
+
+		kept.push(binding.text);
+	}
+
+	return rewriteCollectedBindings({
+		statement,
+		pattern,
+		promisesBinding,
+		kept,
+		removed,
+		allowSingleBindingOptimization:
+			removedShorthandCount === 1 && removedAliasedCount === 0,
+	});
+}
+
+function rewriteNamedImports(
+	statement: SgNode<Js>,
+	pattern: SgNode<Js>,
+	promisesBinding: string,
+): { edits: Edit[]; mappings: BindingMapping[] } {
+	const specifiers = pattern.findAll({
+		rule: { kind: 'import_specifier' },
+	});
+
+	const kept: string[] = [];
+	const removed: RemovedBinding[] = [];
+
+	for (const specifier of specifiers) {
+		const imported = specifier.field('name')?.text() ?? '';
+		const local = specifier.field('alias')?.text() ?? imported;
+
+		if (PATTERN_SET.has(imported)) {
+			removed.push({
+				imported,
+				local,
+			});
+
+			continue;
+		}
+
+		kept.push(specifier.text());
+	}
+
+	return rewriteCollectedBindings({
+		statement,
+		pattern,
+		promisesBinding,
+		kept,
+		removed,
+		allowSingleBindingOptimization:
+			removed.length === 1 && removed[0].local === removed[0].imported,
+	});
+}
+
+function applyNamespaceReplacements(
+	rootNode: SgNode<Js>,
+	edits: Edit[],
+	replacements: Map<string, string>,
+): void {
+	for (const [path, replacement] of replacements) {
+		const nodes = rootNode.findAll({ rule: { pattern: path } });
+
+		for (const node of nodes) {
+			edits.push(node.replace(replacement));
+		}
+	}
+}
+
+function applyLocalReplacements(
+	rootNode: SgNode<Js>,
+	edits: Edit[],
+	replacements: Map<string, string>,
+): void {
+	for (const [local, replacement] of replacements) {
+		const identifiers = rootNode.findAll({
+			rule: {
+				kind: 'identifier',
+				regex: `^${escapeRegExp(local)}$`,
+			},
+		});
+
+		for (const identifier of identifiers) {
+			if (
+				!identifier.inside({ rule: { kind: 'named_imports' } }) ||
+				!identifier.inside({ rule: { kind: 'object_pattern' } })
+			) {
+				edits.push(identifier.replace(replacement));
 			}
 		}
 	}
+}
 
-	return rootNode.commitEdits(edits);
+function rewriteCollectedBindings({
+	statement,
+	pattern,
+	promisesBinding,
+	kept,
+	removed,
+	allowSingleBindingOptimization,
+}: {
+	statement: SgNode<Js>;
+	pattern: SgNode<Js>;
+	promisesBinding: string;
+	kept: string[];
+	removed: RemovedBinding[];
+	allowSingleBindingOptimization: boolean;
+}): { edits: Edit[]; mappings: BindingMapping[] } {
+	if (!removed.length) return { edits: [], mappings: [] };
+
+	const replacementPrefix = promisesBinding
+		? `${promisesBinding}.constants`
+		: 'constants';
+	const mappings = removed.map((binding) => ({
+		local: binding.local,
+		replacement: `${replacementPrefix}.${binding.imported}`,
+	}));
+
+	const shouldAddConstants = !promisesBinding && !kept.includes('constants');
+
+	if (allowSingleBindingOptimization && removed.length === 1) {
+		const singleBindingEdit = updateBinding(statement, {
+			old: removed[0].imported,
+			new: shouldAddConstants ? 'constants' : undefined,
+		}).edit;
+
+		if (singleBindingEdit) return { edits: [singleBindingEdit], mappings };
+	}
+
+	if (shouldAddConstants) kept.push('constants');
+
+	return {
+		edits: [pattern.replace(`{ ${kept.join(', ')} }`)],
+		mappings,
+	};
+}
+
+function escapeRegExp(text: string): string {
+	return text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 }

recipes/fs-access-mode-constants/tests/expected/aliased-import-bindings.js

@@ -0,0 +1,3 @@
+import { access, constants } from 'node:fs';
+
+access('/path/to/file', constants.F_OK | constants.X_OK, callback);

recipes/fs-access-mode-constants/tests/expected/aliased-require-bindings.js

@@ -0,0 +1,3 @@
+const { access, constants } = require('node:fs');
+
+access('/path/to/file', constants.F_OK | constants.R_OK, callback);

recipes/fs-access-mode-constants/tests/expected/already-constants-import.js

@@ -0,0 +1,3 @@
+import { access, constants } from 'node:fs';
+
+access('/path/to/file', constants.F_OK, callback);

recipes/fs-access-mode-constants/tests/expected/already-constants-namespace.js

@@ -0,0 +1,4 @@
+import * as fs from 'node:fs';
+
+fs.access('/path/to/file', fs.constants.F_OK, callback);
+fs.access('/path/to/file', fs.constants.R_OK | fs.constants.W_OK, callback);

recipes/fs-access-mode-constants/tests/expected/already-constants-require.js

@@ -0,0 +1,3 @@
+const fs = require('node:fs');
+
+fs.accessSync('/path/to/file', fs.constants.X_OK);

recipes/fs-access-mode-constants/tests/expected/destructured-from-constants.js

@@ -0,0 +1,4 @@
+const { constants } = require('node:fs');
+const { F_OK, R_OK } = constants;
+
+console.log(F_OK, R_OK);

recipes/fs-access-mode-constants/tests/expected/non-fs-import-f-ok.js

@@ -0,0 +1,3 @@
+import { F_OK } from './local-constants.js';
+
+console.log(F_OK);

recipes/fs-access-mode-constants/tests/expected/non-fs-require-f-ok.js

@@ -0,0 +1,3 @@
+const { F_OK } = require('./local-constants.cjs');
+
+console.log(F_OK);

recipes/fs-access-mode-constants/tests/expected/unrelated-f-ok-identifier.js

@@ -0,0 +1,4 @@
+import { readFileSync } from 'node:fs';
+
+const F_OK = 1;
+console.log(readFileSync, F_OK);