Feat/util print to console log (#186)

Co-authored-by: Augustin Mauroy <[email protected]>

Author: brunocroh

package-lock.json

@@ -0,0 +1,46 @@
+# `util.print, util.puts, util.debug, util.error` DEP0026,DEP0027,DEP0028,DEP0029
+
+This recipe transforms the usage of log functions from util, `print`, `puts`, `debug`, `error` to use `console.log()` or `console.error()`.
+
+See [DEP0026](https://nodejs.org/api/deprecations.html#DEP0026).
+See [DEP0027](https://nodejs.org/api/deprecations.html#DEP0027).
+See [DEP0028](https://nodejs.org/api/deprecations.html#DEP0028).
+See [DEP0029](https://nodejs.org/api/deprecations.html#DEP0029).
+
+## Example
+
+**Before:**
+
+```js
+const util = require("node:util");
+
+util.print("Hello world");
+util.puts("Hello world");
+util.debug("Hello world");
+util.error("Hello world");
+```
+
+**After:**
+
+```js
+console.log("Hello world");
+console.log("Hello world");
+console.error("Hello world");
+console.error("Hello world");
+```
+
+**Before:**
+
+```js
+const { print, error } = require("node:util");
+
+print("Application started");
+error("Processing request");
+```
+
+After:
+
+```js
+console.log("Application started");
+console.error("Processing request");
+```

recipes/util-print-to-console-log/README.md

@@ -0,0 +1,21 @@
+schema_version: "1.0"
+name: "@nodejs/util-print-to-console-log"
+version: 1.0.0
+description: Handle DEP0026, DEP0027, DEP0028, DEP0029 via transforming `util.print|puts|debug|error()` to `console.log|error()`
+author: Bruno Rodrigues
+license: MIT
+workflow: workflow.yaml
+category: migration
+
+targets:
+  languages:
+    - javascript
+    - typescript
+
+keywords:
+  - transformation
+  - migration
+
+registry:
+  access: public
+  visibility: public

recipes/util-print-to-console-log/codemod.yaml

@@ -0,0 +1,24 @@
+{
+  "name": "@nodejs/util-print-to-console-log",
+  "version": "1.0.0",
+  "description": "Handle DEP0026, DEP0027, DEP0028, DEP0029 via transforming `util.print|puts|debug|error()` to `console.log|error()`",
+  "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/util-print-to-console-log",
+    "bugs": "https://github.com/nodejs/userland-migrations/issues"
+  },
+  "author": "Bruno Rodrigues",
+  "license": "MIT",
+  "homepage": "https://github.com/nodejs/userland-migrations/blob/main/recipes/util-print-to-console-log/README.md",
+  "devDependencies": {
+    "@codemod.com/jssg-types": "^1.0.3"
+  },
+  "dependencies": {
+    "@nodejs/codemod-utils": "*"
+  }
+}

recipes/util-print-to-console-log/package.json

@@ -0,0 +1,126 @@
+import type {
+	Edit,
+	Kinds,
+	Range,
+	Rule,
+	SgNode,
+	SgRoot,
+	TypesMap,
+} from "@codemod.com/jssg-types/main";
+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 { removeBinding } from "@nodejs/codemod-utils/ast-grep/remove-binding";
+import { removeLines } from "@nodejs/codemod-utils/ast-grep/remove-lines";
+
+type BindingToReplace = {
+	rule: Rule<TypesMap>;
+	node: SgNode<TypesMap, Kinds<TypesMap>>;
+	binding: string;
+	replaceFn: (arg: string) => string;
+};
+
+const updates = [
+	{
+		oldBind: "$.print",
+		replaceFn: (arg: string) => `console.log(${arg})`,
+	},
+	{
+		oldBind: "$.puts",
+		replaceFn: (arg: string) => `console.log(${arg})`,
+	},
+	{
+		oldBind: "$.debug",
+		replaceFn: (arg: string) => `console.error(${arg})`,
+	},
+	{
+		oldBind: "$.error",
+		replaceFn: (arg: string) => `console.error(${arg})`,
+	},
+];
+
+/*
+ * Transforms `util.print($$$ARG)` usage to `console.log($$$ARG)`.
+ * Transforms `util.puts($$$ARG)` usage to `console.log($$$ARG)`.
+ * Transforms `util.debug($$$ARG)` usage to `console.error($$$ARG)`.
+ * Transforms `util.error($$$ARG)` usage to `console.error($$$ARG)`.
+ *
+ * Steps:
+ *
+ * Locate all `util.print|puts|debug|error` import imports, noting the replacement rule, import node, and binding name.
+ *
+ * For each binding, replace calls to util.print|puts|debug|error($$$ARG) with the new console.log|error format,
+ * and determine if the import line should be updated or removed.
+ *
+ * Apply all changes, removing or updating the import line as needed.
+ */
+export default function transform(root: SgRoot): string | null {
+	const rootNode = root.root();
+	const edits: Edit[] = [];
+	const linesToRemove: Range[] = [];
+	const bindsToReplace: BindingToReplace[] = [];
+
+	const nodeRequires = getNodeRequireCalls(root, "util");
+	const nodeImports = getNodeImportStatements(root, "util");
+	const importRequireStatement = [...nodeRequires, ...nodeImports];
+
+	if (!importRequireStatement.length) return null;
+
+	for (const node of importRequireStatement) {
+		for (const update of updates) {
+			const bind = resolveBindingPath(node, update.oldBind);
+
+			// if `fn` function ins't coming from `node:util`
+			if (!bind) continue;
+
+			bindsToReplace.push({
+				rule: {
+					pattern: `${bind}($$$ARG)`,
+				},
+				node,
+				binding: bind,
+				replaceFn: update.replaceFn,
+			});
+		}
+	}
+
+	for (const bind of bindsToReplace) {
+		const matches = rootNode.findAll({
+			rule: bind.rule,
+		});
+
+		for (const match of matches) {
+			const args = match.getMultipleMatches("ARG");
+
+			const argsStr = args
+				.map((arg) => {
+					const text = arg.text();
+					if (text === ",") {
+						// if arg is a comman, add a space at end
+						return text.padEnd(2, " ");
+					}
+					return text;
+				})
+				.join("");
+
+			const replace = match.replace(bind.replaceFn(argsStr));
+			edits.push(replace);
+
+			const result = removeBinding(bind.node, bind.binding.split(".").at(0));
+
+			if (result?.lineToRemove) {
+				linesToRemove.push(result.lineToRemove);
+			}
+
+			if (result?.edit) {
+				edits.push(result.edit);
+			}
+		}
+	}
+
+	if (!edits.length) return;
+
+	const sourceCode = rootNode.commitEdits(edits);
+
+	return removeLines(sourceCode, linesToRemove);
+}

recipes/util-print-to-console-log/src/workflow.ts

@@ -0,0 +1,2 @@
+
+console.error("Hello world");

recipes/util-print-to-console-log/tests/expected/debug.js

@@ -0,0 +1,2 @@
+
+console.error("Hello world");

recipes/util-print-to-console-log/tests/expected/error.js

@@ -0,0 +1,2 @@
+
+console.log("Server listening on port 3000");

recipes/util-print-to-console-log/tests/expected/esm-import.mjs

@@ -0,0 +1,2 @@
+
+console.log("Debug message");

recipes/util-print-to-console-log/tests/expected/esm-namespace-import.mjs

@@ -0,0 +1,2 @@
+
+console.log("User:", "john", "logged in");