@flowscripter/dynamic-cli-framework 1.4.19 → 1.5.0

package/tests/command/SingleCommandCliHelpCommand.test.ts

@@ -1,302 +0,0 @@
-import { describe, test } from "bun:test";
-import { getCommandRegistry } from "../fixtures/CommandRegistry.ts";
-import {
-  getGlobalCommand,
-  getGlobalModifierCommand,
-  getSubCommandWithOption,
-  getSubCommandWithPositional,
-} from "../fixtures/Command.ts";
-import { getContext } from "../fixtures/Context.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";
-import StreamString from "../fixtures/StreamString.ts";
-
-describe("SingleCommandCliHelpCommand tests", () => {
-  test("Ensure single command CLI with simple default command help is rendered correctly: simple default command", async () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, true, true),
-      getCommandRegistry(),
-    );
-
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "--foo");
-  });
-
-  test("Ensure single command CLI aggregates all non-default command arguments", async () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry([
-      getGlobalCommand("global1", true, true),
-      getGlobalCommand("global2", true),
-      getSubCommandWithOption("command_a", true, true, true, ArgumentValueTypeName.BOOLEAN),
-      getSubCommandWithOption("command_b", true),
-      {
-        name: "topic",
-        helpTopic: "topic",
-        options: [],
-        positionals: [],
-        execute: async (): Promise<void> => {},
-      } as SubCommand,
-    ]);
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, true, true),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    expectStringNotIncludes(streamString.getString(), "Global");
-    expectStringNotIncludes(streamString.getString(), "Topic");
-    expectStringIncludes(streamString.getString(), "Command Arguments");
-    expectStringIncludes(streamString.getString(), "Other Arguments");
-  });
-
-  test("Ensure single command CLI with default and globals help is rendered correctly: default and global modifier", async () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry([
-      getGlobalModifierCommand("modifier1", "m", true, true),
-    ]);
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, true, true),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "Other Arguments");
-  });
-
-  test("Ensure single command CLI with default and globals help is rendered correctly: default, global modifier and global", async () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry([
-      getGlobalModifierCommand("modifier1"),
-      getGlobalCommand("global1"),
-    ]);
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, true, true),
-      commandRegistry,
-    );
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "Other Arguments");
-  });
-
-  test("Ensure single command CLI usage syntax is rendered correctly: simple default command", async () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, true, true),
-      getCommandRegistry(),
-    );
-
-    await help.execute(context);
-    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 () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry();
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, true),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "foo --foo <string_value>");
-  });
-
-  test("Ensure single command CLI usage syntax is rendered correctly: simple default command with optional arg", async () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry();
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "foo [--foo <string_value>]");
-  });
-
-  test("Ensure single command CLI usage syntax is rendered correctly: with mandatory arg global modifier", async () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry([
-      getGlobalModifierCommand("modifier1", "m", true, true),
-    ]);
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, true, true),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    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 help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, true, true),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    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 help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    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 () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry([
-      getGlobalModifierCommand("modifier1"),
-      getGlobalModifierCommand("modifier2", "m", true, true),
-      getGlobalCommand("global1", true, true),
-      getGlobalCommand("global2", true, true),
-    ]);
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, false, true),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    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 () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry([
-      getGlobalModifierCommand("modifier1"),
-      getGlobalModifierCommand("modifier2", "m", true, true),
-      getGlobalCommand("global1", true, true),
-      getGlobalCommand("global2", true, true),
-      getSubCommandWithOption("sub1", true, true),
-    ]);
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, false, true),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "foo [--foo <string_value>]...");
-  });
-
-  test("Ensure single command CLI usage syntax is rendered correctly: also with boolean args", async () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry([
-      getGlobalModifierCommand("modifier1"),
-      getGlobalModifierCommand("modifier2", "m", true, true),
-      getGlobalCommand("global1", true, true),
-      getGlobalCommand("global2", true, true),
-      getSubCommandWithOption("sub1", true, true, false, ArgumentValueTypeName.BOOLEAN),
-    ]);
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, false, true, ArgumentValueTypeName.BOOLEAN),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "foo [--foo [true|false]]...");
-  });
-
-  test("Ensure single command CLI usage syntax is rendered correctly: also with default value", async () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry();
-    const help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithOption("command_a", true, false, true, ArgumentValueTypeName.STRING, "foo"),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "foo [--foo <string_value>]...");
-  });
-
-  test("Ensure single command CLI usage syntax is rendered correctly: with positionals", async () => {
-    const streamString = new StreamString();
-    const context = getContext(streamString);
-    const commandRegistry = getCommandRegistry();
-    let help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithPositional("command_a"),
-      commandRegistry,
-    );
-
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "foo <foo>");
-
-    help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithPositional("command_a", true, true),
-      commandRegistry,
-    );
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "foo [<foo>]...");
-
-    help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithPositional("command_a", true, true, ArgumentValueTypeName.BOOLEAN),
-      commandRegistry,
-    );
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "foo [<foo>]...");
-
-    help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithPositional("command_a", true, true, ArgumentValueTypeName.STRING),
-      commandRegistry,
-    );
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "foo [<foo>]...");
-
-    help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithPositional("command_a", false, false, ArgumentValueTypeName.STRING),
-      commandRegistry,
-    );
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "foo <foo>");
-
-    help = new SingleCommandCliHelpGlobalCommand(
-      true,
-      getSubCommandWithPositional("command_a", false, true, ArgumentValueTypeName.BOOLEAN),
-      commandRegistry,
-    );
-    await help.execute(context);
-    expectStringIncludes(streamString.getString(), "foo <foo>...");
-  });
-});

