feat(chalk-to-util-styletext): add workflow

recipes/chalk-to-util-styletext/README.md

@@ -0,0 +1,3 @@
+# chalk-to-util-styletext
+
+TODO

recipes/chalk-to-util-styletext/codemod.yaml

@@ -0,0 +1,21 @@
+schema_version: "1.0"
+name: "@nodejs/chalk-to-util-styletext"
+version: 1.0.0
+description: Migrate from the chalk package to Node.js's built-in util.styleText API
+author: Richie McColl
+license: MIT
+workflow: workflow.yaml
+category: migration
+
+targets:
+  languages:
+    - javascript
+    - typescript
+
+keywords:
+  - transformation
+  - migration
+
+registry:
+  access: public
+  visibility: public

recipes/chalk-to-util-styletext/package.json

@@ -0,0 +1,24 @@
+{
+    "name": "@nodejs/chalk-to-util-styletext",
+    "version": "1.0.0",
+    "description": "Migrate from the chalk package to Node.js's built-in util.styleText API",
+    "type": "module",
+    "scripts": {
+        "test": "npx codemod jssg test -l typescript ./src/workflow.ts ./"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/nodejs/userland-migrations.git",
+        "directory": "recipes/chalk-to-util-styletext",
+        "bugs": "https://github.com/nodejs/userland-migrations/issues"
+    },
+    "author": "Richie McColl",
+    "license": "MIT",
+    "homepage": "https://github.com/nodejs/userland-migrations/blob/main/recipes/chalk-to-util-styletext/README.md",
+    "devDependencies": {
+        "@codemod.com/jssg-types": "^1.0.9"
+    },
+    "dependencies": {
+        "@nodejs/codemod-utils": "*"
+    }
+}

recipes/chalk-to-util-styletext/src/workflow.ts

@@ -0,0 +1,123 @@
+import { getNodeRequireCalls } from "@nodejs/codemod-utils/ast-grep/require-call";
+import { getNodeImportStatements } from "@nodejs/codemod-utils/ast-grep/import-statement";
+import { resolveBindingPath } from "@nodejs/codemod-utils/ast-grep/resolve-binding-path";
+import { removeLines } from "@nodejs/codemod-utils/ast-grep/remove-lines";
+import type { Edit, Range, SgNode, SgRoot } from "@codemod.com/jssg-types/main";
+import type Js from "@codemod.com/jssg-types/langs/javascript";
+
+/**
+ * Transform function that converts chalk method calls to Node.js util.styleText calls.
+ *
+ * Examples:
+ * - chalk.red("text") -> styleText("red", "text")
+ */
+export default function transform(root: SgRoot<Js>): string | null {
+	const rootNode = root.root();
+	const edits: Edit[] = [];
+	const linesToRemove: Range[] = [];
+	const chalkBinding = "chalk";
+
+	const statements = [
+		...getNodeImportStatements(root, chalkBinding),
+		...getNodeRequireCalls(root, chalkBinding),
+	];
+
+	if (!statements.length) return null;
+
+	for (const statement of statements) {
+		const binding = resolveBindingPath(statement, "$");
+
+		if (!binding) continue;
+
+		const calls = rootNode.findAll({
+			rule: {
+				kind: "call_expression",
+				has: {
+					field: "function",
+					kind: "member_expression",
+				},
+			},
+		});
+
+		const transformedCalls: SgNode<Js>[] = [];
+
+		for (const call of calls) {
+			const functionCall = call.field("function");
+
+			if (!functionCall) {
+				continue;
+			}
+
+			const styles = extractChalkStyles(functionCall, chalkBinding);
+
+			if (styles.length === 0) {
+				continue;
+			}
+
+			// Get the first argument (the text passed to style)
+			const args = call.field("arguments");
+			if (!args) continue;
+
+			// Find all argument nodes
+			const argsList = args.children().filter((c) => {
+				const excluded = [",", "(", ")"];
+				return !excluded.includes(c.kind());
+			});
+
+			if (argsList.length === 0) continue;
+
+			const textArg = argsList[0].text();
+
+			// Create the styleText replacement
+			let replacement: string;
+
+			if (styles.length === 1) {
+				replacement = `styleText("${styles[0]}", ${textArg})`;
+			} else {
+				const stylesArray = `[${styles.map((s) => `"${s}"`).join(", ")}]`;
+				replacement = `styleText(${stylesArray}, ${textArg})`;
+			}
+
+			edits.push(call.replace(replacement));
+			transformedCalls.push(call);
+		}
+
+		if (edits.length > 0) {
+			// Update the import statement if any calls were transformed
+			if (statement.kind() === "import_statement") {
+				// Replace entire import statement
+				edits.push(statement.replace(`import { styleText } from "node:util";`));
+			}
+		}
+	}
+
+	if (!edits.length) return null;
+
+	const sourceCode = rootNode.commitEdits(edits);
+	return removeLines(sourceCode, linesToRemove);
+}
+
+// Helper function to extract chalk style methods from a member expression
+function extractChalkStyles(node: SgNode<Js>, chalkBinding: string): string[] {
+	const styles: string[] = [];
+
+	function traverse(n: SgNode<Js>): boolean {
+		const obj = n.field("object");
+		const prop = n.field("property");
+
+		if (obj && prop && prop.kind() === "property_identifier") {
+			const propName = prop.text();
+
+			if (obj.kind() === "identifier" && obj.text() === chalkBinding) {
+				// Base case: chalk.method
+				styles.push(propName);
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	traverse(node);
+	return styles;
+}

recipes/chalk-to-util-styletext/tests/expected/basic.js

@@ -0,0 +1,5 @@
+import { styleText } from "node:util";
+
+console.log(styleText("red", "Error message"));
+console.log(styleText("green", "Success message"));
+console.log(styleText("blue", "Info message"));

recipes/chalk-to-util-styletext/tests/input/basic.js

@@ -0,0 +1,5 @@
+import chalk from "chalk";
+
+console.log(chalk.red("Error message"));
+console.log(chalk.green("Success message"));
+console.log(chalk.blue("Info message"));

recipes/chalk-to-util-styletext/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "allowImportingTsExtensions": true,
+    "allowJs": true,
+    "alwaysStrict": true,
+    "baseUrl": "./",
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "lib": ["ESNext", "DOM"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "noImplicitThis": true,
+    "removeComments": true,
+    "strict": true,
+    "stripInternal": true,
+    "target": "esnext"
+  },
+  "include": ["./"],
+  "exclude": ["tests/**"]
+}

recipes/chalk-to-util-styletext/workflow.yaml

@@ -0,0 +1,25 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/codemod-com/codemod/refs/heads/main/schemas/workflow.json
+
+version: "1"
+
+nodes:
+  - id: apply-transforms
+    name: Apply AST Transformations
+    type: automatic
+    steps:
+      - name: Migrate from the chalk package to Node.js's built-in util.styleText API
+        js-ast-grep:
+          js_file: src/workflow.ts
+          base_path: .
+          include:
+            - "**/*.cjs"
+            - "**/*.cts"
+            - "**/*.js"
+            - "**/*.jsx"
+            - "**/*.mjs"
+            - "**/*.mts"
+            - "**/*.ts"
+            - "**/*.tsx"
+          exclude:
+            - "**/node_modules/**"
+          language: typescript