Added debug reporter. Improved error messages from plugin errors

Author: kevinwang5658

package.json

@@ -16,7 +16,8 @@
     "@inkjs/ui": "^1.0.0",
     "react": "^18.3.1",
     "chalk": "^5.3.0",
-    "parse-json": "^8.1.0"
+    "parse-json": "^8.1.0",
+    "debug": "^4.3.4"
   },
   "description": "Codify is a set up as code tool for developers",
   "devDependencies": {
@@ -30,6 +31,7 @@
     "@types/semver": "^7.5.4",
     "@types/react": "^18.3.1",
     "@types/chalk": "^2.2.0",
+    "@types/debug": "^4.1.12",
     "eslint-config-prettier": "^9.0.0",
     "chai": "^4",
     "chai-as-promised": "^7.1.1",

src/commands/plan/index.ts

@@ -3,7 +3,7 @@ import chalk from 'chalk';
 import * as path from 'node:path';
 
 import { PlanOrchestrator } from '../../orchestrators/plan.js';
-import { DefaultReporter } from '../../ui/reporters/default-reporter.js';
+import { DebugReporter } from '../../ui/reporters/debug-reporter.js';
 
 export default class Plan extends Command {
   static args = {
@@ -32,7 +32,7 @@ export default class Plan extends Command {
 
   public async run(): Promise<void> {
     const { flags } = await this.parse(Plan)
-    const reporter = new DefaultReporter()
+    const reporter = new DebugReporter()
 
     if (flags.path) {
       this.log(`Applying Codify from: ${flags.path}`);

src/events/context.ts

@@ -43,12 +43,12 @@ export const ctx = new class {
     this.emitter.emit(Event.STDOUT, ...args);
   }
 
-  pluginStdout(...args: unknown[]) {
-    this.emitter.emit(Event.PLUGIN_STDOUT, ...args);
+  pluginStdout(name: string, ...args: unknown[]) {
+    this.emitter.emit(Event.PLUGIN_STDOUT, name, ...args);
   }
 
-  pluginStderr(...args: unknown[]) {
-    this.emitter.emit(Event.PLUGIN_STDERR, ...args);
+  pluginStderr(name: string, ...args: unknown[]) {
+    this.emitter.emit(Event.PLUGIN_STDERR, name, ...args);
   }
 
   debug(...args: unknown[]) {
@@ -87,8 +87,8 @@ export const ctx = new class {
   attachOutputEmitters() {
     this.emitter.prependListener(Event.STDOUT, (...args) => this.onOutputEvent(...args));
     this.emitter.prependListener(Event.STDERR, (...args) => this.onOutputEvent(...args));
-    this.emitter.prependListener(Event.PLUGIN_STDOUT, (...args) => this.onOutputEvent(...args));
-    this.emitter.prependListener(Event.PLUGIN_STDERR, (...args) => this.onOutputEvent(...args));
+    this.emitter.prependListener(Event.PLUGIN_STDOUT, (name, ...args) => this.onOutputEvent(...args));
+    this.emitter.prependListener(Event.PLUGIN_STDERR, (name, ...args) => this.onOutputEvent(...args));
     this.emitter.prependListener(Event.DEBUG, (...args) => this.onOutputEvent(...args));
   }
 

src/plugins/plugin-process.ts

@@ -1,5 +1,6 @@
 import { IpcMessage, IpcMessageSchema } from 'codify-schemas';
 import { ChildProcess, fork } from 'node:child_process';
+import { createRequire } from 'node:module';
 
 import { ctx } from '../events/context.js';
 import { ajv } from '../utils/ajv.js';
@@ -29,14 +30,14 @@ export class PluginProcess {
       pluginPath,
       [],
       {
-        env: { ...process.env, FORCE_COLOR: '1' },
+        env: { ...process.env, FORCE_COLOR: '1', DEBUG_COLORS: '1' },
         silent: true,
         ...(isTypescript && { execArgv: ['--import', 'tsx'] }),
       },
     );
 
-    _process.stdout!.on('data', (message) => ctx.pluginStdout(message.toString('utf8')));
-    _process.stderr!.on('data', (message) => ctx.pluginStderr(message.toString('utf8')));
+    _process.stdout!.on('data', (message) => ctx.pluginStdout(name, message.toString('utf8')));
+    _process.stderr!.on('data', (message) => ctx.pluginStderr(name, message.toString('utf8')));
     _process.on('exit', (code) => {
       throw new Error(`Plugin ${this.name} exited with code ${code}`);
     })
@@ -64,6 +65,7 @@ export class PluginProcess {
   // Tsx is only installed for dev builds. Only allow typescript plugins for testing.
   private static isTsxInstalled(): boolean {
     try {
+      const require = createRequire(import.meta.url);
       require.resolve('tsx');
     } catch (e) {
       return false;

src/ui/reporters/debug-reporter.ts

@@ -0,0 +1,47 @@
+import { PlanResponseData } from 'codify-schemas';
+import readline from 'node:readline';
+import createDebug, { Debugger } from 'debug';
+
+import { ctx, Event } from '../../events/context.js';
+import { Reporter } from './reporter.js';
+
+const debug = createDebug('codify');
+
+export class DebugReporter implements Reporter {
+  private readonly rl = readline.createInterface(process.stdin, process.stdout);
+  private debuggerCache = new Map<string, Debugger>();
+
+  constructor() {
+    ctx.on(Event.PLUGIN_STDOUT, (name, args) => this.getPluginDebug(name)(args));
+    ctx.on(Event.PLUGIN_STDERR, (name, args) => this.getPluginDebug(name)(args));
+    ctx.on(Event.STDOUT, (args) => debug(args));
+    ctx.on(Event.STDERR, (args) => debug(args));
+    ctx.on(Event.DEBUG, (args) => debug(args));
+    ctx.on(Event.PROCESS_START, (name) => debug(name))
+    ctx.on(Event.PROCESS_FINISH, (name) => debug(name))
+    ctx.on(Event.SUB_PROCESS_START, (name) => debug(name))
+    ctx.on(Event.SUB_PROCESS_FINISH, (name) => debug(name))
+  }
+
+  async promptApplyConfirmation(): Promise<boolean> {
+    const response = await new Promise((resolve) => {
+      this.rl.question('Is this okay?\n', (answer) => resolve(answer));
+    });
+
+    return response === 'yes';
+  }
+
+  displayPlan(plan: PlanResponseData[]): void {
+    console.log(JSON.stringify(plan));
+  }
+
+  private getPluginDebug(name: string): Debugger {
+    const debuggerName = `plugin:${name}`;
+
+    if (!this.debuggerCache.has(name)) {
+      this.debuggerCache.set(name, createDebug(debuggerName));
+    }
+
+    return this.debuggerCache.get(name)!;
+  }
+}