package/tests/command/UsageCommand.test.ts

@@ -1,48 +0,0 @@
-import { describe, test } from "bun:test";
-import DefaultContext from "../../src/runtime/DefaultContext.ts";
-import UsageCommand from "../../src/command/UsageCommand.ts";
-import { getCLIConfig } from "../fixtures/CLIConfig.ts";
-import { PRINTER_SERVICE_ID } from "../../src/api/service/core/PrinterService.ts";
-import DefaultPrinterService from "../../src/service/printer/DefaultPrinterService.ts";
-import type { ArgumentValues } from "../../src/api/argument/ArgumentValueTypes.ts";
-import type Context from "../../src/api/Context.ts";
-import type Command from "../../src/api/command/Command.ts";
-import StreamString from "../fixtures/StreamString.ts";
-import { expectStringEquals } from "../fixtures/util.ts";
-import TtyTerminal from "../../src/terminal/TtyTerminal.ts";
-import TtyStyler from "../../src/terminal/TtyStyler.ts";
-
-describe("UsageCommand tests", () => {
-  test("Usage works", async () => {
-    const dummyStdout = new StreamString();
-    const dummyStderr = new StreamString();
-    const printer = new DefaultPrinterService(
-      dummyStdout.writableStream,
-      dummyStderr.writableStream,
-      true,
-      true,
-      new TtyTerminal(dummyStdout.writeStream),
-      new TtyTerminal(dummyStderr.writeStream),
-      new TtyStyler(3),
-    );
-    printer.colorEnabled = false;
-
-    const context = new DefaultContext(getCLIConfig());
-
-    context.addServiceInstance(PRINTER_SERVICE_ID, printer);
-
-    const usageCommand = new UsageCommand(
-      new (class implements Command {
-        readonly name = "help";
-
-        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");
-  });
-});

package/tests/command/VersionCommand.test.ts

@@ -1,37 +0,0 @@
-import { describe, test } from "bun:test";
-import DefaultContext from "../../src/runtime/DefaultContext.ts";
-import VersionCommand from "../../src/command/VersionCommand.ts";
-import { getCLIConfig } from "../fixtures/CLIConfig.ts";
-import { PRINTER_SERVICE_ID } from "../../src/api/service/core/PrinterService.ts";
-import DefaultPrinterService from "../../src/service/printer/DefaultPrinterService.ts";
-import StreamString from "../fixtures/StreamString.ts";
-import { expectStringEquals } from "../fixtures/util.ts";
-import TtyTerminal from "../../src/terminal/TtyTerminal.ts";
-import TtyStyler from "../../src/terminal/TtyStyler.ts";
-
-describe("VersionCommand tests", () => {
-  test("Version works", async () => {
-    const dummyStdout = new StreamString();
-    const dummyStderr = new StreamString();
-    const printer = new DefaultPrinterService(
-      dummyStdout.writableStream,
-      dummyStderr.writableStream,
-      true,
-      true,
-      new TtyTerminal(dummyStdout.writeStream),
-      new TtyTerminal(dummyStderr.writeStream),
-      new TtyStyler(3),
-    );
-    printer.colorEnabled = false;
-
-    const context = new DefaultContext(getCLIConfig());
-
-    context.addServiceInstance(PRINTER_SERVICE_ID, printer);
-
-    const versionCommand = new VersionCommand();
-
-    await versionCommand.execute(context);
-
-    expectStringEquals(dummyStdout.getString(), "foobar\n");
-  });
-});

package/tests/fixtures/CLIConfig.ts

@@ -1,9 +0,0 @@
-import type CLIConfig from "../../src/api/CLIConfig.ts";
-
-export function getCLIConfig(name = "foo"): CLIConfig {
-  return {
-    name,
-    description: "bar",
-    version: "foobar",
-  };
-}

package/tests/fixtures/Command.ts

@@ -1,248 +0,0 @@
-import type GroupCommand from "../../src/api/command/GroupCommand.ts";
-import type GlobalCommand from "../../src/api/command/GlobalCommand.ts";
-import type SubCommand from "../../src/api/command/SubCommand.ts";
-import {
-  ArgumentValueTypeName,
-  ComplexValueTypeName,
-} from "../../src/api/argument/ArgumentValueTypes.ts";
-import type ComplexOption from "../../src/api/argument/ComplexOption.ts";
-import type Positional from "../../src/api/argument/Positional.ts";
-import type GlobalCommandArgument from "../../src/api/argument/GlobalCommandArgument.ts";
-import type GlobalModifierCommand from "../../src/api/command/GlobalModifierCommand.ts";
-import type Option from "../../src/api/argument/Option.ts";
-
-export function getGroupCommand(
-  name = "groupCommand",
-  memberSubCommands = [getSubCommandWithOption("foo")],
-): GroupCommand {
-  return {
-    name,
-    memberSubCommands,
-    execute: async (): Promise<void> => {},
-  };
-}
-
-export function getGlobalModifierCommand(
-  name = "globalModifierCommand",
-  shortAlias: string | undefined = undefined,
-  withArg = false,
-  mandatoryArg = false,
-): GlobalModifierCommand {
-  return {
-    name,
-    shortAlias,
-    executePriority: 1,
-    argument: withArg
-      ? {
-          type: ArgumentValueTypeName.STRING,
-          isOptional: !mandatoryArg,
-        }
-      : undefined,
-    execute: async (): Promise<void> => {},
-  };
-}
-
-export function getGlobalModifierCommandWithArgument(
-  name: string,
-  shortAlias: string,
-  executePriority = 1,
-  argument?: GlobalCommandArgument,
-  enableConfiguration = false,
-): GlobalModifierCommand {
-  return {
-    name,
-    enableConfiguration,
-    shortAlias,
-    executePriority,
-    argument,
-    execute: async (): Promise<void> => {},
-  };
-}
-
-export function getGlobalCommand(
-  name = "globalCommand",
-  withArg = false,
-  mandatoryArg = false,
-  enableConfiguration = false,
-  configurationKey?: string,
-): GlobalCommand {
-  return {
-    name,
-    enableConfiguration,
-    argument: withArg
-      ? {
-          type: ArgumentValueTypeName.STRING,
-          isOptional: !mandatoryArg,
-          configurationKey,
-        }
-      : undefined,
-    execute: async (): Promise<void> => {},
-  };
-}
-
-export function getGlobalCommandWithShortAlias(
-  name: string,
-  shortAlias: string,
-  argument?: GlobalCommandArgument,
-): GlobalCommand {
-  return {
-    name,
-    shortAlias,
-    argument,
-    execute: async (): Promise<void> => {},
-  };
-}
-
-export function getSubCommandWithOptionAndPositional(): SubCommand {
-  return {
-    name: "subCommand",
-    options: [
-      {
-        name: "goo",
-        shortAlias: "g",
-        type: ArgumentValueTypeName.STRING,
-      },
-    ],
-    positionals: [
-      {
-        name: "foo",
-        type: ArgumentValueTypeName.STRING,
-      },
-    ],
-    execute: async (): Promise<void> => {},
-  };
-}
-
-export function getSubCommand(
-  name: string,
-  options: Array<Option | ComplexOption>,
-  positionals: Array<Positional> = [],
-  enableConfiguration = false,
-): SubCommand {
-  return {
-    name,
-    options,
-    positionals,
-    enableConfiguration,
-    execute: async (): Promise<void> => {},
-  };
-}
-
-export function getSubCommandWithOption(
-  name = "subCommand",
-  withArg = false,
-  mandatoryArg = false,
-  multiple = false,
-  type: ArgumentValueTypeName = ArgumentValueTypeName.STRING,
-  defaultValue?: string,
-  enableConfiguration = false,
-  configurationKey?: string,
-): SubCommand {
-  return {
-    name,
-    description: "good",
-    enableConfiguration,
-    options: withArg
-      ? [
-          {
-            name: "foo",
-            type,
-            isOptional: !mandatoryArg,
-            isArray: multiple,
-            defaultValue,
-            configurationKey,
-          },
-        ]
-      : [],
-    positionals: [],
-    execute: async (): Promise<void> => {},
-  };
-}
-
-export function getSubCommandWithPositional(
-  name: string,
-  optional = false,
-  multiple = false,
-  type: ArgumentValueTypeName = ArgumentValueTypeName.STRING,
-  enableConfiguration = false,
-  configurationKey?: string,
-): SubCommand {
-  return {
-    name,
-    description: "good",
-    enableConfiguration,
-    options: [],
-    positionals: [
-      {
-        name: "foo",
-        type,
-        isVarargOptional: optional,
-        isVarargMultiple: multiple,
-        configurationKey,
-      },
-    ],
-    execute: async (): Promise<void> => {},
-  };
-}
-
-export function getSubCommandWithComplexOptions(
-  enableConfiguration = false,
-  betaIsArray = false,
-  deltaIsArray = false,
-): SubCommand {
-  return {
-    name: "subCommand",
-    enableConfiguration,
-    options: [
-      {
-        name: "alpha",
-        shortAlias: "a",
-        type: ComplexValueTypeName.COMPLEX,
-        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/ConfigurationServiceProvider.ts

@@ -1,28 +0,0 @@
-import ConfigurationServiceProvider from "../../src/service/configuration/ConfigurationServiceProvider.ts";
-import type {
-  ArgumentSingleValueType,
-  ArgumentValues,
-} from "../../src/api/argument/ArgumentValueTypes.ts";
-import type Context from "../../src/api/Context.ts";
-
-class DummyConfigurationServiceProvider extends ConfigurationServiceProvider {
-  constructor(
-    servicePriority: number,
-    defaultsData: Map<string, ArgumentValues | ArgumentSingleValueType>,
-  ) {
-    super(servicePriority, false, true);
-
-    this.defaultsData = defaultsData;
-  }
-
-  public override initService(_context: Context): Promise<void> {
-    return Promise.resolve();
-  }
-}
-
-export function getConfigurationServiceProvider(
-  servicePriority: number,
-  defaultsData: Map<string, ArgumentValues | ArgumentSingleValueType>,
-) {
-  return new DummyConfigurationServiceProvider(servicePriority, defaultsData);
-}