Merge pull request #19 from kevinwang5658/kevin/improved-error-handling

Kevin/improved error handling

Author: kevinwang5658

README.md

@@ -28,8 +28,6 @@ USAGE
 # Commands
 <!-- commands -->
 * [`codify apply [FILE]`](#codify-apply-file)
-* [`codify hello PERSON`](#codify-hello-person)
-* [`codify hello world`](#codify-hello-world)
 * [`codify help [COMMANDS]`](#codify-help-commands)
 * [`codify plan [FILE]`](#codify-plan-file)
 * [`codify plugins`](#codify-plugins)
@@ -41,21 +39,27 @@ USAGE
 * [`codify plugins:uninstall PLUGIN...`](#codify-pluginsuninstall-plugin-1)
 * [`codify plugins:uninstall PLUGIN...`](#codify-pluginsuninstall-plugin-2)
 * [`codify plugins update`](#codify-plugins-update)
-* [`codify uninstall [RESOURCE]`](#codify-uninstall-resource)
+* [`codify uninstall`](#codify-uninstall)
 
 ## `codify apply [FILE]`
 
 describe the command here
 
 ```
 USAGE
-  $ codify apply [FILE] [-p <value>]
+  $ codify apply [FILE] [--json] [-o plain|default|debug|json] [--debug] [-p <value>]
 
 ARGUMENTS
   FILE  file to read
 
 FLAGS
-  -p, --path=<value>  path to project
+  -o, --output=<option>  [default: default]
+                         <options: plain|default|debug|json>
+  -p, --path=<value>     path to project
+  --debug
+
+GLOBAL FLAGS
+  --json  Format output as json.
 
 DESCRIPTION
   describe the command here
@@ -67,48 +71,6 @@ EXAMPLES
 _See
 code: [src/commands/apply/index.ts](https://github.com/kevinwang5658/codify/blob/v0.0.0/src/commands/apply/index.ts)_
 
-## `codify hello PERSON`
-
-Say hello
-
-```
-USAGE
-  $ codify hello PERSON -f <value>
-
-ARGUMENTS
-  PERSON  Person to say hello to
-
-FLAGS
-  -f, --from=<value>  (required) Who is saying hello
-
-DESCRIPTION
-  Say hello
-
-EXAMPLES
-  $ oex hello friend --from oclif
-  hello friend from oclif! (./src/commands/hello/index.ts)
-```
-
-_See code: [src/commands/hello/index.ts](https://github.com/kevinwang5658/codify/blob/v0.0.0/src/commands/hello/index.ts)_
-
-## `codify hello world`
-
-Say hello world
-
-```
-USAGE
-  $ codify hello world
-
-DESCRIPTION
-  Say hello world
-
-EXAMPLES
-  $ codify hello world
-  hello world! (./src/commands/hello/world.ts)
-```
-
-_See code: [src/commands/hello/world.ts](https://github.com/kevinwang5658/codify/blob/v0.0.0/src/commands/hello/world.ts)_
-
 ## `codify help [COMMANDS]`
 
 Display help for codify.
@@ -135,15 +97,21 @@ describe the command here
 
 ```
 USAGE
-  $ codify plan [FILE] [-f] [-n <value>] [-p <value>]
+  $ codify plan [FILE] [--json] [-o plain|default|debug|json] [--debug] [-f] [-n <value>] [-p <value>]
 
 ARGUMENTS
   FILE  file to read
 
 FLAGS
   -f, --force
-  -n, --name=<value>  name to print
-  -p, --path=<value>  path to project
+  -n, --name=<value>     name to print
+  -o, --output=<option>  [default: default]
+                         <options: plain|default|debug|json>
+  -p, --path=<value>     path to project
+  --debug
+
+GLOBAL FLAGS
+  --json  Format output as json.
 
 DESCRIPTION
   describe the command here
@@ -402,16 +370,21 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.4/src/commands/plugins/update.ts)_
 
-## `codify uninstall [RESOURCE]`
+## `codify uninstall`
 
 describe the command here
 
 ```
 USAGE
-  $ codify uninstall [RESOURCE]
+  $ codify uninstall [--json] [-o plain|default|debug|json] [--debug]
 
-ARGUMENTS
-  RESOURCE  resource type to uninstall
+FLAGS
+  -o, --output=<option>  [default: default]
+                         <options: plain|default|debug|json>
+  --debug
+
+GLOBAL FLAGS
+  --json  Format output as json.
 
 DESCRIPTION
   describe the command here

package.json

@@ -4,43 +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",
+    "chalk": "^5.3.0",
+    "codify-schemas": "1.0.32",
+    "debug": "^4.3.4",
     "ink": "^4.4.1",
-    "@inkjs/ui": "^1.0.0",
+    "parse-json": "^8.1.0",
     "react": "^18.3.1",
-    "chalk": "^5.3.0",
-    "parse-json": "^8.1.0"
+    "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",
-    "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,12 +1,12 @@
-import { Args, Command, Flags } from '@oclif/core'
+import { Args, Flags } from '@oclif/core'
 import { ResourceOperation } from 'codify-schemas';
-import path from 'node:path';
+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' }),
   }
@@ -24,36 +24,29 @@ export default class Apply extends Command {
 
   public async run(): Promise<void> {
     const { flags } = await this.parse(Apply)
-    const reporter = new DefaultReporter()
-
-    try {
-      if (flags.path) {
-        this.log(`Applying Codify from: ${flags.path}`);
-      }
-
-      const resolvedPath = path.resolve(flags.path ?? '.');
-
-      const planResult = await PlanOrchestrator.run(resolvedPath, false);
-      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');
-        await planResult.pluginCollection.destroy();
-        return process.exit(0);
-      }
-
-      const confirm = await reporter.promptApplyConfirmation()
-      if (!confirm) {
-        return process.exit(0);
-      }
-
-      await ApplyOrchestrator.run(planResult);
-    } catch (error: unknown) {
-      console.error(error);
-      process.exit(1);
+
+    if (flags.path) {
+      this.log(`Applying Codify from: ${flags.path}`);
+    }
+
+    const resolvedPath = path.resolve(flags.path ?? '.');
+
+    const planResult = await PlanOrchestrator.run(resolvedPath);
+    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 this.reporter.promptApplyConfirmation()
+    if (!confirm) {
+      return process.exit(0);
     }
 
+    await ApplyOrchestrator.run(planResult);
+
     process.exit(0);
   }
 }

src/commands/hello/index.ts

@@ -1,10 +1,10 @@
-import { Args, Command, Flags } from '@oclif/core'
+import { Args, Flags } from '@oclif/core'
 import * as path from 'node:path';
 
 import { PlanOrchestrator } from '../../orchestrators/plan.js';
-import { DefaultReporter } from '../../ui/reporters/default-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' }),
   }
@@ -26,21 +26,15 @@ export default class Plan extends Command {
 
   public async run(): Promise<void> {
     const { flags } = await this.parse(Plan)
-    const reporter = new DefaultReporter()
 
-    try {
-      if (flags.path) {
-        this.log(`Applying Codify from: ${flags.path}`);
-      }
-
-      const resolvedPath = path.resolve(flags.path ?? '.');
+    if (flags.path) {
+      this.log(`Applying Codify from: ${flags.path}`);
+    }
 
-      const { plan } = await PlanOrchestrator.run(resolvedPath);
-      reporter.displayPlan(plan);
+    const resolvedPath = path.resolve(flags.path ?? '.');
 
-    } catch (error) {
-      console.error(error);
-    }
+    const { plan } = await PlanOrchestrator.run(resolvedPath);
+    this.reporter.displayPlan(plan);
 
     process.exit(0);
   }