Added reporter factory and moved reporter initialization to base command class.

Author: kevinwang5658

package.json

@@ -4,45 +4,45 @@
     "codify": "./bin/run.js"
   },
   "dependencies": {
+    "@inkjs/ui": "^1.0.0",
     "@oclif/core": "^3",
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-plugins": "^3.8.4",
-    "semver": "^7.5.4",
-    "codify-schemas": "1.0.32",
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
-    "tsx": "^4.7.3",
-    "ink": "^4.4.1",
-    "@inkjs/ui": "^1.0.0",
-    "react": "^18.3.1",
     "chalk": "^5.3.0",
+    "codify-schemas": "1.0.32",
+    "debug": "^4.3.4",
+    "ink": "^4.4.1",
     "parse-json": "^8.1.0",
-    "debug": "^4.3.4"
+    "react": "^18.3.1",
+    "semver": "^7.5.4",
+    "supports-color": "^9.4.0"
   },
   "description": "Codify is a set up as code tool for developers",
   "devDependencies": {
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^3",
     "@types/chai": "^4",
     "@types/chai-as-promised": "^7.1.7",
+    "@types/chalk": "^2.2.0",
+    "@types/debug": "^4.1.12",
     "@types/mocha": "^9.0.0",
     "@types/mock-fs": "^4.13.3",
     "@types/node": "^18",
-    "@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",
+    "@types/semver": "^7.5.4",
     "chai": "^4",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.51.0",
     "eslint-config-oclif": "^5",
     "eslint-config-oclif-typescript": "^3",
+    "eslint-config-prettier": "^9.0.0",
     "mocha": "^10",
     "mock-fs": "^5.2.0",
     "oclif": "^4.5.7",
     "shx": "^0.3.3",
-    "ts-node": "^10.9.1",
+    "tsx": "^4.7.3",
     "typescript": "^5",
     "vitest": "^1.4.0"
   },

src/commands/apply/index.ts

@@ -1,13 +1,12 @@
-import { Args, Command, Flags } from '@oclif/core'
-import chalk from 'chalk';
+import { Args, Flags } from '@oclif/core'
 import { ResourceOperation } from 'codify-schemas';
 import * as path from 'node:path';
 
 import { ApplyOrchestrator } from '../../orchestrators/apply.js';
 import { PlanOrchestrator } from '../../orchestrators/plan.js';
-import { DefaultReporter } from '../../ui/reporters/default-reporter.js';
+import { BaseCommand } from '../../common/base-command.js';
 
