@flowscripter/dynamic-cli-framework 6.0.1 → 7.0.0

package/src/startup/banner/bannerStartupTask.ts

@@ -0,0 +1,96 @@
+import type {
+  Context,
+  KeyValueService,
+  PrinterService,
+  StartupTask,
+  UpgradeCheckResult,
+} from "@flowscripter/dynamic-cli-framework-api";
+import {
+  ASCII_BANNER_GENERATOR_SERVICE_ID,
+  CONFIGURATION_SERVICE_ID,
+  KEY_VALUE_SERVICE_ID,
+  PRINTER_SERVICE_ID,
+} from "@flowscripter/dynamic-cli-framework-api";
+import type { AsciiBannerGeneratorService } from "@flowscripter/dynamic-cli-framework-api";
+import type { ConfigurationService } from "@flowscripter/dynamic-cli-framework-api";
+import { UPGRADE_CHECK_CACHE_KEY } from "../../service/upgrade/DefaultUpgradeService.ts";
+import NoBannerCommand, { type BannerState } from "./command/NoBannerCommand.ts";
+
+export const BANNER_STARTUP_TASK_ID = "@flowscripter/dynamic-cli-framework/banner-startup-task";
+
+/**
+ * Build the ascii banner {@link StartupTask}, replacing the old `BannerServiceProvider`.
+ *
+ * A consumer opts in by passing the result of this function in the `serviceProviders` array
+ * argument of {@link launchMultiCommandCLI}/{@link launchSingleCommandCLI} (or via
+ * `BaseCLI.addStartupTask`), the same way `new BannerServiceProvider(priority)` used to be passed
+ * in that array - there's no default/automatic banner registration.
+ *
+ * @param priority the priority of the task (higher runs earlier - the same semantics
+ * `BannerServiceProvider.servicePriority` had).
+ * @param fontName an optional [FIGlet](http://www.figlet.org) font name to use for the banner,
+ * defaults to "standard".
+ */
+export default function createBannerStartupTask(
+  priority: number,
+  fontName = "standard",
+): StartupTask {
+  const state: BannerState = { printBanner: true };
+
+  return {
+    id: BANNER_STARTUP_TASK_ID,
+    priority,
+    mode: "blocking",
+    modifierCommands: [new NoBannerCommand(state, priority)],
+    run: async (context: Context): Promise<void> => {
+      if (!state.printBanner) {
+        return;
+      }
+
+      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,
+        subMessage: cliConfig.subMessage,
+      });
+
+      await printerService.info(printerService.blue(bannerText));
+      if (cliConfig.description !== undefined) {
+        await printerService.info(`  ${printerService.primary(cliConfig.description)}\n`);
+      }
+      if (cliConfig.version.length > 0) {
+        let versionLine = "version: " + cliConfig.version;
+        // Cheap cache read only - never calls checkForUpgrade()/getUpgradeCheckResult() live,
+        // since that could stall startup on a network/spawn call. A first-ever run (no cached
+        // key yet) simply shows no upgrade-available suffix - that's expected, not a bug.
+        if (context.doesServiceExist(KEY_VALUE_SERVICE_ID)) {
+          const keyValueService = context.getServiceById(KEY_VALUE_SERVICE_ID) as KeyValueService;
+          if (await keyValueService.has(UPGRADE_CHECK_CACHE_KEY)) {
+            const result = (await keyValueService.get(
+              UPGRADE_CHECK_CACHE_KEY,
+            )) as unknown as UpgradeCheckResult;
+            if (result.status === "checked" && result.updateAvailable) {
+              versionLine += ` (${result.latestVersion} available, run '${cliConfig.name} upgrade')`;
+            }
+          }
+        }
+        await printerService.info(`  ${printerService.secondary(versionLine)}\n`);
+      }
+      if (context.doesServiceExist(CONFIGURATION_SERVICE_ID)) {
+        const configurationService = context.getServiceById(
+          CONFIGURATION_SERVICE_ID,
+        ) as ConfigurationService;
+        const configLocation = configurationService.configLocation;
+        if (configLocation && configLocation.length > 0) {
+          await printerService.info(`  ${printerService.secondary("config: " + configLocation)}\n`);
+        }
+      }
+      await printerService.info("\n");
+    },
+  };
+}

package/src/{service → startup}/banner/command/NoBannerCommand.ts

