feat(logger): add codemode name

Author: AugustinMauroy

recipes/correct-ts-specifiers/src/workflow.ts

@@ -2,12 +2,15 @@ import module from 'node:module';
 
 import { type Api, api } from '@codemod.com/workflow';
 import type { Helpers } from '@codemod.com/workflow/dist/jsFam.d.ts';
+import { setCodemodName } from '@nodejs/codemod-utils/logger';
 
 import { mapImports } from './map-imports.ts';
 import type { FSAbsolutePath } from './index.d.ts';
 
 import * as aliasLoader from '@nodejs-loaders/alias/alias.loader.mjs';
 
+setCodemodName('correct-ts-specifiers');
+
 module.registerHooks(aliasLoader);
 
 export async function workflow({ contexts, files }: Api) {

recipes/import-assertions-to-attributes/src/re-work.ts

@@ -1,7 +1,11 @@
 exports[`logger > should emit error entries to standard error, collated by source module 1`] = `
-" • sh*t happened\\n • maybe bad\\n • sh*t happened\\n • maybe other bad\\n[Codemod: correct-ts-specifiers]: migration incomplete!\\n"
+" • sh*t happened\\n • maybe bad\\n • sh*t happened\\n • maybe other bad\\n[Codemod: test-codemod]: migration incomplete!\\n"
 `;
 
 exports[`logger > should emit non-error entries to standard out, collated by source module 1`] = `
-"[Codemod: correct-ts-specifiers]: /tmp/foo.js\\n • maybe don’t\\n • maybe not that either\\n • still maybe don’t\\n • more maybe not\\n[Codemod: correct-ts-specifiers]: migration complete!\\n"
+"[Codemod: test-codemod]: /tmp/foo.js\\n • maybe don’t\\n • maybe not that either\\n • still maybe don’t\\n • more maybe not\\n[Codemod: test-codemod]: migration complete!\\n"
+`;
+
+exports[`logger > should work without a codemod name 1`] = `
+"[Codemod: nodjs-codemod]: /tmp/foo.js\\n • maybe don’t\\n • maybe not that either\\n • still maybe don’t\\n • more maybe not\\n[Codemod: nodjs-codemod]: migration complete!\\n"
 `;

utils/src/logger.test.snap.cjs

@@ -13,7 +13,9 @@ describe('logger', { concurrency: true }, () => {
 				'--experimental-strip-types',
 				'-e',
 				dedent`
-				import { logger } from './logger.ts';
+				import { logger, setCodemodName } from './logger.ts';
+
+				setCodemodName('test-codemod');
 
 				const source1 = '/tmp/foo.js';
 				logger(source1, 'log', 'maybe don’t');
@@ -41,7 +43,9 @@ describe('logger', { concurrency: true }, () => {
 				'--experimental-strip-types',
 				'-e',
 				dedent`
-				import { logger } from './logger.ts';
+				import { logger, setCodemodName } from './logger.ts';
+
+				setCodemodName('test-codemod');
 
 				const source1 = '/tmp/foo.js';
 				logger(source1, 'error', 'sh*t happened');
@@ -60,4 +64,32 @@ describe('logger', { concurrency: true }, () => {
 		t.assert.snapshot(stderr);
 		assert.equal(code, 1);
 	});
+
+	it('should work without a codemod name', async (t) => {
+		const { code, stdout } = await spawnPromisified(
+			execPath,
+			[
+				'--no-warnings',
+				'--experimental-strip-types',
+				'-e',
+				dedent`
+				import { logger } from './logger.ts';
+
+				const source1 = '/tmp/foo.js';
+				logger(source1, 'log', 'maybe don’t');
+				logger(source1, 'log', 'maybe not that either');
+
+				const source2 = '/tmp/foo.js';
+				logger(source2, 'log', 'still maybe don’t');
+				logger(source2, 'log', 'more maybe not');
+			`,
+			],
+			{
+				cwd: import.meta.dirname,
+			},
+		);
+
+		t.assert.snapshot(stdout);
+		assert.equal(code, 0);
+	});
 });

utils/src/logger.test.ts

@@ -5,14 +5,23 @@ type LogType = 'error' | 'log' | 'warn';
 type FileLog = { msg: LogMsg; type: LogType };
 type Source = URL['pathname'];
 
+let codemodName = 'nodjs-codemod';
+
+/**
+ * Set the codemod name for logging output
+ */
+export const setCodemodName = (name: string) => {
+    codemodName = name;
+};
+
 /**
  * Collect log entries and report them at the end, collated by source module.
  */
 export const logger = (source: Source, type: LogType, msg: LogMsg) => {
-	const fileLog = new Set<FileLog>(logs.has(source) ? logs.get(source) : []);
+    const fileLog = new Set<FileLog>(logs.has(source) ? logs.get(source) : []);
 
-	fileLog.add({ msg, type });
-	logs.set(source, fileLog);
+    fileLog.add({ msg, type });
+    logs.set(source, fileLog);
 };
 
 /**
@@ -23,21 +32,21 @@ const logs = new Map<Source, Set<FileLog>>();
 process.once('beforeExit', emitLogs);
 
 function emitLogs() {
-	let hasError = false;
-
-	for (const [sourceFile, fileLog] of logs.entries()) {
-		console.log('[Codemod: correct-ts-specifiers]:', sourceFile);
-		for (const { msg, type } of fileLog) {
-			console[type](' •', msg);
-			if (type === 'error') hasError = true;
-		}
-	}
-
-	if (hasError) {
-		console.error('[Codemod: correct-ts-specifiers]: migration incomplete!');
-		process.exitCode = 1;
-	} else {
-		process.exitCode = 0;
-		console.log('[Codemod: correct-ts-specifiers]: migration complete!');
-	}
+    let hasError = false;
+
+    for (const [sourceFile, fileLog] of logs.entries()) {
+        console.log(`[Codemod: ${codemodName}]:`, sourceFile);
+        for (const { msg, type } of fileLog) {
+            console[type](' •', msg);
+            if (type === 'error') hasError = true;
+        }
+    }
+
+    if (hasError) {
+        console.error(`[Codemod: ${codemodName}]: migration incomplete!`);
+        process.exitCode = 1;
+    } else {
+        process.exitCode = 0;
+        console.log(`[Codemod: ${codemodName}]: migration complete!`);
+    }
 }