chore: upgrade oclif to v2

package.json

@@ -17,7 +17,7 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@oclif/core": "^1.26.2",
+    "@oclif/core": "^2",
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-plugins": "^2.4.7",
     "@prantlf/jsonlint": "^11.7.2",

src/commands/commit/index.ts

@@ -6,7 +6,7 @@ import { KnockEnv } from "@/lib/helpers/const";
 import { withSpinner } from "@/lib/helpers/request";
 import { promptToConfirm } from "@/lib/helpers/ux";
 
-export default class Commit extends BaseCommand {
+export default class Commit extends BaseCommand<typeof Commit> {
   static summary = "Commit all changes in development environment.";
 
   static flags = {

src/commands/commit/promote.ts

@@ -5,7 +5,7 @@ import BaseCommand from "@/lib/base-command";
 import { withSpinner } from "@/lib/helpers/request";
 import { promptToConfirm } from "@/lib/helpers/ux";
 
-export default class CommitPromote extends BaseCommand {
+export default class CommitPromote extends BaseCommand<typeof CommitPromote> {
   static summary = "Promote all changes to the destination environment.";
 
   static flags = {

src/commands/knock.ts

@@ -21,7 +21,7 @@ const JOKES = [
   ["Beets.", "Beets who?", "Beets me!"],
 ];
 
-export default class Knock extends BaseCommand {
+export default class Knock extends BaseCommand<typeof Knock> {
   // Because, it's a secret :)
   static hidden = true;
 

src/commands/ping.ts

@@ -1,6 +1,6 @@
 import BaseCommand from "@/lib/base-command";
 
-export default class Ping extends BaseCommand {
+export default class Ping extends BaseCommand<typeof Ping> {
   // Deprecated, in favor of the whoami command.
   static hidden = true;
 

src/commands/translation/get.ts

@@ -1,16 +1,14 @@
-import { CliUx, Flags } from "@oclif/core";
+import { Args, Flags, ux } from "@oclif/core";
 
 import * as ApiV1 from "@/lib/api-v1";
 import BaseCommand from "@/lib/base-command";
 import { formatDate } from "@/lib/helpers/date";
 import { withSpinner } from "@/lib/helpers/request";
 import * as Translation from "@/lib/marshal/translation";
 
-export default class TranslationGet extends BaseCommand {
+export default class TranslationGet extends BaseCommand<typeof TranslationGet> {
   static summary = "Display a single translation from an environment.";
 
-  static description = Translation.translationRefDescription;
-
   static flags = {
     environment: Flags.string({
       default: "development",
@@ -21,7 +19,12 @@ export default class TranslationGet extends BaseCommand {
     }),
   };
 
-  static args = [{ name: "translationRef", required: true }];
+  static args = {
+    translationRef: Args.string({
+      description: Translation.translationRefDescription,
+      required: true,
+    }),
+  };
 
   static enableJsonFlag = true;
 
@@ -82,7 +85,7 @@ export default class TranslationGet extends BaseCommand {
       },
     ];
 
-    CliUx.ux.table(rows, {
+    ux.table(rows, {
       key: {
         header: "Translation",
         minWidth: 24,
@@ -94,6 +97,6 @@ export default class TranslationGet extends BaseCommand {
     });
 
     this.log("");
-    CliUx.ux.styledJSON(JSON.parse(translation.content));
+    ux.styledJSON(JSON.parse(translation.content));
   }
 }

src/commands/translation/list.ts

@@ -1,4 +1,4 @@
-import { CliUx, Flags } from "@oclif/core";
+import { Flags, ux } from "@oclif/core";
 import { AxiosResponse } from "axios";
 
 import * as ApiV1 from "@/lib/api-v1";
@@ -13,7 +13,9 @@ import {
 import { withSpinner } from "@/lib/helpers/request";
 import * as Translation from "@/lib/marshal/translation";
 
-export default class TranslationList extends BaseCommand {
+export default class TranslationList extends BaseCommand<
+  typeof TranslationList
+> {
   static summary = "Display all translations for an environment.";
 
   static flags = {
@@ -64,7 +66,7 @@ export default class TranslationList extends BaseCommand {
      * Translations list table
      */
 
-    CliUx.ux.table(entries, {
+    ux.table(entries, {
       ref: {
         header: "Ref",
         get: (entry) => Translation.formatRef(entry),

src/commands/translation/pull.ts

@@ -1,4 +1,4 @@
-import { Flags } from "@oclif/core";
+import { Args, Flags } from "@oclif/core";
 
 import * as ApiV1 from "@/lib/api-v1";
 import BaseCommand from "@/lib/base-command";
@@ -16,12 +16,12 @@ import { promptToConfirm, spinner } from "@/lib/helpers/ux";
 import * as Translation from "@/lib/marshal/translation";
 import { TranslationDirContext } from "@/lib/run-context";
 
-export default class TranslationPull extends BaseCommand {
+export default class TranslationPull extends BaseCommand<
+  typeof TranslationPull
+> {
   static summary =
     "Pull one or more translations from an environment into a local file system.";
 
-  static description = Translation.translationRefDescription;
-
   static flags = {
     environment: Flags.string({
       default: "development",
@@ -43,7 +43,12 @@ export default class TranslationPull extends BaseCommand {
     }),
   };
 
-  static args = [{ name: "translationRef", required: false }];
+  static args = {
+    translationRef: Args.string({
+      description: Translation.translationRefDescription,
+      required: false,
+    }),
+  };
 
   async run(): Promise<void> {
     const target = await Translation.ensureValidCommandTarget(

src/commands/translation/push.ts

@@ -1,4 +1,4 @@
-import { Flags } from "@oclif/core";
+import { Args, Flags } from "@oclif/core";
 
 import BaseCommand from "@/lib/base-command";
 import { KnockEnv } from "@/lib/helpers/const";
@@ -11,12 +11,12 @@ import * as Translation from "@/lib/marshal/translation";
 
 import TranslationValidate from "./validate";
 
-export default class TranslationPush extends BaseCommand {
+export default class TranslationPush extends BaseCommand<
+  typeof TranslationPush
+> {
   static summary =
     "Push one or more translations from a local file system to Knock.";
 
-  static description = Translation.translationRefDescription;
-
   static flags = {
     environment: Flags.string({
       summary:
@@ -41,7 +41,12 @@ export default class TranslationPush extends BaseCommand {
     }),
   };
 
-  static args = [{ name: "translationRef", required: false }];
+  static args = {
+    translationRef: Args.string({
+      description: Translation.translationRefDescription,
+      required: false,
+    }),
+  };
 
   async run(): Promise<void> {
     const { flags } = this.props;

src/commands/translation/validate.ts

@@ -1,4 +1,4 @@
-import { Flags } from "@oclif/core";
+import { Args, Flags } from "@oclif/core";
 
 import * as ApiV1 from "@/lib/api-v1";
 import BaseCommand, { Props } from "@/lib/base-command";
@@ -10,12 +10,14 @@ import { indentString } from "@/lib/helpers/string";
 import { spinner } from "@/lib/helpers/ux";
 import * as Translation from "@/lib/marshal/translation";
 
-export default class TranslationValidate extends BaseCommand {
+import TranslationPush from "./push";
+
+export default class TranslationValidate extends BaseCommand<
+  typeof TranslationValidate
+> {
   static summary =
     "Validate one or more translations from a local file system.";
 
-  static description = Translation.translationRefDescription;
-
   static flags = {
     environment: Flags.string({
       summary:
@@ -34,7 +36,12 @@ export default class TranslationValidate extends BaseCommand {
     }),
   };
 
-  static args = [{ name: "translationRef", required: false }];
+  static args = {
+    translationRef: Args.string({
+      description: Translation.translationRefDescription,
+      required: false,
+    }),
+  };
 
   async run(): Promise<void> {
     const target = await Translation.ensureValidCommandTarget(
@@ -75,7 +82,7 @@ export default class TranslationValidate extends BaseCommand {
 
   static async validateAll(
     api: ApiV1.T,
-    props: Props,
+    props: Props<typeof TranslationValidate | typeof TranslationPush>,
     translations: Translation.TranslationFileData[],
   ): Promise<SourceError[]> {
     // TODO: Throw if a non validation error (e.g. authentication error) instead

src/commands/whoami.ts

@@ -3,7 +3,7 @@ import BaseCommand from "@/lib/base-command";
 import { withSpinner } from "@/lib/helpers/request";
 import { indentString } from "@/lib/helpers/string";
 
-export default class Whoami extends BaseCommand {
+export default class Whoami extends BaseCommand<typeof Whoami> {
   static summary = "Verify the provided service token.";
 
   static enableJsonFlag = true;

src/commands/workflow/activate.ts

@@ -1,12 +1,14 @@
-import { Flags } from "@oclif/core";
+import { Args, Flags } from "@oclif/core";
 
 import * as ApiV1 from "@/lib/api-v1";
 import BaseCommand from "@/lib/base-command";
 import { booleanStr } from "@/lib/helpers/flag";
 import { withSpinner } from "@/lib/helpers/request";
 import { promptToConfirm } from "@/lib/helpers/ux";
 
-export default class WorkflowActivate extends BaseCommand {
+export default class WorkflowActivate extends BaseCommand<
+  typeof WorkflowActivate
+> {
   static summary = "Activate or deactivate a workflow in a given environment.";
 
   static description = `
@@ -33,7 +35,11 @@ with \`false\` in order to deactivate it.
     }),
   };
 
-  static args = [{ name: "workflowKey", required: true }];
+  static args = {
+    workflowKey: Args.string({
+      required: true,
+    }),
+  };
 
   async run(): Promise<void> {
     const { args, flags } = this.props;

src/commands/workflow/get.ts

@@ -1,4 +1,4 @@
-import { CliUx, Flags } from "@oclif/core";
+import { Args, Flags, ux } from "@oclif/core";
 
 import * as ApiV1 from "@/lib/api-v1";
 import BaseCommand from "@/lib/base-command";
@@ -7,7 +7,7 @@ import { withSpinner } from "@/lib/helpers/request";
 import * as Conditions from "@/lib/marshal/conditions";
 import * as Workflow from "@/lib/marshal/workflow";
 
-export default class WorkflowGet extends BaseCommand {
+export default class WorkflowGet extends BaseCommand<typeof WorkflowGet> {
   static summary = "Display a single workflow from an environment.";
 
   static flags = {
@@ -20,7 +20,11 @@ export default class WorkflowGet extends BaseCommand {
     }),
   };
 
-  static args = [{ name: "workflowKey", required: true }];
+  static args = {
+    workflowKey: Args.string({
+      required: true,
+    }),
+  };
 
   static enableJsonFlag = true;
 
@@ -82,7 +86,7 @@ export default class WorkflowGet extends BaseCommand {
       },
     ];
 
-    CliUx.ux.table(rows, {
+    ux.table(rows, {
       key: {
         header: "Workflow",
         minWidth: 24,
@@ -95,8 +99,9 @@ export default class WorkflowGet extends BaseCommand {
 
     this.log("");
 
+    // Leading space is there intentionally to align the left padding.
     if (workflow.steps.length === 0) {
-      return CliUx.ux.log(" This workflow has no steps to display.");
+      return ux.log(" This workflow has no steps to display.");
     }
 
     /*
@@ -105,7 +110,7 @@ export default class WorkflowGet extends BaseCommand {
 
     const steps = workflow.steps.map((step, index) => ({ ...step, index }));
 
-    CliUx.ux.table(steps, {
+    ux.table(steps, {
       index: {
         header: "Steps",
         get: (step) => step.index + 1,

src/commands/workflow/list.ts

@@ -1,4 +1,4 @@
-import { CliUx, Flags } from "@oclif/core";
+import { Flags, ux } from "@oclif/core";
 import { AxiosResponse } from "axios";
 
 import * as ApiV1 from "@/lib/api-v1";
@@ -13,7 +13,7 @@ import {
 import { withSpinner } from "@/lib/helpers/request";
 import * as Workflow from "@/lib/marshal/workflow";
 
-export default class WorkflowList extends BaseCommand {
+export default class WorkflowList extends BaseCommand<typeof WorkflowList> {
   static summary = "Display all workflows for an environment.";
 
   static flags = {
@@ -64,7 +64,7 @@ export default class WorkflowList extends BaseCommand {
      * Workflows list table
      */
 
-    CliUx.ux.table(entries, {
+    ux.table(entries, {
       key: {
         header: "Key",
       },

src/commands/workflow/new.ts

@@ -1,6 +1,6 @@
 import * as path from "node:path";
 
-import { Flags } from "@oclif/core";
+import { Args, Flags } from "@oclif/core";
 import * as fs from "fs-extra";
 
 import BaseCommand from "@/lib/base-command";
@@ -9,13 +9,17 @@ import { spinner } from "@/lib/helpers/ux";
 import * as Workflow from "@/lib/marshal/workflow";
 import { WorkflowDirContext } from "@/lib/run-context";
 
-export default class WorkflowNew extends BaseCommand {
+export default class WorkflowNew extends BaseCommand<typeof WorkflowNew> {
   static flags = {
     steps: Flags.string({ aliases: ["step"] }),
     force: Flags.boolean(),
   };
 
-  static args = [{ name: "workflowKey", required: true }];
+  static args = {
+    workflowKey: Args.string({
+      required: true,
+    }),
+  };
 
   // TODO(KNO-3072): Unhide after we move the generator logic to the backend.
   static hidden = true;