@@ -2,7 +2,14 @@ import type { GlobalModifierCommand } from "@flowscripter/dynamic-cli-framework-
 import { type SingleValueType, ValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
 import type { GlobalCommandArgument } from "@flowscripter/dynamic-cli-framework-api";
-import type BannerServiceProvider from "../BannerServiceProvider.ts";
+
+/**
+ * Task-local, mutable state shared between {@link NoBannerCommand} and the banner
+ * {@link StartupTask}'s `run()`, in place of a held `BannerServiceProvider` reference.
+ */
+export interface BannerState {
+  printBanner: boolean;
+}
 
 /**
  * Command to disable banner output for the CLI application.
@@ -18,15 +25,15 @@ export default class NoBannerCommand implements GlobalModifierCommand {
   };
   readonly executePriority: number;
 
-  readonly #bannerServiceProvider: BannerServiceProvider;
+  readonly #state: BannerState;
 
-  public constructor(bannerServiceProvider: BannerServiceProvider, executePriority: number) {
-    this.#bannerServiceProvider = bannerServiceProvider;
+  public constructor(state: BannerState, executePriority: number) {
+    this.#state = state;
     this.executePriority = executePriority;
   }
 
   public execute(_context: Context, argumentValue: SingleValueType): Promise<void> {
-    this.#bannerServiceProvider.printBanner = !(argumentValue as boolean);
+    this.#state.printBanner = !(argumentValue as boolean);
 
     return Promise.resolve();
   }

package/dist/src/service/banner/BannerServiceProvider.d.ts

@@ -1,29 +0,0 @@
-import type { Context } from "@flowscripter/dynamic-cli-framework-api";
-import type { ServiceInfo, ServiceProvider } from "@flowscripter/dynamic-cli-framework-api";
-import type ConfigurationServiceProvider from "../configuration/ConfigurationServiceProvider.ts";
-import type { CLIConfig } from "@flowscripter/dynamic-cli-framework-api";
-export declare const BANNER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/banner-service";
-/**
- * Provides ascii banner functionality.
- */
-export default class BannerServiceProvider implements ServiceProvider {
-    #private;
-    private readonly fontName;
-    readonly serviceId: string;
-    readonly servicePriority: number;
-    /**
-     * Whether or not to print the banner, defaults to true.
-     */
-    printBanner: boolean;
-    /**
-     * Create an instance of the service provider with the specified details.
-     *
-     * @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".
-     */
-    constructor(servicePriority: number, configurationServiceProvider?: ConfigurationServiceProvider, fontName?: string);
-    getServiceInfo(_cliConfig: CLIConfig): Promise<ServiceInfo>;
-    initService(context: Context): Promise<void>;
-}
-//# sourceMappingURL=BannerServiceProvider.d.ts.map

package/dist/src/service/banner/BannerServiceProvider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BannerServiceProvider.d.ts","sourceRoot":"","sources":["../../../../src/service/banner/BannerServiceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAI5F,OAAO,KAAK,4BAA4B,MAAM,kDAAkD,CAAC;AAGjG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAGzE,eAAO,MAAM,iBAAiB,uDAAuD,CAAC;AAEtF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,YAAW,eAAe;;IAoBjE,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAnB3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAqB;IAC/C,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAGjC;;OAEG;IACH,WAAW,UAAQ;IAEnB;;;;;;OAMG;IACH,YACE,eAAe,EAAE,MAAM,EACvB,4BAA4B,CAAC,EAAE,4BAA4B,EAC1C,QAAQ,GAAE,MAAmB,EAI/C;IAEM,cAAc,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAIjE;IAEK,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAuCjD;CACF"}

package/dist/src/service/banner/BannerServiceProvider.js

@@ -1,69 +0,0 @@
-import NoBannerCommand from "./command/NoBannerCommand.js";
-import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
-import { ASCII_BANNER_GENERATOR_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
-import { UPGRADE_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
-export const BANNER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/banner-service";
-/**
- * Provides ascii banner functionality.
- */
-export default class BannerServiceProvider {
-    fontName;
-    serviceId = BANNER_SERVICE_ID;
-    servicePriority;
-    #configurationServiceProvider;
-    /**
-     * Whether or not to print the banner, defaults to true.
-     */
-    printBanner = true;
-    /**
-     * Create an instance of the service provider with the specified details.
-     *
-     * @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".
-     */
-    constructor(servicePriority, configurationServiceProvider, fontName = "standard") {
-        this.fontName = fontName;
-        this.servicePriority = servicePriority;
-        this.#configurationServiceProvider = configurationServiceProvider;
-    }
-    getServiceInfo(_cliConfig) {
-        return Promise.resolve({
-            commands: [new NoBannerCommand(this, this.servicePriority)],
-        });
-    }
-    async initService(context) {
-        if (this.printBanner === false) {
-            return Promise.resolve();
-        }
-        const printerService = context.getServiceById(PRINTER_SERVICE_ID);
-        const asciiBannerGeneratorService = context.getServiceById(ASCII_BANNER_GENERATOR_SERVICE_ID);
-        const { cliConfig } = context;
-        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`);
-        }
-        if (cliConfig.version.length > 0) {
-            let versionLine = "version: " + cliConfig.version;
-            if (context.doesServiceExist(UPGRADE_SERVICE_ID)) {
-                const upgradeService = context.getServiceById(UPGRADE_SERVICE_ID);
-                const result = await upgradeService.getUpgradeCheckResult();
-                if (result.status === "checked" && result.updateAvailable) {
-                    versionLine += ` (${result.latestVersion} available, run '${cliConfig.name} upgrade')`;
-                }
-            }
-            await printerService.info(`  ${printerService.secondary(versionLine)}\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("\n");
-    }
-}

package/dist/src/service/banner/command/NoBannerCommand.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NoBannerCommand.d.ts","sourceRoot":"","sources":["../../../../../src/service/banner/command/NoBannerCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AACrF,OAAO,EAAE,KAAK,eAAe,EAAiB,MAAM,yCAAyC,CAAC;AAC9F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AACrF,OAAO,KAAK,qBAAqB,MAAM,6BAA6B,CAAC;AAErE;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,YAAW,qBAAqB;;IACnE,QAAQ,CAAC,IAAI,eAAe;IAC5B,QAAQ,CAAC,WAAW,8BAA8B;IAClD,QAAQ,CAAC,mBAAmB,QAAQ;IACpC,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAItC;IACF,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAIjC,YAAmB,qBAAqB,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,EAGvF;IAEM,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAI/E;CACF"}

package/src/service/banner/BannerServiceProvider.ts

@@ -1,89 +0,0 @@
-import type { Context } from "@flowscripter/dynamic-cli-framework-api";
-import type { ServiceInfo, ServiceProvider } from "@flowscripter/dynamic-cli-framework-api";
-import NoBannerCommand from "./command/NoBannerCommand.ts";
-import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
-import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
-import type ConfigurationServiceProvider from "../configuration/ConfigurationServiceProvider.ts";
-import type { AsciiBannerGeneratorService } from "@flowscripter/dynamic-cli-framework-api";
-import { ASCII_BANNER_GENERATOR_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
-import type { CLIConfig } from "@flowscripter/dynamic-cli-framework-api";
-import { UPGRADE_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
-import type { UpgradeService } from "@flowscripter/dynamic-cli-framework-api";
-export const BANNER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/banner-service";
-
-/**
- * Provides ascii banner functionality.
- */
-export default class BannerServiceProvider implements ServiceProvider {
-  readonly serviceId: string = BANNER_SERVICE_ID;
-  readonly servicePriority: number;
-  readonly #configurationServiceProvider: ConfigurationServiceProvider | undefined;
-
-  /**
-   * Whether or not to print the banner, defaults to true.
-   */
-  printBanner = true;
-
-  /**
-   * Create an instance of the service provider with the specified details.
-   *
-   * @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;
-  }
-
-  public getServiceInfo(_cliConfig: CLIConfig): Promise<ServiceInfo> {
-    return Promise.resolve({
-      commands: [new NoBannerCommand(this, this.servicePriority)],
-    });
-  }
-
-  async initService(context: Context): Promise<void> {
-    if (this.printBanner === false) {
-      return Promise.resolve();
-    }
-
-    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,
-    });
-
-    await printerService.info(printerService.blue(bannerText));
-    if (cliConfig.description !== undefined) {
-      await printerService.info(`  ${printerService.primary(cliConfig.description)}\n`);
-    }
-    if (cliConfig.version.length > 0) {
-      let versionLine = "version: " + cliConfig.version;
-      if (context.doesServiceExist(UPGRADE_SERVICE_ID)) {
-        const upgradeService = context.getServiceById(UPGRADE_SERVICE_ID) as UpgradeService;
-        const result = await upgradeService.getUpgradeCheckResult();
-        if (result.status === "checked" && result.updateAvailable) {
-          versionLine += ` (${result.latestVersion} available, run '${cliConfig.name} upgrade')`;
-        }
-      }
-      await printerService.info(`  ${printerService.secondary(versionLine)}\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("\n");
-  }
-}