@flowscripter/dynamic-cli-framework 1.1.3 → 1.1.4

package/bun.lock

@@ -13,7 +13,7 @@
         "ts-log": "^2.2.7",
       },
       "devDependencies": {
-        "@types/bun": "^1.2.8",
+        "@types/bun": "^1.2.9",
       },
       "peerDependencies": {
         "typescript": "^5.8.3",
@@ -21,7 +21,7 @@
     },
   },
   "packages": {
-    "@types/bun": ["@types/bun@1.2.8", "", { "dependencies": { "bun-types": "1.2.7" } }, "sha512-t8L1RvJVUghW5V+M/fL3Thbxcs0HwNsXsnTEBEfEVqGteiJToOlZ/fyOEaR1kZsNqnu+3XA4RI/qmnX4w6+S+w=="],
+    "@types/bun": ["@types/bun@1.2.9", "", { "dependencies": { "bun-types": "1.2.9" } }, "sha512-epShhLGQYc4Bv/aceHbmBhOz1XgUnuTZgcxjxk+WXwNyDXavv5QHD1QEFV0FwbTSQtNq6g4ZcV6y0vZakTjswg=="],
 
     "@types/hast": ["@types/hast@3.0.4", "", { "dependencies": { "@types/unist": "*" } }, "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ=="],
 
@@ -31,7 +31,7 @@
 
     "@types/ws": ["@types/ws@8.5.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw=="],
 
-    "bun-types": ["bun-types@1.2.7", "", { "dependencies": { "@types/node": "*", "@types/ws": "*" } }, "sha512-P4hHhk7kjF99acXqKvltyuMQ2kf/rzIw3ylEDpCxDS9Xa0X0Yp/gJu/vDCucmWpiur5qJ0lwB2bWzOXa2GlHqA=="],
+    "bun-types": ["bun-types@1.2.9", "", { "dependencies": { "@types/node": "*", "@types/ws": "*" } }, "sha512-dk/kOEfQbajENN/D6FyiSgOKEuUi9PWfqKQJEgwKrCMWbjS/S6tEXp178mWvWAcUSYm9ArDlWHZKO3T/4cLXiw=="],
 
     "chalk": ["chalk@5.4.1", "", {}, "sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w=="],
 

package/package.json

@@ -18,12 +18,12 @@
   ],
   "module": "index.ts",
   "type": "module",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "@types/bun": "^1.2.8"
+    "@types/bun": "^1.2.9"
   },
   "peerDependencies": {
     "typescript": "^5.8.3"

package/src/api/service/core/PrinterService.ts

@@ -129,11 +129,20 @@ export default interface PrinterService {
   cyan(message: string): string;
 
   /**
-   * Return the provided message so that it the foreground is green.
+   * Return the provided message so that the foreground is green.
    * Has no effect if {@link colorEnabled} is `false`.
    */
   green(message: string): string;
 
+  /**
+   * Return the provided message so that the foreground is the specified color.
+   * Has no effect if {@link colorEnabled} is `false`.
+   *
+   * @param message the message to color.
+   * @param hexFormattedColor the color to use. This should be a valid hex formatted string e.g. "0xrrggbb".
+   */
+  color(message: string, hexFormattedColor: string): string;
+
   /**
    * Print a message on `stdout`.
    * Will be displayed as primary content if {@link colorEnabled} is `true`.

package/src/api/service/core/SyntaxHighlighterService.ts

@@ -3,6 +3,17 @@ import type { LanguageFn as HighlightSyntax } from "highlight.js";
 export const SYNTAX_HIGHLIGHTER_SERVICE_ID =
   "@flowscripter/dynamic-cli-framework/syntax-highlighter-service";
 
+/**
+ * Color scheme for syntax highlighting.
+ *
+ * The keys are the names of the defined [highlight.js scopes](https://highlightjs.readthedocs.io/en/latest/css-classes-reference.html).
+ *
+ * The values are colors expressed as a hex formatted string e.g. "0xrrggbb".
+ *
+ * The scheme does not need to list all scopes exhaustively.
+ */
+export type ColorScheme = Record<string, string>;
+
 /**
  * Service providing syntax based color highlighting of text for the CLI using [highlight.js](https://github.com/highlightjs/highlight.js).
  */
@@ -33,10 +44,15 @@ export default interface SyntaxHighlighterService {
 
   /**
    * Return a syntactically highlighted version of the provided text using the specified syntax.
-   * The returned text will include appropriate terminal color codes.
+   * The returned text will include appropriate color styling. An optional {@link ColorScheme} can be provided.
    *
    * @param text the text to highlight.
    * @param syntaxName the syntax to use.
+   * @param colorScheme the color scheme to use.
    */
-  highlight(text: string, syntaxName: string): string;
+  highlight(
+    text: string,
+    syntaxName: string,
+    colorScheme?: ColorScheme,
+  ): string;
 }

package/src/service/asciiBannerGenerator/DefaultAsciiBannerGeneratorService.ts

@@ -34,6 +34,16 @@ export default class DefaultAsciiBannerGeneratorService
       throw new Error(`Font name is not registered: ${name}`);
     }
 
-    return "\n" + await figlet.text(message, { font: name }) + "\n";
+    const bannerText = await figlet.text(message, { font: name });
+    const lines = bannerText.split("\n");
+
+    // Remove any whitespace lines from the end
+    while (
+      (lines.length > 0) && (lines[lines.length - 1].trim().length === 0)
+    ) {
+      lines.pop();
+    }
+
+    return "\n" + lines.join("\n") + "\n";
   }
 }

