@flowscripter/dynamic-cli-framework 1.2.2 → 1.3.1

package/tests/command/SingleCommandCliHelpCommand.test.ts

@@ -7,10 +7,7 @@ import {
   getSubCommandWithPositional,
 } from "../fixtures/Command.ts";
 import { getContext } from "../fixtures/Context.ts";
-import {
-  expectStringIncludes,
-  expectStringNotIncludes,
-} from "../fixtures/util.ts";
+import { expectStringIncludes, expectStringNotIncludes } from "../fixtures/util.ts";
 import { ArgumentValueTypeName } from "../../src/api/argument/ArgumentValueTypes.ts";
 import { SingleCommandCliHelpGlobalCommand } from "../../src/command/SingleCommandCliHelpCommand.ts";
 import type SubCommand from "../../src/api/command/SubCommand.ts";
@@ -36,13 +33,7 @@ describe("SingleCommandCliHelpCommand tests", () => {
     const commandRegistry = getCommandRegistry([
       getGlobalCommand("global1", true, true),
       getGlobalCommand("global2", true),
-      getSubCommandWithOption(
-        "command_a",
-        true,
-        true,
-        true,
-        ArgumentValueTypeName.BOOLEAN,
-      ),
+      getSubCommandWithOption("command_a", true, true, true, ArgumentValueTypeName.BOOLEAN),
       getSubCommandWithOption("command_b", true),
       {
         name: "topic",
@@ -107,10 +98,7 @@ describe("SingleCommandCliHelpCommand tests", () => {
     );
 
     await help.execute(context);
-    expectStringIncludes(
-      streamString.getString(),
-      "foo --foo <string_value>...",
-    );
+    expectStringIncludes(streamString.getString(), "foo --foo <string_value>...");
   });
 
   test("Ensure single command CLI usage syntax is rendered correctly: simple default command with non-multiple arg", async () => {
@@ -124,10 +112,7 @@ describe("SingleCommandCliHelpCommand tests", () => {
     );
 
     await help.execute(context);
-    expectStringIncludes(
-      streamString.getString(),
-      "foo --foo <string_value>",
-    );
+    expectStringIncludes(streamString.getString(), "foo --foo <string_value>");
   });
 
   test("Ensure single command CLI usage syntax is rendered correctly: simple default command with optional arg", async () => {
@@ -141,10 +126,7 @@ describe("SingleCommandCliHelpCommand tests", () => {
     );
 
     await help.execute(context);
-    expectStringIncludes(
-      streamString.getString(),
-      "foo [--foo <string_value>]",
-    );
+    expectStringIncludes(streamString.getString(), "foo [--foo <string_value>]");
   });
 
   test("Ensure single command CLI usage syntax is rendered correctly: with mandatory arg global modifier", async () => {
@@ -160,18 +142,13 @@ describe("SingleCommandCliHelpCommand tests", () => {
     );
 
     await help.execute(context);
-    expectStringIncludes(
-      streamString.getString(),
-      "foo --foo <string_value>...",
-    );
+    expectStringIncludes(streamString.getString(), "foo --foo <string_value>...");
   });
 
   test("Ensure single command CLI usage syntax is rendered correctly: with global modifier with no arg", async () => {
     const streamString = new StreamString();
     const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry([
-      getGlobalModifierCommand("modifier1"),
-    ]);
+    const commandRegistry = getCommandRegistry([getGlobalModifierCommand("modifier1")]);
     const help = new SingleCommandCliHelpGlobalCommand(
       true,
       getSubCommandWithOption("command_a", true, true, true),
@@ -179,18 +156,13 @@ describe("SingleCommandCliHelpCommand tests", () => {
     );
 
     await help.execute(context);
-    expectStringIncludes(
-      streamString.getString(),
-      "foo --foo <string_value>...",
-    );
+    expectStringIncludes(streamString.getString(), "foo --foo <string_value>...");
   });
 
   test("Ensure single command CLI usage syntax is rendered correctly: with singular optional arg and global modifier", async () => {
     const streamString = new StreamString();
     const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry([
-      getGlobalModifierCommand("modifier1"),
-    ]);
+    const commandRegistry = getCommandRegistry([getGlobalModifierCommand("modifier1")]);
     const help = new SingleCommandCliHelpGlobalCommand(
       true,
       getSubCommandWithOption("command_a", true),
@@ -198,10 +170,7 @@ describe("SingleCommandCliHelpCommand tests", () => {
     );
 
     await help.execute(context);
-    expectStringIncludes(
-      streamString.getString(),
-      "foo [--foo <string_value>]",
-    );
+    expectStringIncludes(streamString.getString(), "foo [--foo <string_value>]");
   });
 
   test("Ensure single command CLI usage syntax is rendered correctly: with multiple optional arg and multiple global modifiers and multiple global commands", async () => {
@@ -220,10 +189,7 @@ describe("SingleCommandCliHelpCommand tests", () => {
     );
 
     await help.execute(context);
-    expectStringIncludes(
-      streamString.getString(),
-      "foo [--foo <string_value>]...",
-    );
+    expectStringIncludes(streamString.getString(), "foo [--foo <string_value>]...");
   });
 
   test("Ensure single command CLI usage syntax is rendered correctly: with optional arg, multiple global modifiers, multiple global commands, multiple sub-commands", async () => {
@@ -243,10 +209,7 @@ describe("SingleCommandCliHelpCommand tests", () => {
     );
 
     await help.execute(context);
-    expectStringIncludes(
-      streamString.getString(),
-      "foo [--foo <string_value>]...",
-    );
+    expectStringIncludes(streamString.getString(), "foo [--foo <string_value>]...");
   });
 
   test("Ensure single command CLI usage syntax is rendered correctly: also with boolean args", async () => {
@@ -257,31 +220,16 @@ describe("SingleCommandCliHelpCommand tests", () => {
       getGlobalModifierCommand("modifier2", "m", true, true),
       getGlobalCommand("global1", true, true),
       getGlobalCommand("global2", true, true),
-      getSubCommandWithOption(
-        "sub1",
-        true,
-        true,
-        false,
-        ArgumentValueTypeName.BOOLEAN,
-      ),
+      getSubCommandWithOption("sub1", true, true, false, ArgumentValueTypeName.BOOLEAN),
     ]);
     const help = new SingleCommandCliHelpGlobalCommand(
       true,
-      getSubCommandWithOption(
-        "command_a",
-        true,
-        false,
-        true,
-        ArgumentValueTypeName.BOOLEAN,
-      ),
+      getSubCommandWithOption("command_a", true, false, true, ArgumentValueTypeName.BOOLEAN),
       commandRegistry,
     );
 
     await help.execute(context);
-    expectStringIncludes(
-      streamString.getString(),
-      "foo [--foo [true|false]]...",
-    );
+    expectStringIncludes(streamString.getString(), "foo [--foo [true|false]]...");
   });
 
   test("Ensure single command CLI usage syntax is rendered correctly: also with default value", async () => {
@@ -290,22 +238,12 @@ describe("SingleCommandCliHelpCommand tests", () => {
     const commandRegistry = getCommandRegistry();
     const help = new SingleCommandCliHelpGlobalCommand(
       true,
-      getSubCommandWithOption(
-        "command_a",
-        true,
-        false,
-        true,
-        ArgumentValueTypeName.STRING,
-        "foo",
-      ),
+      getSubCommandWithOption("command_a", true, false, true, ArgumentValueTypeName.STRING, "foo"),
       commandRegistry,
     );
 
     await help.execute(context);
-    expectStringIncludes(
-      streamString.getString(),
-      "foo [--foo <string_value>]...",
-    );
+    expectStringIncludes(streamString.getString(), "foo [--foo <string_value>]...");
   });
 
   test("Ensure single command CLI usage syntax is rendered correctly: with positionals", async () => {
@@ -331,12 +269,7 @@ describe("SingleCommandCliHelpCommand tests", () => {
 
     help = new SingleCommandCliHelpGlobalCommand(
       true,
-      getSubCommandWithPositional(
-        "command_a",
-        true,
-        true,
-        ArgumentValueTypeName.BOOLEAN,
-      ),
+      getSubCommandWithPositional("command_a", true, true, ArgumentValueTypeName.BOOLEAN),
       commandRegistry,
     );
     await help.execute(context);
@@ -344,12 +277,7 @@ describe("SingleCommandCliHelpCommand tests", () => {
 
     help = new SingleCommandCliHelpGlobalCommand(
       true,
-      getSubCommandWithPositional(
-        "command_a",
-        true,
-        true,
-        ArgumentValueTypeName.STRING,
-      ),
+      getSubCommandWithPositional("command_a", true, true, ArgumentValueTypeName.STRING),
       commandRegistry,
     );
     await help.execute(context);
@@ -357,12 +285,7 @@ describe("SingleCommandCliHelpCommand tests", () => {
 
     help = new SingleCommandCliHelpGlobalCommand(
       true,
-      getSubCommandWithPositional(
-        "command_a",
-        false,
-        false,
-        ArgumentValueTypeName.STRING,
-      ),
+      getSubCommandWithPositional("command_a", false, false, ArgumentValueTypeName.STRING),
       commandRegistry,
     );
     await help.execute(context);
@@ -370,12 +293,7 @@ describe("SingleCommandCliHelpCommand tests", () => {
 
     help = new SingleCommandCliHelpGlobalCommand(
       true,
-      getSubCommandWithPositional(
-        "command_a",
-        false,
-        true,
-        ArgumentValueTypeName.BOOLEAN,
-      ),
+      getSubCommandWithPositional("command_a", false, true, ArgumentValueTypeName.BOOLEAN),
       commandRegistry,
     );
     await help.execute(context);

package/tests/command/UsageCommand.test.ts

@@ -32,23 +32,17 @@ describe("UsageCommand tests", () => {
     context.addServiceInstance(PRINTER_SERVICE_ID, printer);
 
     const usageCommand = new UsageCommand(
-      new class implements Command {
+      new (class implements Command {
         readonly name = "help";
 
-        execute(
-          _argumentValues: ArgumentValues,
-          _context: Context,
-        ): Promise<void> {
+        execute(_argumentValues: ArgumentValues, _context: Context): Promise<void> {
           return Promise.resolve(undefined);
         }
-      }(),
+      })(),
     );
 
     await usageCommand.execute(context);
 
-    expectStringEquals(
-      dummyStdout.getString(),
-      "Try running:\n\n  foo --help\n\n",
-    );
+    expectStringEquals(dummyStdout.getString(), "Try running:\n\n  foo --help\n\n");
   });
 });

package/tests/fixtures/Command.ts

@@ -34,9 +34,9 @@ export function getGlobalModifierCommand(
     executePriority: 1,
     argument: withArg
       ? {
-        type: ArgumentValueTypeName.STRING,
-        isOptional: !mandatoryArg,
-      }
+          type: ArgumentValueTypeName.STRING,
+          isOptional: !mandatoryArg,
+        }
       : undefined,
     execute: async (): Promise<void> => {},
   };
@@ -71,10 +71,10 @@ export function getGlobalCommand(
     enableConfiguration,
     argument: withArg
       ? {
-        type: ArgumentValueTypeName.STRING,
-        isOptional: !mandatoryArg,
-        configurationKey,
-      }
+          type: ArgumentValueTypeName.STRING,
+          isOptional: !mandatoryArg,
+          configurationKey,
+        }
       : undefined,
     execute: async (): Promise<void> => {},
   };
@@ -96,15 +96,19 @@ export function getGlobalCommandWithShortAlias(
 export function getSubCommandWithOptionAndPositional(): SubCommand {
   return {
     name: "subCommand",
-    options: [{
-      name: "goo",
-      shortAlias: "g",
-      type: ArgumentValueTypeName.STRING,
-    }],
-    positionals: [{
-      name: "foo",
-      type: ArgumentValueTypeName.STRING,
-    }],
+    options: [
+      {
+        name: "goo",
+        shortAlias: "g",
+        type: ArgumentValueTypeName.STRING,
+      },
+    ],
+    positionals: [
+      {
+        name: "foo",
+        type: ArgumentValueTypeName.STRING,
+      },
+    ],
     execute: async (): Promise<void> => {},
   };
 }
@@ -139,14 +143,16 @@ export function getSubCommandWithOption(
     description: "good",
     enableConfiguration,
     options: withArg
-      ? [{
-        name: "foo",
-        type,
-        isOptional: !mandatoryArg,
-        isArray: multiple,
-        defaultValue,
-        configurationKey,
-      }]
+      ? [
+          {
+            name: "foo",
+            type,
+            isOptional: !mandatoryArg,
+            isArray: multiple,
+            defaultValue,
+            configurationKey,
+          },
+        ]
       : [],
     positionals: [],
     execute: async (): Promise<void> => {},
@@ -166,13 +172,15 @@ export function getSubCommandWithPositional(
     description: "good",
     enableConfiguration,
     options: [],
-    positionals: [{
-      name: "foo",
-      type,
-      isVarargOptional: optional,
-      isVarargMultiple: multiple,
-      configurationKey,
-    }],
+    positionals: [
+      {
+        name: "foo",
+        type,
+        isVarargOptional: optional,
+        isVarargMultiple: multiple,
+        configurationKey,
+      },
+    ],
     execute: async (): Promise<void> => {},
   };
 }
@@ -185,44 +193,55 @@ export function getSubCommandWithComplexOptions(
   return {
     name: "subCommand",
     enableConfiguration,
-    options: [{
-      name: "alpha",
-      shortAlias: "a",
-      type: ComplexValueTypeName.COMPLEX,
-      isArray: true,
-      properties: [{
-        name: "beta",
-        shortAlias: "b",
+    options: [
+      {
+        name: "alpha",
+        shortAlias: "a",
         type: ComplexValueTypeName.COMPLEX,
-        isArray: betaIsArray,
-        properties: [{
-          name: "gamma",
-          shortAlias: "g",
-          type: ArgumentValueTypeName.STRING,
-        }, {
-          name: "delta",
-          shortAlias: "d",
-          type: ArgumentValueTypeName.NUMBER,
-          isArray: true,
-        }],
-      }],
-    }, {
-      name: "epsilon",
-      shortAlias: "e",
-      type: ComplexValueTypeName.COMPLEX,
-      properties: [{
-        name: "gamma",
-        shortAlias: "g",
-        type: ArgumentValueTypeName.STRING,
-        configurationKey: "FOO_BAR_A",
-      }, {
-        name: "delta",
-        shortAlias: "d",
-        type: ArgumentValueTypeName.NUMBER,
-        configurationKey: "FOO_BAR_B",
-        isArray: deltaIsArray,
-      }],
-    }],
+        isArray: true,
+        properties: [
+          {
+            name: "beta",
+            shortAlias: "b",
+            type: ComplexValueTypeName.COMPLEX,
+            isArray: betaIsArray,
+            properties: [
+              {
+                name: "gamma",
+                shortAlias: "g",
+                type: ArgumentValueTypeName.STRING,
+              },
+              {
+                name: "delta",
+                shortAlias: "d",
+                type: ArgumentValueTypeName.NUMBER,
+                isArray: true,
+              },
+            ],
+          },
+        ],
+      },
+      {
+        name: "epsilon",
+        shortAlias: "e",
+        type: ComplexValueTypeName.COMPLEX,
+        properties: [
+          {
+            name: "gamma",
+            shortAlias: "g",
+            type: ArgumentValueTypeName.STRING,
+            configurationKey: "FOO_BAR_A",
+          },
+          {
+            name: "delta",
+            shortAlias: "d",
+            type: ArgumentValueTypeName.NUMBER,
+            configurationKey: "FOO_BAR_B",
+            isArray: deltaIsArray,
+          },
+        ],
+      },
+    ],
     positionals: [],
     execute: async (): Promise<void> => {},
   };

package/tests/fixtures/CommandRegistry.ts

@@ -1,8 +1,6 @@
 import DefaultCommandRegistry from "../../src/runtime/registry/DefaultCommandRegistry.ts";
 import type Command from "../../src/api/command/Command.ts";
 
-export function getCommandRegistry(
-  commands?: Array<Command>,
-): DefaultCommandRegistry {
+export function getCommandRegistry(commands?: Array<Command>): DefaultCommandRegistry {
   return new DefaultCommandRegistry(commands);
 }

package/tests/fixtures/Context.ts

@@ -11,9 +11,7 @@ import TtyStyler from "../../src/terminal/TtyStyler.ts";
 import { TABLE_GENERATOR_SERVICE_ID } from "../../src/api/service/core/TableGeneratorService.ts";
 import DefaultTableGeneratorService from "../../src/service/tableGenerator/DefaultTableGeneratorService.ts";
 
-export function getContext(
-  streamString: WritableStreamString,
-): Context {
+export function getContext(streamString: WritableStreamString): Context {
   const defaultContext = new DefaultContext(getCLIConfig());
   const defaultPrinterService = new DefaultPrinterService(
     streamString.writableStream,
@@ -27,14 +25,8 @@ export function getContext(
 
   defaultPrinterService.colorEnabled = false;
   defaultContext.addServiceInstance(PRINTER_SERVICE_ID, defaultPrinterService);
-  defaultContext.addServiceInstance(
-    KEY_VALUE_SERVICE_ID,
-    new DefaultKeyValueService(),
-  );
-  defaultContext.addServiceInstance(
-    TABLE_GENERATOR_SERVICE_ID,
-    new DefaultTableGeneratorService(),
-  );
+  defaultContext.addServiceInstance(KEY_VALUE_SERVICE_ID, new DefaultKeyValueService());
+  defaultContext.addServiceInstance(TABLE_GENERATOR_SERVICE_ID, new DefaultTableGeneratorService());
 
   return defaultContext;
 }

package/tests/fixtures/ServiceProviderRegistry.ts

@@ -9,7 +9,7 @@ export function getServiceProviderRegistry(
 
   if (serviceProviders) {
     serviceProviders.forEach((serviceProvider) =>
-      serviceProviderRegistry.addServiceProvider(serviceProvider)
+      serviceProviderRegistry.addServiceProvider(serviceProvider),
     );
   }
   return serviceProviderRegistry;

package/tests/fixtures/prettierPluginFoo.ts

@@ -17,7 +17,7 @@ const parsers: Record<string, Parser> = {
 };
 
 const printers: Record<string, Printer> = {
-  "foo": {
+  foo: {
     print: () => "foo",
   },
 };

package/tests/fixtures/util.ts

@@ -8,10 +8,7 @@ export function expectStringIncludes(actual: string, expected: string) {
   expect(stripVTControlCharacters(actual).includes(expected)).toBeTrue();
 }
 
-export function expectStringNotIncludes(
-  actual: string,
-  expected: string,
-) {
+export function expectStringNotIncludes(actual: string, expected: string) {
   expect(stripVTControlCharacters(actual).includes(expected)).toBeFalse();
 }
 
@@ -27,10 +24,7 @@ export function sleep(ms: number) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
-export async function write(
-  writableStream: WritableStream,
-  message: string,
-) {
+export async function write(writableStream: WritableStream, message: string) {
   const encoded = encoder.encode(message);
   const writer = writableStream.getWriter();
 

package/tests/runtime/argument/ArgumentTypeGuards.test.ts

@@ -13,9 +13,7 @@ function getComplexOption(): ComplexOption {
   return {
     name: "option",
     type: ComplexValueTypeName.COMPLEX,
-    properties: [
-      getOption(),
-    ],
+    properties: [getOption()],
   };
 }