-export default class Apply extends Command {
+export default class Apply extends BaseCommand {
   static args = {
     file: Args.string({ description: 'file to read' }),
   }
@@ -23,14 +22,8 @@ export default class Apply extends Command {
     path: Flags.string({ char: 'p', description: 'path to project' }),
   }
 
-  protected async catch(err: Error): Promise<void> {
-    console.log(chalk.red(err.message));
-    process.exit(1);
-  }
-
   public async run(): Promise<void> {
     const { flags } = await this.parse(Apply)
-    const reporter = new DefaultReporter()
 
     if (flags.path) {
       this.log(`Applying Codify from: ${flags.path}`);
@@ -39,15 +32,15 @@ export default class Apply extends Command {
     const resolvedPath = path.resolve(flags.path ?? '.');
 
     const planResult = await PlanOrchestrator.run(resolvedPath);
-    reporter.displayPlan(planResult.plan);
+    this.reporter.displayPlan(planResult.plan);
 
     // Short circuit and exit if every change is NOOP
     if (planResult.plan.every((p) => p.operation === ResourceOperation.NOOP)) {
       console.log('No changes necessary. Exiting');
       return process.exit(0);
     }
 
-    const confirm = await reporter.promptApplyConfirmation()
+    const confirm = await this.reporter.promptApplyConfirmation()
     if (!confirm) {
       return process.exit(0);
     }

src/commands/hello/index.ts

@@ -1,11 +1,10 @@
-import { Args, Command, Flags } from '@oclif/core'
-import chalk from 'chalk';
+import { Args, Flags } from '@oclif/core'
 import * as path from 'node:path';
 
 import { PlanOrchestrator } from '../../orchestrators/plan.js';
-import { DebugReporter } from '../../ui/reporters/debug-reporter.js';
+import { BaseCommand } from '../../common/base-command.js';
 
-export default class Plan extends Command {
+export default class Plan extends BaseCommand {
   static args = {
     file: Args.string({ description: 'file to read' }),
   }
@@ -16,11 +15,6 @@ export default class Plan extends Command {
     '<%= config.bin %> <%= command.id %>',
   ]
 
-  protected async catch(err: Error): Promise<void> {
-    console.log(chalk.red(err.message));
-    process.exit(1);
-  }
-
   static flags = {
     // flag with no value (-f, --force)
     force: Flags.boolean({ char: 'f' }),
@@ -32,7 +26,6 @@ export default class Plan extends Command {
 
   public async run(): Promise<void> {
     const { flags } = await this.parse(Plan)
-    const reporter = new DebugReporter()
 
     if (flags.path) {
       this.log(`Applying Codify from: ${flags.path}`);
@@ -41,7 +34,7 @@ export default class Plan extends Command {
     const resolvedPath = path.resolve(flags.path ?? '.');
 
     const { plan } = await PlanOrchestrator.run(resolvedPath);
-    reporter.displayPlan(plan);
+    this.reporter.displayPlan(plan);
 
     process.exit(0);
   }

src/commands/hello/world.ts

@@ -1,10 +1,9 @@
-import { Args, Command } from '@oclif/core'
-import chalk from 'chalk';
+import { Args } from '@oclif/core'
 
 import { UninstallOrchestrator } from '../orchestrators/uninstall.js';
-import { DefaultReporter } from '../ui/reporters/default-reporter.js';
+import { BaseCommand } from '../common/base-command.js';
 
-export default class Uninstall extends Command {
+export default class Uninstall extends BaseCommand {
   static description = 'describe the command here'
 
   static examples = [
@@ -22,22 +21,13 @@ export default class Uninstall extends Command {
     }),
   }
 
-  protected async catch(err: Error): Promise<void> {
-    console.log(chalk.red(err.message));
-    process.exit(1);
-  }
-
   public async run(): Promise<void> {
     const { raw } = await this.parse(Uninstall)
-    new DefaultReporter()
 
     const args = raw
       .filter((r) => r.type === 'arg')
       .map((r) => r.input);
 
-
-    // const name = flags.name ?? 'world'
-    // this.log(`hello ${name} from /Users/kevinwang/Projects/codify2/codify/src/commands/uninstall.ts`)
     if (args.length === 0) {
       throw new Error('A resource id must be specified for uninstall. Ex: "codify uninstall homebrew"')
     }

src/commands/plan/index.ts

@@ -0,0 +1,63 @@
+import { Command, Flags } from '@oclif/core';
+import { Reporter, ReporterFactory, ReporterType } from '../ui/reporters/reporter.js';
+import { FlagOutput } from '@oclif/core/lib/interfaces/parser.js';
+import createDebug from 'debug';
+import chalk from 'chalk';
+
+export abstract class BaseCommand extends Command {
+
+  static enableJsonFlag = true;
+  static baseFlags = {
+    'output': Flags.option({
+      default: 'default',
+      char: 'o',
+      options: ['plain', 'default', 'debug', 'json'],
+    })(),
+    'debug': Flags.boolean()
+  }
+  protected reporter!: Reporter;
+
+  public async init(): Promise<void> {
+    await super.init();
+
+    const { flags } = await this.parse({
+      baseFlags: (super.ctor as typeof BaseCommand).baseFlags,
+    });
+
+    const reporterType = this.getReporterType(flags);
+    this.reporter = ReporterFactory.create(reporterType)
+  }
+
+  protected async catch(err: Error): Promise<void> {
+    console.log(chalk.red(err.message));
+    process.exit(1);
+  }
+
+  private getReporterType(flags: FlagOutput): ReporterType {
+    const debug = createDebug('codify');
+
+    if (debug.enabled || flags.debug) {
+      createDebug.enable('*');
+      return ReporterType.DEBUG;
+    }
+
+    if (this.jsonEnabled()) {
+      return ReporterType.JSON;
+    }
+
+    if (flags.output) {
+      switch (flags.output) {
+        case 'debug':
+          return ReporterType.DEBUG;
+        case 'json':
+          return ReporterType.JSON;
+        case 'plain':
+          return ReporterType.PLAIN;
+        case 'default':
+          return ReporterType.DEFAULT;
+      }
+    }
+
+    return ReporterType.DEFAULT;
+  }
+}

src/commands/uninstall.ts

@@ -12,8 +12,8 @@ export class DebugReporter implements Reporter {
   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.PLUGIN_STDOUT, (name, args) => this.getDebug(name)(args));
+    ctx.on(Event.PLUGIN_STDERR, (name, args) => this.getDebug(name)(args));
     ctx.on(Event.STDOUT, (args) => debug(args));
     ctx.on(Event.STDERR, (args) => debug(args));
     ctx.on(Event.DEBUG, (args) => debug(args));
@@ -35,11 +35,11 @@ export class DebugReporter implements Reporter {
     console.log(JSON.stringify(plan));
   }
 
-  private getPluginDebug(name: string): Debugger {
+  private getDebug(name: string): Debugger {
     const debuggerName = `plugin:${name}`;
 
     if (!this.debuggerCache.has(name)) {
-      this.debuggerCache.set(name, createDebug(debuggerName));
+      this.debuggerCache.set(name, createDebug(`plugin:${name}`));
     }
 
     return this.debuggerCache.get(name)!;

src/common/base-command.ts

@@ -7,7 +7,6 @@ import { Reporter } from './reporter.js';
 export class PlainReporter implements Reporter {
   private readonly rl = readline.createInterface(process.stdin, process.stdout);
 
-
   constructor() {
     ctx.on(Event.OUTPUT, (...args) => console.log(...args))
     ctx.on(Event.PROCESS_START, (name) => console.log(name))

src/ui/reporters/debug-reporter.ts

@@ -1,4 +1,7 @@
 import { PlanResponseData } from 'codify-schemas';
+import { DebugReporter } from './debug-reporter.js';
+import { PlainReporter } from './plain-reporter.js';
+import { DefaultReporter } from './default-reporter.js';
 
 export enum RenderEvent {
   LOG = 'log',
@@ -30,3 +33,25 @@ export interface Reporter {
 
   promptApplyConfirmation(): Promise<boolean>
 }
+
+export enum ReporterType {
+  DEBUG,
+  DEFAULT,
+  PLAIN,
+  JSON
+}
+
+export class ReporterFactory {
+  static create(type: ReporterType): Reporter {
+    switch (type) {
+      case ReporterType.DEBUG:
+        return new DebugReporter();
+      case ReporterType.PLAIN:
+        return new PlainReporter();
+      case ReporterType.JSON:
+        return new DefaultReporter();
+      default:
+        return new DefaultReporter();
+    }
+  }
+}