package/src/service/banner/BannerServiceProvider.ts

@@ -35,10 +35,12 @@ export default class BannerServiceProvider implements ServiceProvider {
    *
    * @param servicePriority the priority of the service.
    * @param configurationServiceProvider an optional {@link ConfigurationServiceProvider} to make use of.
+   * @param fontName an optional [FIGlet](http://www.figlet.org) font name to use for the banner, defaults to "standard".
    */
   public constructor(
     servicePriority: number,
     configurationServiceProvider?: ConfigurationServiceProvider,
+    private readonly fontName: string = "standard",
   ) {
     this.servicePriority = servicePriority;
     this.#configurationServiceProvider = configurationServiceProvider;
@@ -68,7 +70,7 @@ export default class BannerServiceProvider implements ServiceProvider {
     const { cliConfig } = context;
     const bannerText = await asciiBannerGeneratorService.generate(
       cliConfig.name.toUpperCase(),
-      "standard",
+      this.fontName,
     );
 
     await printerService.info(printerService.blue(bannerText));

package/src/service/printer/DefaultPrinterService.ts

@@ -161,6 +161,23 @@ export default class DefaultPrinterService implements PrinterService {
     return this.#styler.colorText(message, this.#theme[Color.GREEN]);
   }
 
+  public color(message: string, hexFormattedColor: string): string {
+    if (
+      (hexFormattedColor.length !== 8) ||
+      (!hexFormattedColor.toLowerCase().startsWith("0x"))
+    ) {
+      throw new Error(`Invalid color: ${hexFormattedColor}`);
+    }
+
+    const colorValue = parseInt(hexFormattedColor, 16);
+
+    if (isNaN(colorValue) || (colorValue < 0 || colorValue > 0xffffff)) {
+      throw new Error(`Invalid color: ${hexFormattedColor}`);
+    }
+
+    return this.#styler.colorText(message, colorValue);
+  }
+
   public async debug(message: string, icon?: Icon): Promise<void> {
     await this.#log(Level.DEBUG, this.secondary(message), icon);
   }

package/src/service/syntaxHighlighter/DefaultSyntaxHighlighterService.ts

@@ -2,6 +2,9 @@ import type SyntaxHighlighterService from "../../api/service/core/SyntaxHighligh
 import type { LanguageFn as HighlightSyntax } from "highlight.js";
 import { createEmphasize } from "emphasize";
 import json from "highlight.js/lib/languages/json";
+import { ColorScheme } from "../../api/service/core/SyntaxHighlighterService.ts";
+
+type Sheet = Record<string, (string) => string> | undefined;
 
 interface Emphasize {
   listLanguages(): ReadonlyArray<string>;
@@ -9,7 +12,7 @@ interface Emphasize {
   highlight(
     name: string,
     text: string,
-    sheet: Record<string, (string) => string> | undefined,
+    sheet: Sheet,
   ): { value: string };
   register(name: string, syntax: HighlightSyntax): void;
 }
@@ -21,7 +24,8 @@ interface Emphasize {
 export default class DefaultSyntaxHighlighterService
   implements SyntaxHighlighterService {
   colorEnabled = true;
-  sheet: Record<string, (text: string) => string> | undefined;
+  colorFunction: (text: string, hexFormattedColor: string) => string;
+
   emphasize: Emphasize;
 
   constructor() {
@@ -33,7 +37,11 @@ export default class DefaultSyntaxHighlighterService
     return this.emphasize.listLanguages();
   }
 
-  highlight(text: string, syntaxName: string): string {
+  highlight(
+    text: string,
+    syntaxName: string,
+    colorScheme?: ColorScheme,
+  ): string {
     const name = syntaxName.toLowerCase();
     if (!this.emphasize.registered(name)) {
       throw new Error(`Syntax name is not registered: ${name}`);
@@ -44,7 +52,19 @@ export default class DefaultSyntaxHighlighterService
       return text;
     }
 
-    return this.emphasize.highlight(name, text, this.sheet).value;
+    let sheet: Sheet;
+
+    // if a color scheme is provided, create a sheet of color functions
+    if (colorScheme && this.colorFunction) {
+      sheet = {};
+      for (const [key, value] of Object.entries(colorScheme)) {
+        if (value) {
+          sheet[key] = (text: string) => this.colorFunction(text, value);
+        }
+      }
+    }
+
+    return this.emphasize.highlight(name, text, sheet).value;
   }
 
   registerSyntax(syntaxName: string, syntaxDefinition: HighlightSyntax): void {

package/src/service/syntaxHighlighter/SyntaxHighlighterServiceProvider.ts

@@ -45,20 +45,8 @@ export default class SyntaxHighlighterServiceProvider
 
     this.#defaultSyntaxHighlighterService.colorEnabled =
       printerService.colorEnabled;
-
-    if (this.#defaultSyntaxHighlighterService.sheet === undefined) {
-      this.#defaultSyntaxHighlighterService.sheet = {
-        comment: printerService.secondary,
-        keyword: printerService.primary,
-        built_in: printerService.primary,
-        type: printerService.emphasised,
-        operator: printerService.blue,
-        punctuation: printerService.green,
-        literal: printerService.selected,
-        string: printerService.selected,
-        number: printerService.selected,
-      };
-    }
+    this.#defaultSyntaxHighlighterService.colorFunction = printerService.color
+      .bind(printerService);
 
     return Promise.resolve(undefined);
   }

package/tests/service/asciiBannerGenerator/__snapshots__/DefaultAsciiBannerGeneratorService.test.ts.snap

@@ -1,26 +1,5 @@
 // Bun Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`DefaultAsciiBannerGeneratorService Tests Can generate with standard font 1`] = `
-"
-   __             
-  / _| ___   ___  
- | |_ / _ \\ / _ \\ 
- |  _| (_) | (_) |
- |_|  \\___/ \\___/ 
-                  
-"
-`;
-
-exports[`DefaultAsciiBannerGeneratorService Tests Can generate with newly registered font 1`] = `
-"
-   __          
-  / _|___  ___ 
- |  _/ _ \\/ _ \\
- |_| \\___/\\___/
-               
-"
-`;
-
 exports[`DefaultAsciiBannerGeneratorService tests Can generate with standard font 1`] = `
 "
    __             
@@ -28,7 +7,6 @@ exports[`DefaultAsciiBannerGeneratorService tests Can generate with standard fon
  | |_ / _ \\ / _ \\ 
  |  _| (_) | (_) |
  |_|  \\___/ \\___/ 
-                  
 "
 `;
 
@@ -38,6 +16,5 @@ exports[`DefaultAsciiBannerGeneratorService tests Can generate with newly regist
   / _|___  ___ 
  |  _/ _ \\/ _ \\
  |_| \\___/\\___/
-               
 "
 `;

package/tests/service/{launchBanner → banner}/BannerServiceProvider.test.ts

@@ -9,6 +9,12 @@ import DefaultAsciiBannerGeneratorService from "../../../src/service/asciiBanner
 import TtyTerminal from "../../../src/service/printer/terminal/TtyTerminal.ts";
 import StreamString from "../../fixtures/StreamString.ts";
 import TtyStyler from "../../../src/service/printer/terminal/TtyStyler.ts";
+import { getConfigurationServiceProvider } from "../../fixtures/ConfigurationServiceProvider.ts";
+
+// FIGlet font is converted to a JSON string and embedded in a simple JSON file: `{ "font": "<figlet font definition>" }`
+import smallFont from "../asciiBannerGenerator/small.flf.json" with {
+  type: "json",
+};
 
 describe("BannerServiceProvider tests", () => {
   test("BannerServiceProvider provide works", async () => {
@@ -44,6 +50,47 @@ describe("BannerServiceProvider tests", () => {
 
     expect(bannerServiceProvider.printBanner).toBeTrue();
 
+    expect(dummyStderr.getString()).toMatchSnapshot();
+  });
+
+  test("BannerServiceProvider with configuration service and custom font name works", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printer = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printer.colorEnabled = false;
+
+    const asciiBannerGenerator = new DefaultAsciiBannerGeneratorService();
+    const context = new DefaultContext(getCLIConfig("mpeg-sdl-tool"));
+
+    context.addServiceInstance(PRINTER_SERVICE_ID, printer);
+    context.addServiceInstance(
+      ASCII_BANNER_GENERATOR_SERVICE_ID,
+      asciiBannerGenerator,
+    );
+
+    asciiBannerGenerator.registerFont("small", smallFont.font);
+
+    const configurationServiceProvider = getConfigurationServiceProvider(
+      100,
+      new Map(),
+    );
+    configurationServiceProvider.configLocation = "config.yaml";
+
+    const bannerServiceProvider = new BannerServiceProvider(
+      100,
+      configurationServiceProvider,
+      "small",
+    );
+    await bannerServiceProvider.initService(context);
+    await printer.error("some text\n");
+    expect(bannerServiceProvider.printBanner).toBeTrue();
     expect(dummyStdout.getString()).toMatchSnapshot();
   });
 });

package/tests/service/banner/__snapshots__/BannerServiceProvider.test.ts.snap

@@ -0,0 +1,16 @@
+// Bun Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`BannerServiceProvider tests BannerServiceProvider initService works 1`] = `
+"
+  _____ ___   ___  
+ |  ___/ _ \\ / _ \\ 
+ | |_ | | | | | | |
+ |  _|| |_| | |_| |
+ |_|   \\___/ \\___/ 
+  bar
+  version: foobar
+
+"
+`;
+
+exports[`BannerServiceProvider tests BannerServiceProvider with configuration service and custom font name works 1`] = `""`;

package/tests/service/printer/DefaultPrinterService.test.ts

@@ -1,4 +1,4 @@
-import { describe, test } from "bun:test";
+import { describe, expect, test } from "bun:test";
 import {
   expectBytesEquals,
   expectStringEquals,
@@ -110,6 +110,94 @@ describe("DefaultPrinterService tests", () => {
     );
   });
 
+  test("Custom color works", async () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = true;
+    await printerService.info(printerService.color("hello", "0x000000"));
+    expectBytesEquals(
+      dummyStderr.getString(),
+      new Uint8Array([
+        27,
+        91,
+        51,
+        56,
+        59,
+        50,
+        59,
+        49,
+        48,
+        49,
+        59,
+        49,
+        50,
+        51,
+        59,
+        49,
+        51,
+        49,
+        109,
+        27,
+        91,
+        51,
+        56,
+        59,
+        50,
+        59,
+        48,
+        59,
+        48,
+        59,
+        48,
+        109,
+        104,
+        101,
+        108,
+        108,
+        111,
+        27,
+        91,
+        51,
+        57,
+        109,
+        27,
+        91,
+        51,
+        57,
+        109,
+      ]),
+    );
+  });
+
+  test("Custom color validation works", () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printerService = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printerService.colorEnabled = true;
+
+    expect(() => printerService.color("hello", "foo")).toThrow(
+      "Invalid color: foo",
+    );
+    expect(() => printerService.color("hello", "0x0")).toThrow(
+      "Invalid color: 0x0",
+    );
+  });
+
   test("stdout writable accessible", async () => {
     const dummyStdout = new StreamString();
     const dummyStderr = new StreamString();

package/tests/service/syntaxHighlighter/DefaultSyntaxHighlighterService.test.ts

@@ -2,6 +2,10 @@ import { describe, expect, test } from "bun:test";
 import { expectBytesEquals } from "../../fixtures/util.ts";
 import DefaultSyntaxHighlighterService from "../../../src/service/syntaxHighlighter/DefaultSyntaxHighlighterService.ts";
 import yaml from "highlight.js/lib/languages/yaml";
+import DefaultPrinterService from "../../../src/service/printer/DefaultPrinterService.ts";
+import TtyStyler from "../../../src/service/printer/terminal/TtyStyler.ts";
+import TtyTerminal from "../../../src/service/printer/terminal/TtyTerminal.ts";
+import StreamString from "../../fixtures/StreamString.ts";
 
 describe("DefaultSyntaxHighlighterService tests", () => {
   test("JSON registered by default", () => {
@@ -37,8 +41,6 @@ describe("DefaultSyntaxHighlighterService tests", () => {
   test("Can highlight with JSON syntax", () => {
     const syntaxHighlighterService = new DefaultSyntaxHighlighterService();
 
-    syntaxHighlighterService.registerSyntax("yaml", yaml);
-
     const highlighted = syntaxHighlighterService.highlight(
       "{ foo: 1 }",
       "json",
@@ -70,6 +72,67 @@ describe("DefaultSyntaxHighlighterService tests", () => {
     );
   });
 
+  test("Can highlight with JSON syntax and custom color scheme", () => {
+    const dummyStdout = new StreamString();
+    const dummyStderr = new StreamString();
+    const printer = new DefaultPrinterService(
+      dummyStdout.writableStream,
+      dummyStderr.writableStream,
+      true,
+      true,
+      new TtyTerminal(dummyStderr.writeStream),
+      new TtyStyler(3),
+    );
+    printer.colorEnabled = true;
+
+    const syntaxHighlighterService = new DefaultSyntaxHighlighterService();
+
+    syntaxHighlighterService.colorFunction = printer.color.bind(printer);
+
+    const highlighted = syntaxHighlighterService.highlight(
+      "{ foo: 1 }",
+      "json",
+      {
+        "number": "0xFF0000",
+      },
+    );
+    expectBytesEquals(
+      highlighted,
+      new Uint8Array([
+        123,
+        32,
+        102,
+        111,
+        111,
+        58,
+        32,
+        27,
+        91,
+        51,
+        56,
+        59,
+        50,
+        59,
+        50,
+        53,
+        53,
+        59,
+        48,
+        59,
+        48,
+        109,
+        49,
+        27,
+        91,
+        51,
+        57,
+        109,
+        32,
+        125,
+      ]),
+    );
+  });
+
   test("Can highlight with newly registered syntax", () => {
     const syntaxHighlighterService = new DefaultSyntaxHighlighterService();
 

package/tests/service/launchBanner/__snapshots__/BannerServiceProvider.test.ts.snap

@@ -1,5 +0,0 @@
-// Bun Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`BannerServiceProvider Tests BannerServiceProvider initService works 1`] = `""`;
-
-exports[`BannerServiceProvider tests BannerServiceProvider initService works 1`] = `""`;