@flowscripter/dynamic-cli-framework 1.2.1 → 1.3.0

package/src/service/argumentPrompter/DefaultArgumentPrompterService.ts

@@ -21,22 +21,16 @@ import type Positional from "../../api/argument/Positional.ts";
 import type ComplexOption from "../../api/argument/ComplexOption.ts";
 import type SubCommand from "../../api/command/SubCommand.ts";
 import type GlobalCommand from "../../api/command/GlobalCommand.ts";
-import {
-  isGlobalCommand,
-  isSubCommand,
-} from "../../runtime/command/CommandTypeGuards.ts";
+import { isGlobalCommand, isSubCommand } from "../../runtime/command/CommandTypeGuards.ts";
 
-export default class DefaultArgumentPrompterService
-  implements ArgumentPrompterService {
+export default class DefaultArgumentPrompterService implements ArgumentPrompterService {
   readonly #prompterService: PrompterService;
 
   public constructor(prompterService: PrompterService) {
     this.#prompterService = prompterService;
   }
 
-  async promptForMissingArguments(
-    parseResult: ParseResult,
-  ): Promise<ParseResult> {
+  async promptForMissingArguments(parseResult: ParseResult): Promise<ParseResult> {
     if (!this.#prompterService.promptEnabled) {
       return parseResult;
     }
@@ -69,9 +63,7 @@ export default class DefaultArgumentPrompterService
     return parseResult;
   }
 
-  async #promptForGlobalCommand(
-    parseResult: ParseResult,
-  ): Promise<ParseResult> {
+  async #promptForGlobalCommand(parseResult: ParseResult): Promise<ParseResult> {
     const command = parseResult.command as GlobalCommand;
     if (!command.argument) {
       return parseResult;
@@ -97,48 +89,33 @@ export default class DefaultArgumentPrompterService
     };
   }
 
-  async #promptForSubCommand(
-    parseResult: ParseResult,
-  ): Promise<ParseResult> {
+  async #promptForSubCommand(parseResult: ParseResult): Promise<ParseResult> {
     const command = parseResult.command as SubCommand;
-    const existingValues = (parseResult.populatedArgumentValues ??
-      {}) as PopulatedArgumentValues;
-    const newValues: Record<
-      string,
-      PopulatedArgumentValues[string]
-    > = { ...existingValues };
+    const existingValues = (parseResult.populatedArgumentValues ?? {}) as PopulatedArgumentValues;
+    const newValues: Record<string, PopulatedArgumentValues[string]> = {
+      ...existingValues,
+    };
     const remainingInvalid: InvalidArgument[] = [];
 
     for (const invalid of parseResult.invalidArguments) {
-      if (
-        invalid.reason !== InvalidArgumentReason.MISSING_VALUE ||
-        !invalid.name
-      ) {
+      if (invalid.reason !== InvalidArgumentReason.MISSING_VALUE || !invalid.name) {
         remainingInvalid.push(invalid);
         continue;
       }
 
-      const arg = DefaultArgumentPrompterService.#findArgument(
-        command,
-        invalid.name,
-      );
+      const arg = DefaultArgumentPrompterService.#findArgument(command, invalid.name);
       if (!arg) {
         remainingInvalid.push(invalid);
         continue;
       }
 
-      if (
-        "type" in arg &&
-        (arg as ComplexOption).type === ComplexValueTypeName.COMPLEX
-      ) {
+      if ("type" in arg && (arg as ComplexOption).type === ComplexValueTypeName.COMPLEX) {
         const complexValues = await this.#promptForComplexOption(
           invalid.name,
           arg as ComplexOption,
         );
         newValues[invalid.name] = complexValues;
-      } else if (
-        DefaultArgumentPrompterService.#isArrayArgument(arg)
-      ) {
+      } else if (DefaultArgumentPrompterService.#isArrayArgument(arg)) {
         const arrayValues = await this.#promptForArrayArgument(
           invalid.name,
           arg as Option | Positional,
@@ -174,15 +151,11 @@ export default class DefaultArgumentPrompterService
     const values: Record<string, PopulatedArgumentValues[string]> = {};
 
     for (const prop of complexOption.properties) {
-      if (
-        "type" in prop &&
-        (prop as ComplexOption).type === ComplexValueTypeName.COMPLEX
-      ) {
-        values[(prop as ComplexOption).name] = await this
-          .#promptForComplexOption(
-            `${name}.${(prop as ComplexOption).name}`,
-            prop as ComplexOption,
-          );
+      if ("type" in prop && (prop as ComplexOption).type === ComplexValueTypeName.COMPLEX) {
+        values[(prop as ComplexOption).name] = await this.#promptForComplexOption(
+          `${name}.${(prop as ComplexOption).name}`,
+          prop as ComplexOption,
+        );
       } else {
         const option = prop as Option;
         if (option.isOptional && option.defaultValue !== undefined) {
@@ -213,9 +186,7 @@ export default class DefaultArgumentPrompterService
     while (true) {
       const prompt = DefaultArgumentPrompterService.#argumentToPrompt(
         name,
-        `${arg.description ?? name}${
-          values.length > 0 ? ` [${values.length + 1}]` : ""
-        }`,
+        `${arg.description ?? name}${values.length > 0 ? ` [${values.length + 1}]` : ""}`,
         arg as Argument,
       );
       const result = await this.#prompterService.prompt(prompt);
@@ -241,11 +212,7 @@ export default class DefaultArgumentPrompterService
     return values;
   }
 
-  static #argumentToPrompt(
-    name: string,
-    description: string,
-    arg: Argument,
-  ): Prompt {
+  static #argumentToPrompt(name: string, description: string, arg: Argument): Prompt {
     if (arg.type === ArgumentValueTypeName.BOOLEAN) {
       return {
         name,
@@ -269,9 +236,7 @@ export default class DefaultArgumentPrompterService
     }
 
     const validationOption: PromptOption = {
-      displayValue: arg.type === ArgumentValueTypeName.SECRET
-        ? "__SECRET__"
-        : name,
+      displayValue: arg.type === ArgumentValueTypeName.SECRET ? "__SECRET__" : name,
       returnedValue: "",
       min: arg.minValueInclusive,
       max: arg.maxValueInclusive,
@@ -316,9 +281,7 @@ export default class DefaultArgumentPrompterService
     return undefined;
   }
 
-  static #isArrayArgument(
-    arg: Option | Positional | ComplexOption,
-  ): boolean {
+  static #isArrayArgument(arg: Option | Positional | ComplexOption): boolean {
     if ("isArray" in arg && (arg as Option).isArray) {
       return true;
     }

package/src/service/asciiBannerGenerator/AsciiBannerGeneratorServiceProvider.ts

@@ -1,20 +1,14 @@
-import type {
-  ServiceInfo,
-  ServiceProvider,
-} from "../../api/service/ServiceProvider.ts";
+import type { ServiceInfo, ServiceProvider } from "../../api/service/ServiceProvider.ts";
 import type Context from "../../api/Context.ts";
 import type AsciiBannerGeneratorService from "../../api/service/core/AsciiBannerGeneratorService.ts";
-import {
-  ASCII_BANNER_GENERATOR_SERVICE_ID,
-} from "../../api/service/core/AsciiBannerGeneratorService.ts";
+import { ASCII_BANNER_GENERATOR_SERVICE_ID } from "../../api/service/core/AsciiBannerGeneratorService.ts";
 import DefaultAsciiBannerGeneratorService from "./DefaultAsciiBannerGeneratorService.ts";
 import type CLIConfig from "../../api/CLIConfig.ts";
 
 /**
  * Provides an {@link AsciiBannerGeneratorService}.
  */
-export default class AsciiBannerGeneratorServiceProvider
-  implements ServiceProvider {
+export default class AsciiBannerGeneratorServiceProvider implements ServiceProvider {
   readonly serviceId: string = ASCII_BANNER_GENERATOR_SERVICE_ID;
   readonly servicePriority: number;
   readonly #asciiBannerGeneratorService: AsciiBannerGeneratorService;
@@ -24,12 +18,9 @@ export default class AsciiBannerGeneratorServiceProvider
    *
    * @param servicePriority the priority of the service.
    */
-  public constructor(
-    servicePriority: number,
-  ) {
+  public constructor(servicePriority: number) {
     this.servicePriority = servicePriority;
-    this.#asciiBannerGeneratorService =
-      new DefaultAsciiBannerGeneratorService();
+    this.#asciiBannerGeneratorService = new DefaultAsciiBannerGeneratorService();
   }
 
   public getServiceInfo(_cliConfig: CLIConfig): Promise<ServiceInfo> {

package/src/service/asciiBannerGenerator/DefaultAsciiBannerGeneratorService.ts

@@ -16,7 +16,9 @@ function hslToRgb(h: number, s: number, l: number): [number, number, number] {
   const c = (1 - Math.abs(2 * l - 1)) * s;
   const x = c * (1 - Math.abs(((h * 6) % 2) - 1));
   const m = l - c / 2;
-  let r = 0, g = 0, b = 0;
+  let r = 0,
+    g = 0,
+    b = 0;
   if (h < 1 / 6) {
     r = c;
     g = x;
@@ -42,16 +44,12 @@ function hslToRgb(h: number, s: number, l: number): [number, number, number] {
     g = 0;
     b = x;
   }
-  return [
-    Math.round((r + m) * 255),
-    Math.round((g + m) * 255),
-    Math.round((b + m) * 255),
-  ];
+  return [Math.round((r + m) * 255), Math.round((g + m) * 255), Math.round((b + m) * 255)];
 }
 
 function parseHex(hex: string): [number, number, number] {
   const v = parseInt(hex.slice(1), 16);
-  return [(v >> 16) & 0xFF, (v >> 8) & 0xFF, v & 0xFF];
+  return [(v >> 16) & 0xff, (v >> 8) & 0xff, v & 0xff];
 }
 
 function interpolateColors(
@@ -84,13 +82,11 @@ function rainbowColor(
   x: number,
   y: number,
 ): [number, number, number] {
-  const h = ((freq * (x / spread) + seed + y * freq / spread) % 1.0 + 1.0) %
-    1.0;
+  const h = (((freq * (x / spread) + seed + (y * freq) / spread) % 1.0) + 1.0) % 1.0;
   return hslToRgb(h, 1.0, 0.5);
 }
 
-export default class DefaultAsciiBannerGeneratorService
-  implements AsciiBannerGeneratorService {
+export default class DefaultAsciiBannerGeneratorService implements AsciiBannerGeneratorService {
   #registeredFontNames: Array<string> = [];
 
   constructor() {
@@ -110,47 +106,39 @@ export default class DefaultAsciiBannerGeneratorService
     figlet.parseFont(fontName, fontDefinition);
   }
 
-  protected applyForegroundEffect(
-    lines: string[],
-    effect: ColorEffect,
-  ): string[] {
+  protected applyForegroundEffect(lines: string[], effect: ColorEffect): string[] {
     if (effect.type === "fixed") {
       const [r, g, b] = parseHex(effect.color);
       const code = foregroundColorStart(r, g, b);
       return lines.map((line) =>
-        line.split("").map((ch) =>
-          ch === " " ? ch : code + ch + FOREGROUND_COLOR_END
-        ).join(
-          "",
-        )
+        line
+          .split("")
+          .map((ch) => (ch === " " ? ch : code + ch + FOREGROUND_COLOR_END))
+          .join(""),
       );
     }
     if (effect.type === "gradient") {
       const colorStops = effect.colors.map(parseHex);
       return lines.map((line, yi) => {
         if (effect.direction === "vertical") {
-          const [r, g, b] = interpolateColors(
-            colorStops,
-            yi,
-            Math.max(lines.length, 1),
-          );
+          const [r, g, b] = interpolateColors(colorStops, yi, Math.max(lines.length, 1));
           const code = foregroundColorStart(r, g, b);
-          return line.split("").map((ch) =>
-            ch === " " ? ch : code + ch + FOREGROUND_COLOR_END
-          ).join("");
+          return line
+            .split("")
+            .map((ch) => (ch === " " ? ch : code + ch + FOREGROUND_COLOR_END))
+            .join("");
         }
         const nonSpaceCount = line.split("").filter((c) => c !== " ").length;
         let charIdx = 0;
-        return line.split("").map((ch) => {
-          if (ch === " ") return ch;
-          const [r, g, b] = interpolateColors(
-            colorStops,
-            charIdx,
-            Math.max(nonSpaceCount, 1),
-          );
-          charIdx++;
-          return foregroundColorStart(r, g, b) + ch + FOREGROUND_COLOR_END;
-        }).join("");
+        return line
+          .split("")
+          .map((ch) => {
+            if (ch === " ") return ch;
+            const [r, g, b] = interpolateColors(colorStops, charIdx, Math.max(nonSpaceCount, 1));
+            charIdx++;
+            return foregroundColorStart(r, g, b) + ch + FOREGROUND_COLOR_END;
+          })
+          .join("");
       });
     }
     const freq = effect.frequency ?? 0.3;
@@ -160,24 +148,25 @@ export default class DefaultAsciiBannerGeneratorService
       if (effect.direction === "vertical") {
         const [r, g, b] = rainbowColor(freq, spread, seed, 0, yi);
         const code = foregroundColorStart(r, g, b);
-        return line.split("").map((ch) =>
-          ch === " " ? ch : code + ch + FOREGROUND_COLOR_END
-        ).join("");
+        return line
+          .split("")
+          .map((ch) => (ch === " " ? ch : code + ch + FOREGROUND_COLOR_END))
+          .join("");
       }
       let charIdx = 0;
-      return line.split("").map((ch) => {
-        if (ch === " ") return ch;
-        const [r, g, b] = rainbowColor(freq, spread, seed, charIdx, yi);
-        charIdx++;
-        return foregroundColorStart(r, g, b) + ch + FOREGROUND_COLOR_END;
-      }).join("");
+      return line
+        .split("")
+        .map((ch) => {
+          if (ch === " ") return ch;
+          const [r, g, b] = rainbowColor(freq, spread, seed, charIdx, yi);
+          charIdx++;
+          return foregroundColorStart(r, g, b) + ch + FOREGROUND_COLOR_END;
+        })
+        .join("");
     });
   }
 
-  protected applyBackgroundEffect(
-    lines: string[],
-    effect: ColorEffect,
-  ): string[] {
+  protected applyBackgroundEffect(lines: string[], effect: ColorEffect): string[] {
     if (effect.type === "fixed") {
       const [r, g, b] = parseHex(effect.color);
       const code = backgroundColorStart(r, g, b);
@@ -187,18 +176,17 @@ export default class DefaultAsciiBannerGeneratorService
       const colorStops = effect.colors.map(parseHex);
       return lines.map((line, yi) => {
         if (effect.direction === "vertical") {
-          const [r, g, b] = interpolateColors(
-            colorStops,
-            yi,
-            Math.max(lines.length, 1),
-          );
+          const [r, g, b] = interpolateColors(colorStops, yi, Math.max(lines.length, 1));
           return backgroundColorStart(r, g, b) + line + BACKGROUND_COLOR_END;
         }
         const totalChars = Math.max(line.length, 1);
-        return line.split("").map((ch, xi) => {
-          const [r, g, b] = interpolateColors(colorStops, xi, totalChars);
-          return backgroundColorStart(r, g, b) + ch + BACKGROUND_COLOR_END;
-        }).join("");
+        return line
+          .split("")
+          .map((ch, xi) => {
+            const [r, g, b] = interpolateColors(colorStops, xi, totalChars);
+            return backgroundColorStart(r, g, b) + ch + BACKGROUND_COLOR_END;
+          })
+          .join("");
       });
     }
     const freq = effect.frequency ?? 0.3;
@@ -209,17 +197,17 @@ export default class DefaultAsciiBannerGeneratorService
         const [r, g, b] = rainbowColor(freq, spread, seed, 0, yi);
         return backgroundColorStart(r, g, b) + line + BACKGROUND_COLOR_END;
       }
-      return line.split("").map((ch, xi) => {
-        const [r, g, b] = rainbowColor(freq, spread, seed, xi, yi);
-        return backgroundColorStart(r, g, b) + ch + BACKGROUND_COLOR_END;
-      }).join("");
+      return line
+        .split("")
+        .map((ch, xi) => {
+          const [r, g, b] = rainbowColor(freq, spread, seed, xi, yi);
+          return backgroundColorStart(r, g, b) + ch + BACKGROUND_COLOR_END;
+        })
+        .join("");
     });
   }
 
-  async generate(
-    message: string,
-    options?: BannerGenerateOptions,
-  ): Promise<string> {
+  async generate(message: string, options?: BannerGenerateOptions): Promise<string> {
     const fontName = (options?.fontName ?? "standard").toLowerCase();
     if (!this.getRegisteredFonts().includes(fontName)) {
       throw new Error(`Font name is not registered: ${fontName}`);
@@ -239,7 +227,7 @@ export default class DefaultAsciiBannerGeneratorService
       subMessageLine = options.subMessage
         .toUpperCase()
         .split("")
-        .map((c) => c === " " ? "  " : c + " ")
+        .map((c) => (c === " " ? "  " : c + " "))
         .join("")
         .trimEnd();
 
@@ -258,20 +246,14 @@ export default class DefaultAsciiBannerGeneratorService
     const colorEffects = options?.colorEffects;
 
     if (colorEffects?.messageForeground) {
-      titleLines = this.applyForegroundEffect(
-        titleLines,
-        colorEffects.messageForeground,
-      );
+      titleLines = this.applyForegroundEffect(titleLines, colorEffects.messageForeground);
     }
 
     let subLines: string[] | undefined;
     if (subMessageLine !== undefined) {
       subLines = [subMessageLine];
       if (colorEffects?.subMessageForeground) {
-        subLines = this.applyForegroundEffect(
-          subLines,
-          colorEffects.subMessageForeground,
-        );
+        subLines = this.applyForegroundEffect(subLines, colorEffects.subMessageForeground);
       }
     }
 

package/src/service/banner/BannerServiceProvider.ts

@@ -1,19 +1,13 @@
 import type Context from "../../api/Context.ts";
-import type {
-  ServiceInfo,
-  ServiceProvider,
-} from "../../api/service/ServiceProvider.ts";
+import type { ServiceInfo, ServiceProvider } from "../../api/service/ServiceProvider.ts";
 import NoBannerCommand from "./command/NoBannerCommand.ts";
 import type PrinterService from "../../api/service/core/PrinterService.ts";
 import { PRINTER_SERVICE_ID } from "../../api/service/core/PrinterService.ts";
 import type ConfigurationServiceProvider from "../configuration/ConfigurationServiceProvider.ts";
 import type AsciiBannerGeneratorService from "../../api/service/core/AsciiBannerGeneratorService.ts";
-import {
-  ASCII_BANNER_GENERATOR_SERVICE_ID,
-} from "../../api/service/core/AsciiBannerGeneratorService.ts";
+import { ASCII_BANNER_GENERATOR_SERVICE_ID } from "../../api/service/core/AsciiBannerGeneratorService.ts";
 import type CLIConfig from "../../api/CLIConfig.ts";
-export const BANNER_SERVICE_ID =
-  "@flowscripter/dynamic-cli-framework/banner-service";
+export const BANNER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/banner-service";
 
 /**
  * Provides ascii banner functionality.
@@ -21,9 +15,7 @@ export const BANNER_SERVICE_ID =
 export default class BannerServiceProvider implements ServiceProvider {
   readonly serviceId: string = BANNER_SERVICE_ID;
   readonly servicePriority: number;
-  readonly #configurationServiceProvider:
-    | ConfigurationServiceProvider
-    | undefined;
+  readonly #configurationServiceProvider: ConfigurationServiceProvider | undefined;
 
   /**
    * Whether or not to print the banner, defaults to true.
@@ -48,9 +40,7 @@ export default class BannerServiceProvider implements ServiceProvider {
 
   public getServiceInfo(_cliConfig: CLIConfig): Promise<ServiceInfo> {
     return Promise.resolve({
-      commands: [
-        new NoBannerCommand(this, this.servicePriority),
-      ],
+      commands: [new NoBannerCommand(this, this.servicePriority)],
     });
   }
 
@@ -59,41 +49,29 @@ export default class BannerServiceProvider implements ServiceProvider {
       return Promise.resolve();
     }
 
-    const printerService = context.getServiceById(
-      PRINTER_SERVICE_ID,
-    ) as PrinterService;
+    const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
 
     const asciiBannerGeneratorService = context.getServiceById(
       ASCII_BANNER_GENERATOR_SERVICE_ID,
     ) as AsciiBannerGeneratorService;
 
     const { cliConfig } = context;
-    const bannerText = await asciiBannerGeneratorService.generate(
-      cliConfig.name.toUpperCase(),
-      { fontName: this.fontName, subMessage: cliConfig.subMessage },
-    );
+    const bannerText = await asciiBannerGeneratorService.generate(cliConfig.name.toUpperCase(), {
+      fontName: this.fontName,
+      subMessage: cliConfig.subMessage,
+    });
 
     await printerService.info(printerService.blue(bannerText));
     if (cliConfig.description !== undefined) {
-      await printerService.info(
-        `  ${printerService.primary(cliConfig.description)}\n`,
-      );
+      await printerService.info(`  ${printerService.primary(cliConfig.description)}\n`);
     }
     if (cliConfig.version.length > 0) {
-      await printerService.info(
-        `  ${printerService.secondary("version: " + cliConfig.version)}\n`,
-      );
+      await printerService.info(`  ${printerService.secondary("version: " + cliConfig.version)}\n`);
     }
     if (this.#configurationServiceProvider) {
       const configLocation = this.#configurationServiceProvider.configLocation;
       if (configLocation && configLocation.length > 0) {
-        await printerService.info(
-          `  ${
-            printerService.secondary(
-              "config: " + configLocation,
-            )
-          }\n`,
-        );
+        await printerService.info(`  ${printerService.secondary("config: " + configLocation)}\n`);
       }
     }
     await printerService.info("\n");

package/src/service/banner/command/NoBannerCommand.ts

@@ -23,18 +23,12 @@ export default class NoBannerCommand implements GlobalModifierCommand {
 
   readonly #bannerServiceProvider: BannerServiceProvider;
 
-  public constructor(
-    bannerServiceProvider: BannerServiceProvider,
-    executePriority: number,
-  ) {
+  public constructor(bannerServiceProvider: BannerServiceProvider, executePriority: number) {
     this.#bannerServiceProvider = bannerServiceProvider;
     this.executePriority = executePriority;
   }
 
-  public execute(
-    _context: Context,
-    argumentValue: ArgumentSingleValueType,
-  ): Promise<void> {
+  public execute(_context: Context, argumentValue: ArgumentSingleValueType): Promise<void> {
     this.#bannerServiceProvider.printBanner = !(argumentValue as boolean);
 
     return Promise.resolve();

package/src/service/chiselAsciiBannerGenerator/ChiselFontAsciiBannerGeneratorService.ts

@@ -19,7 +19,8 @@ export interface ChiselBannerGenerateOptions extends BannerGenerateOptions {
 
 export default class ChiselFontAsciiBannerGeneratorService
   extends DefaultAsciiBannerGeneratorService
-  implements AsciiBannerGeneratorService {
+  implements AsciiBannerGeneratorService
+{
   private _ready = false;
 
   constructor() {
@@ -40,10 +41,7 @@ export default class ChiselFontAsciiBannerGeneratorService
     return ["chisel"];
   }
 
-  override async generate(
-    message: string,
-    options?: ChiselBannerGenerateOptions,
-  ): Promise<string> {
+  override async generate(message: string, options?: ChiselBannerGenerateOptions): Promise<string> {
     const chiselOptions: BannerGenerateOptions = {
       ...options,
       fontName: "chisel",
@@ -73,11 +71,8 @@ export default class ChiselFontAsciiBannerGeneratorService
         colorMap["100"] = colors.shadowBackground;
       }
 
-      result = result.replace(
-        // deno-lint-ignore no-control-regex
-        /\x1b\[(\d+)m/g,
-        (_, n) => `\x1b[${colorMap[n] ?? n}m`,
-      );
+      const ansiCodeRe = /\x1b\[(\d+)m/g; // oxlint-disable-line no-control-regex
+      result = result.replace(ansiCodeRe, (_, n) => `\x1b[${colorMap[n] ?? n}m`);
     }
 
     return result;