@flowscripter/dynamic-cli-framework 1.2.1 → 1.3.0

package/src/util/runnerHelper.ts

@@ -1,28 +1,17 @@
 import type PrinterService from "../api/service/core/PrinterService.ts";
-import {
-  Icon,
-  PRINTER_SERVICE_ID,
-} from "../api/service/core/PrinterService.ts";
+import { Icon, PRINTER_SERVICE_ID } from "../api/service/core/PrinterService.ts";
 import type { ParseResult } from "../runtime/parser.ts";
-import {
-  isGlobalCommand,
-  isGlobalModifierCommand,
-} from "../runtime/command/CommandTypeGuards.ts";
+import { isGlobalCommand, isGlobalModifierCommand } from "../runtime/command/CommandTypeGuards.ts";
 import type Context from "../api/Context.ts";
 import { getInvalidArgumentString } from "../runtime/values/argumentValueValidation.ts";
 import type CommandRegistry from "../runtime/registry/CommandRegistry.ts";
 import { findPossibleCommandNames } from "./helpHelper.ts";
 
-function getCommandString(
-  printerService: PrinterService,
-  parseResult: ParseResult,
-): string {
+function getCommandString(printerService: PrinterService, parseResult: ParseResult): string {
   const { command, groupCommand } = parseResult;
 
   if (groupCommand) {
-    return printerService.yellow(
-      `'${groupCommand.name}:${command.name}'`,
-    );
+    return printerService.yellow(`'${groupCommand.name}:${command.name}'`);
   }
   return printerService.yellow(`'${command.name}'`);
 }
@@ -32,29 +21,21 @@ export async function printParseResultError(
   parseResult: ParseResult,
   isDefaultCommand = false,
 ) {
-  const printerService = context.getServiceById(
-    PRINTER_SERVICE_ID,
-  ) as PrinterService;
+  const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
   const commandErrorString = isDefaultCommand
     ? "Parse error: "
-    : `Parse error for command: ${
-      getCommandString(printerService, parseResult)
-    }`;
+    : `Parse error for command: ${getCommandString(printerService, parseResult)}`;
   const { command, invalidArguments } = parseResult;
 
   let errorString = "=> ";
 
-  const skipArgName = isGlobalModifierCommand(command) ||
-    isGlobalCommand(command);
-  const argsString = invalidArguments.map(
-    (arg) => getInvalidArgumentString(arg, skipArgName),
-  ).join(", ");
+  const skipArgName = isGlobalModifierCommand(command) || isGlobalCommand(command);
+  const argsString = invalidArguments
+    .map((arg) => getInvalidArgumentString(arg, skipArgName))
+    .join(", ");
   errorString = `${errorString}${printerService.yellow(argsString)}`;
 
-  await printerService.error(
-    `${commandErrorString}\n  ${errorString}\n\n`,
-    Icon.FAILURE,
-  );
+  await printerService.error(`${commandErrorString}\n  ${errorString}\n\n`, Icon.FAILURE);
 }
 
 export async function printCommandExecutionError(
@@ -63,14 +44,10 @@ export async function printCommandExecutionError(
   err: Error,
   isDefaultCommand = false,
 ) {
-  const printerService = context.getServiceById(
-    PRINTER_SERVICE_ID,
-  ) as PrinterService;
+  const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
   const commandErrorString = isDefaultCommand
     ? "Execution error: "
-    : `Execution error for command: ${
-      getCommandString(printerService, parseResult)
-    }`;
+    : `Execution error for command: ${getCommandString(printerService, parseResult)}`;
   if (err !== undefined) {
     await printerService.error(
       `${commandErrorString}\n  => ${printerService.yellow(err.message)}\n\n`,
@@ -78,18 +55,14 @@ export async function printCommandExecutionError(
     );
   } else {
     await printerService.error(
-      `${commandErrorString}\n  => ${
-        printerService.yellow("error is undefined")
-      }\n\n`,
+      `${commandErrorString}\n  => ${printerService.yellow("error is undefined")}\n\n`,
       Icon.FAILURE,
     );
   }
 }
 
 export async function printNoCommandSpecifiedError(context: Context) {
-  const printerService = context.getServiceById(
-    PRINTER_SERVICE_ID,
-  ) as PrinterService;
+  const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
   await printerService.error("No command specified\n\n");
 }
 
@@ -98,9 +71,7 @@ export async function printNoCommandRecognisedError(
   commandRegistry: CommandRegistry,
   availableArgs: ReadonlyArray<string>,
 ) {
-  const printerService = context.getServiceById(
-    PRINTER_SERVICE_ID,
-  ) as PrinterService;
+  const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
   await printerService.error("No command recognised\n\n");
 
   if (availableArgs.length > 0) {
@@ -110,11 +81,7 @@ export async function printNoCommandRecognisedError(
     const allPossibleCommandNames: string[] = [];
     for (const arg of availableArgs) {
       // look for other possible matches
-      const possibleCommandNames = findPossibleCommandNames(
-        arg,
-        groupCommands,
-        subCommands,
-      );
+      const possibleCommandNames = findPossibleCommandNames(arg, groupCommands, subCommands);
       // add the possible command names to the list if not already present
       for (const possibleCommandName of possibleCommandNames) {
         if (!allPossibleCommandNames.includes(possibleCommandName)) {
@@ -136,18 +103,10 @@ export async function printUnusedArgsWarning(
   context: Context,
   overallUnusedArgs: ReadonlyArray<string>,
 ) {
-  const printerService = context.getServiceById(
-    PRINTER_SERVICE_ID,
-  ) as PrinterService;
+  const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
   if (overallUnusedArgs.length === 1) {
-    await printerService.warn(
-      `Unused arg: ${overallUnusedArgs[0]}\n\n`,
-      Icon.ALERT,
-    );
+    await printerService.warn(`Unused arg: ${overallUnusedArgs[0]}\n\n`, Icon.ALERT);
   } else {
-    await printerService.warn(
-      `Unused args: ${overallUnusedArgs.join(" ")}\n\n`,
-      Icon.ALERT,
-    );
+    await printerService.warn(`Unused args: ${overallUnusedArgs.join(" ")}\n\n`, Icon.ALERT);
   }
 }

package/tests/cli/BaseCLI.test.ts

@@ -12,13 +12,8 @@ import { RunState } from "../../src/api/RunResult.ts";
 import { ArgumentValueTypeName } from "../../src/api/argument/ArgumentValueTypes.ts";
 import BaseCLI from "../../src/cli/BaseCLI.ts";
 import type KeyValueService from "../../src/api/service/core/KeyValueService.ts";
-import {
-  KEY_VALUE_SERVICE_ID,
-} from "../../src/api/service/core/KeyValueService.ts";
-import type {
-  ServiceInfo,
-  ServiceProvider,
-} from "../../src/api/service/ServiceProvider.ts";
+import { KEY_VALUE_SERVICE_ID } from "../../src/api/service/core/KeyValueService.ts";
+import type { ServiceInfo, ServiceProvider } from "../../src/api/service/ServiceProvider.ts";
 import type Context from "../../src/api/Context.ts";
 import type CLIConfig from "../../src/api/CLIConfig.ts";
 import StreamString from "../fixtures/StreamString.ts";
@@ -76,14 +71,9 @@ describe("BaseCLI tests", () => {
     let modifierHasRun = false;
     let subHasRun = false;
 
-    const modifierCommand = getGlobalModifierCommandWithArgument(
-      "modifier",
-      "m",
-      1,
-      {
-        type: ArgumentValueTypeName.STRING,
-      },
-    );
+    const modifierCommand = getGlobalModifierCommandWithArgument("modifier", "m", 1, {
+      type: ArgumentValueTypeName.STRING,
+    });
     const option = {
       name: "foo",
       type: ArgumentValueTypeName.STRING,
@@ -103,13 +93,7 @@ describe("BaseCLI tests", () => {
     baseCLI.addCommand(modifierCommand);
     baseCLI.addCommand(subCommand);
 
-    const runResult = await baseCLI.run([
-      "unused",
-      "--modifier=bar",
-      "command",
-      "--foo",
-      "bar",
-    ]);
+    const runResult = await baseCLI.run(["unused", "--modifier=bar", "command", "--foo", "bar"]);
 
     expect(runResult.runState).toEqual(RunState.SUCCESS);
     expect(modifierHasRun).toBeTrue();
@@ -158,24 +142,13 @@ describe("BaseCLI tests", () => {
 
       async serviceMethod(context: Context): Promise<void> {
         expect(await this.copyOfKeyValueService!.hasKey("name")).toBeTrue();
-        expect(
-          await this.copyOfKeyValueService!.getKey("name"),
-        ).toEqual(
-          "modifierCommand",
-        );
-        await this.copyOfKeyValueService!.setKey(
-          "name",
-          "defaultService1+modifierCommand",
-        );
+        expect(await this.copyOfKeyValueService!.getKey("name")).toEqual("modifierCommand");
+        await this.copyOfKeyValueService!.setKey("name", "defaultService1+modifierCommand");
 
-        const keyValueService = context.getServiceById(
-          KEY_VALUE_SERVICE_ID,
-        ) as KeyValueService;
+        const keyValueService = context.getServiceById(KEY_VALUE_SERVICE_ID) as KeyValueService;
 
         expect(await keyValueService.hasKey("name")).toBeTrue();
-        expect(
-          await this.copyOfKeyValueService!.getKey("name"),
-        ).toEqual(
+        expect(await this.copyOfKeyValueService!.getKey("name")).toEqual(
           "defaultService1+modifierCommand",
         );
 
@@ -188,22 +161,13 @@ describe("BaseCLI tests", () => {
 
       async serviceMethod(context: Context): Promise<void> {
         expect(await this.copyOfKeyValueService!.hasKey("name")).toBeTrue();
-        expect(await this.copyOfKeyValueService!.getKey("name")).toEqual(
-          "subCommand",
-        );
-        await this.copyOfKeyValueService!.setKey(
-          "name",
-          "defaultService2+subCommand",
-        );
+        expect(await this.copyOfKeyValueService!.getKey("name")).toEqual("subCommand");
+        await this.copyOfKeyValueService!.setKey("name", "defaultService2+subCommand");
 
-        const keyValueService = context.getServiceById(
-          KEY_VALUE_SERVICE_ID,
-        ) as KeyValueService;
+        const keyValueService = context.getServiceById(KEY_VALUE_SERVICE_ID) as KeyValueService;
 
         expect(await keyValueService.hasKey("name")).toBeTrue();
-        expect(
-          await this.copyOfKeyValueService!.getKey("name"),
-        ).toEqual(
+        expect(await this.copyOfKeyValueService!.getKey("name")).toEqual(
           "defaultService2+subCommand",
         );
 
@@ -226,9 +190,7 @@ describe("BaseCLI tests", () => {
       }
 
       async initService(context: Context): Promise<void> {
-        const keyValueService = context.getServiceById(
-          KEY_VALUE_SERVICE_ID,
-        ) as KeyValueService;
+        const keyValueService = context.getServiceById(KEY_VALUE_SERVICE_ID) as KeyValueService;
 
         expect(await keyValueService.hasKey("name")).toBeFalse();
         await keyValueService.setKey("name", "defaultService2");
@@ -254,9 +216,7 @@ describe("BaseCLI tests", () => {
       }
 
       async initService(context: Context): Promise<void> {
-        const keyValueService = context.getServiceById(
-          KEY_VALUE_SERVICE_ID,
-        ) as KeyValueService;
+        const keyValueService = context.getServiceById(KEY_VALUE_SERVICE_ID) as KeyValueService;
 
         expect(await keyValueService.hasKey("name")).toBeFalse();
         await keyValueService.setKey("name", "defaultService2");
@@ -267,14 +227,9 @@ describe("BaseCLI tests", () => {
       }
     }
 
-    const modifierCommand = getGlobalModifierCommandWithArgument(
-      "modifier",
-      "m",
-      1,
-      {
-        type: ArgumentValueTypeName.STRING,
-      },
-    );
+    const modifierCommand = getGlobalModifierCommandWithArgument("modifier", "m", 1, {
+      type: ArgumentValueTypeName.STRING,
+    });
     const option = {
       name: "foo",
       type: ArgumentValueTypeName.STRING,
@@ -283,9 +238,7 @@ describe("BaseCLI tests", () => {
     const subCommand = getSubCommand("command", [option], []);
 
     modifierCommand.execute = async (context): Promise<void> => {
-      const keyValueService = context.getServiceById(
-        KEY_VALUE_SERVICE_ID,
-      ) as KeyValueService;
+      const keyValueService = context.getServiceById(KEY_VALUE_SERVICE_ID) as KeyValueService;
 
       expect(await keyValueService.hasKey("name")).toBeFalse();
       await keyValueService.setKey("name", "modifierCommand");
@@ -297,9 +250,7 @@ describe("BaseCLI tests", () => {
       modifierHasRun = true;
     };
     subCommand.execute = async (context): Promise<void> => {
-      const keyValueService = context.getServiceById(
-        KEY_VALUE_SERVICE_ID,
-      ) as KeyValueService;
+      const keyValueService = context.getServiceById(KEY_VALUE_SERVICE_ID) as KeyValueService;
 
       expect(await keyValueService.hasKey("name")).toBeFalse();
       await keyValueService.setKey("name", "subCommand");
@@ -316,13 +267,7 @@ describe("BaseCLI tests", () => {
     baseCLI.addCommand(modifierCommand);
     baseCLI.addCommand(subCommand);
 
-    const runResult = await baseCLI.run([
-      "unused",
-      "--modifier=bar",
-      "command",
-      "--foo",
-      "bar",
-    ]);
+    const runResult = await baseCLI.run(["unused", "--modifier=bar", "command", "--foo", "bar"]);
 
     expect(runResult.runState).toEqual(RunState.SUCCESS);
     expect(serviceProvider1Initialised).toBeTrue();
@@ -333,8 +278,6 @@ describe("BaseCLI tests", () => {
     expect(service2MethodInvoked).toBeTrue();
 
     // cleanup
-    await fs.rm(
-      path.join(process.env.HOME!, `.${appName.replace(/\W/g, "")}.json`),
-    );
+    await fs.rm(path.join(process.env.HOME!, `.${appName.replace(/\W/g, "")}.json`));
   });
 });

package/tests/command/CompletionCommand.test.ts

@@ -15,12 +15,7 @@ describe("CompletionIntegrationSubCommand", () => {
     const cmd = new CompletionIntegrationSubCommand();
     expect(cmd.positionals.length).toEqual(1);
     expect(cmd.positionals[0]!.name).toEqual("shell");
-    expect(cmd.positionals[0]!.allowableValues).toEqual([
-      "bash",
-      "zsh",
-      "fish",
-      "powershell",
-    ]);
+    expect(cmd.positionals[0]!.allowableValues).toEqual(["bash", "zsh", "fish", "powershell"]);
   });
 
   test("has optional config-path option", () => {