feat(util-log): introduce (#181)

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

Author: brunocroh

package-lock.json

@@ -0,0 +1,37 @@
+# `util.log` DEP0059
+
+This recipe transforms the usage of `log.util()` to use `console.log()`.
+
+See [DEP0059](https://nodejs.org/api/deprecations.html#DEP0059).
+
+## Example
+
+**Before:**
+
+```js
+const util = require("node:util");
+
+util.log("Hello world");
+```
+
+**After:**
+
+```js
+console.log(new Date().toLocaleString(), "Hello world");
+```
+
+**Before:**
+
+```js
+const { log } = require("node:util");
+
+log("Application started");
+log("Processing request");
+```
+
+After:
+
+```js
+console.log(new Date().toLocaleString(), "Application started");
+console.log(new Date().toLocaleString(), "Processing request");
+```

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

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

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

@@ -0,0 +1,24 @@
+{
+  "name": "@nodejs/util-log-to-console-log",
+  "version": "1.0.0",
+  "description": "Handle DEP0059 via transforming `log.util()` to `console.log()`",
+  "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-log-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-log-to-console-log/README.md",
+  "devDependencies": {
+    "@codemod.com/jssg-types": "^1.0.3"
+  },
+  "dependencies": {
+    "@nodejs/codemod-utils": "*"
+  }
+}

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

@@ -0,0 +1,100 @@
+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;
+};
+
+/*
+ * Transforms `util.log($$$ARG)` usage to `console.log(new Date().toLocaleString(), $$$ARG)`.
+ *
+ * Steps:
+ *
+ * Locate all util.log imports, noting the replacement rule, import node, and binding name.
+ *
+ * For each binding, replace calls to util.log($$$ARG) with the new console.log 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 path = "$.log";
+	const importRequireStatement = [...nodeRequires, ...nodeImports];
+
+	if (!importRequireStatement.length) return null;
+
+	for (const node of importRequireStatement) {
+		const bind = resolveBindingPath(node, path);
+
+		// if `log` function ins't coming from `node:util`
+		if (!bind) continue;
+
+		bindsToReplace.push({
+			rule: {
+				pattern: `${bind}($$$ARG)`,
+			},
+			node,
+			binding: bind,
+		});
+	}
+
+	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("");
+
+			edits.push(match.replace(`console.log(new Date().toLocaleString(), ${argsStr})`));
+		}
+
+		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-log-to-console-log/src/workflow.ts

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

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

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

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

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

recipes/util-log-to-console-log/tests/expected/multiple-arguments.js

@@ -0,0 +1,5 @@
+const { inspect } = require("node:util");
+
+console.log(new Date().toLocaleString(), "Starting application");
+const formatted = inspect({ foo: "bar" });
+console.log(formatted);

recipes/util-log-to-console-log/tests/expected/multiple-imports.cjs

@@ -0,0 +1,3 @@
+
+console.log(new Date().toLocaleString(), "Application started");
+console.log(new Date().toLocaleString(), "Processing request");