@flowscripter/dynamic-cli-framework 10.1.1 → 11.0.0

package/dist/src/service/configuration/ConfigurationServiceProvider.d.ts

@@ -13,7 +13,7 @@ export type KeyValueServiceScopeType = "command" | "service";
  * {@link KeyValueServiceProvider} (which holds a direct reference to this provider - see
  * {@link getKeyValueData} and {@link flushIfDirty} - rather than looking this provider up via
  * {@link Context}, since only {@link configLocation}/{@link setConfigLocation} are safe to expose
- * generally; {@link getConfigString} is wired directly to {@link DumpConfigCommand} for the same
+ * generally; {@link getConfigString} is wired directly to {@link ConfigDumpSubCommand} for the same
  * reason - a full config dump would leak every other command's/service's key-value data if it
  * were reachable through a general lookup).
  *

package/dist/src/service/configuration/ConfigurationServiceProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ConfigurationServiceProvider.d.ts","sourceRoot":"","sources":["../../../../src/service/configuration/ConfigurationServiceProvider.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAE5F,OAAO,KAAK,EACV,eAAe,EACf,MAAM,EACN,SAAS,EACT,eAAe,EACf,kBAAkB,EACnB,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAS5E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAOvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAQzE,MAAM,MAAM,wBAAwB,GAAG,SAAS,GAAG,SAAS,CAAC;AAkB7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoGG;AACH,MAAM,CAAC,OAAO,OAAO,4BAA6B,YAAW,eAAe;;IAC1E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAA4B;IACtD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAEjC,SAAgB,cAAc,EAAE,OAAO,CAAC;IACxC,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAGvC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAKnC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAa;IAqBvE;;;;;;;;OAQG;IACH,YACE,eAAe,EAAE,MAAM,EACvB,cAAc,UAAQ,EACtB,aAAa,UAAQ,EACrB,oBAAoB,UAAQ,EAW7B;IAEM,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAehE;IAEM,iBAAiB,CAAC,cAAc,EAAE,MAAM,QAE9C;IAED;;;;;;;;;OASG;IACU,wBAAwB,CACnC,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,OAAO,EAChB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,GAAG,kBAAkB,GAAG,SAAS,CAAC,CAsD3D;IAED;;;;;;OAMG;IACI,eAAe,CACpB,SAAS,EAAE,wBAAwB,EACnC,QAAQ,EAAE,MAAM,GACf,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAOxB;IAED;;;;;;OAMG;IACU,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAQzD;IAEY,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CA0CxD;IA4DM,eAAe,IAAI,MAAM,CAgC/B;CACF"}
+{"version":3,"file":"ConfigurationServiceProvider.d.ts","sourceRoot":"","sources":["../../../../src/service/configuration/ConfigurationServiceProvider.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAE5F,OAAO,KAAK,EACV,eAAe,EACf,MAAM,EACN,SAAS,EACT,eAAe,EACf,kBAAkB,EACnB,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAU5E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAOvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAQzE,MAAM,MAAM,wBAAwB,GAAG,SAAS,GAAG,SAAS,CAAC;AAkB7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoGG;AACH,MAAM,CAAC,OAAO,OAAO,4BAA6B,YAAW,eAAe;;IAC1E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAA4B;IACtD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAEjC,SAAgB,cAAc,EAAE,OAAO,CAAC;IACxC,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAGvC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAKnC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAa;IAqBvE;;;;;;;;OAQG;IACH,YACE,eAAe,EAAE,MAAM,EACvB,cAAc,UAAQ,EACtB,aAAa,UAAQ,EACrB,oBAAoB,UAAQ,EAW7B;IAEM,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAiBhE;IAEM,iBAAiB,CAAC,cAAc,EAAE,MAAM,QAE9C;IAED;;;;;;;;;OASG;IACU,wBAAwB,CACnC,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,OAAO,EAChB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,GAAG,kBAAkB,GAAG,SAAS,CAAC,CAsD3D;IAED;;;;;;OAMG;IACI,eAAe,CACpB,SAAS,EAAE,wBAAwB,EACnC,QAAQ,EAAE,MAAM,GACf,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAOxB;IAED;;;;;;OAMG;IACU,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAQzD;IAEY,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CA0CxD;IA4DM,eAAe,IAAI,MAAM,CAgC/B;CACF"}

package/dist/src/service/configuration/ConfigurationServiceProvider.js

@@ -4,7 +4,8 @@ import fs from "node:fs/promises";
 import { Stats } from "node:fs";
 import ConfigCommand from "./command/ConfigCommand.js";
 import getLogger from "../../util/logger.js";
-import DumpConfigCommand from "./command/DumpConfigCommand.js";
+import ConfigDumpSubCommand from "./command/ConfigDumpSubCommand.js";
+import ConfigGroupCommand from "./command/ConfigGroupCommand.js";
 import { CONFIGURATION_SERVICE_ID, SECRET_SENTINEL_PREFIX, } from "@flowscripter/dynamic-cli-framework-api";
 import DefaultSecretService from "./DefaultSecretService.js";
 import resolveSecrets from "./resolveSecrets.js";
@@ -32,7 +33,7 @@ class ConfigurationServiceImpl {
  * {@link KeyValueServiceProvider} (which holds a direct reference to this provider - see
  * {@link getKeyValueData} and {@link flushIfDirty} - rather than looking this provider up via
  * {@link Context}, since only {@link configLocation}/{@link setConfigLocation} are safe to expose
- * generally; {@link getConfigString} is wired directly to {@link DumpConfigCommand} for the same
+ * generally; {@link getConfigString} is wired directly to {@link ConfigDumpSubCommand} for the same
  * reason - a full config dump would leak every other command's/service's key-value data if it
  * were reachable through a general lookup).
  *
@@ -176,7 +177,7 @@ export default class ConfigurationServiceProvider {
         const commands = [];
         if (this.configEnabled) {
             commands.push(new ConfigCommand(this.servicePriority));
-            commands.push(new DumpConfigCommand(() => this.getConfigString()));
+            commands.push(new ConfigGroupCommand([new ConfigDumpSubCommand(() => this.getConfigString())]));
         }
         if (this.secretServiceEnabled) {
             this.#defaultsSecretService = new DefaultSecretService(cliConfig.name, "defaults");

package/dist/src/service/configuration/command/{DumpConfigCommand.d.ts → ConfigDumpSubCommand.d.ts}

@@ -1,18 +1,23 @@
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
-import type { GlobalCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { Option } from "@flowscripter/dynamic-cli-framework-api";
+import type { Positional } from "@flowscripter/dynamic-cli-framework-api";
+import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
 /**
- * Command which dumps the configuration loaded by {@link ConfigurationServiceProvider}.
+ * Member of the `config` group which dumps the configuration loaded by
+ * {@link ConfigurationServiceProvider}.
  *
  * Takes a direct reference to {@link ConfigurationServiceProvider.getConfigString}, wired by the
  * provider that constructs this command, rather than looking it up via {@link Context} -
  * deliberately, since a full config dump is not something every command/task should be able to
  * reach through a general lookup (see {@link ConfigurationService}'s doc comment).
  */
-export default class DumpConfigCommand implements GlobalCommand {
+export default class ConfigDumpSubCommand implements SubCommand {
     #private;
-    readonly name = "dump-config";
+    readonly name = "dump";
     readonly description = "Dump configuration values";
+    readonly options: ReadonlyArray<Option>;
+    readonly positionals: ReadonlyArray<Positional>;
     constructor(getConfigString: () => string);
     execute(context: Context): Promise<void>;
 }
-//# sourceMappingURL=DumpConfigCommand.d.ts.map
+//# sourceMappingURL=ConfigDumpSubCommand.d.ts.map

package/dist/src/service/configuration/command/ConfigDumpSubCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigDumpSubCommand.d.ts","sourceRoot":"","sources":["../../../../../src/service/configuration/command/ConfigDumpSubCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yCAAyC,CAAC;AACtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAC1E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAM1E;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,oBAAqB,YAAW,UAAU;;IAC7D,QAAQ,CAAC,IAAI,UAAU;IACvB,QAAQ,CAAC,WAAW,+BAA+B;IACnD,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAAM;IAC7C,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,CAAM;IAIrD,YAAmB,eAAe,EAAE,MAAM,MAAM,EAE/C;IAEY,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CASpD;CACF"}

package/dist/src/service/configuration/command/{DumpConfigCommand.js → ConfigDumpSubCommand.js}

@@ -1,16 +1,19 @@
 import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import { SYNTAX_HIGHLIGHTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 /**
- * Command which dumps the configuration loaded by {@link ConfigurationServiceProvider}.
+ * Member of the `config` group which dumps the configuration loaded by
+ * {@link ConfigurationServiceProvider}.
  *
  * Takes a direct reference to {@link ConfigurationServiceProvider.getConfigString}, wired by the
  * provider that constructs this command, rather than looking it up via {@link Context} -
  * deliberately, since a full config dump is not something every command/task should be able to
  * reach through a general lookup (see {@link ConfigurationService}'s doc comment).
  */
-export default class DumpConfigCommand {
-    name = "dump-config";
+export default class ConfigDumpSubCommand {
+    name = "dump";
     description = "Dump configuration values";
+    options = [];
+    positionals = [];
     #getConfigString;
     constructor(getConfigString) {
         this.#getConfigString = getConfigString;

package/dist/src/service/configuration/command/ConfigGroupCommand.d.ts

@@ -0,0 +1,16 @@
+import type { Context } from "@flowscripter/dynamic-cli-framework-api";
+import type { GroupCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
+/**
+ * Group command named `config` whose members manage the configuration handled by
+ * {@link ConfigurationServiceProvider}.
+ */
+export default class ConfigGroupCommand implements GroupCommand {
+    readonly name = "config";
+    readonly description = "Manage configuration";
+    readonly enableConfiguration = false;
+    readonly memberSubCommands: ReadonlyArray<SubCommand>;
+    constructor(memberSubCommands: ReadonlyArray<SubCommand>);
+    execute(_context: Context): Promise<void>;
+}
+//# sourceMappingURL=ConfigGroupCommand.d.ts.map

package/dist/src/service/configuration/command/ConfigGroupCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigGroupCommand.d.ts","sourceRoot":"","sources":["../../../../../src/service/configuration/command/ConfigGroupCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAE1E;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,YAAW,YAAY;IAC7D,QAAQ,CAAC,IAAI,YAAY;IACzB,QAAQ,CAAC,WAAW,0BAA0B;IAC9C,QAAQ,CAAC,mBAAmB,SAAS;IACrC,QAAQ,CAAC,iBAAiB,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IAEtD,YAAmB,iBAAiB,EAAE,aAAa,CAAC,UAAU,CAAC,EAE9D;IAEY,OAAO,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAG;CAC1D"}

package/dist/src/service/configuration/command/ConfigGroupCommand.js

@@ -0,0 +1,14 @@
+/**
+ * Group command named `config` whose members manage the configuration handled by
+ * {@link ConfigurationServiceProvider}.
+ */
+export default class ConfigGroupCommand {
+    name = "config";
+    description = "Manage configuration";
+    enableConfiguration = false;
+    memberSubCommands;
+    constructor(memberSubCommands) {
+        this.memberSubCommands = memberSubCommands;
+    }
+    async execute(_context) { }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowscripter/dynamic-cli-framework",
-  "version": "10.1.1",
+  "version": "11.0.0",
   "description": "A framework for developing CLI applications which supports dynamic discovery and installation of new commands",
   "keywords": [
     "bun",

package/src/service/configuration/ConfigurationServiceProvider.ts

@@ -14,7 +14,8 @@ import type {
 import getLogger from "../../util/logger.ts";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
 import type { GroupCommand } from "@flowscripter/dynamic-cli-framework-api";
-import DumpConfigCommand from "./command/DumpConfigCommand.ts";
+import ConfigDumpSubCommand from "./command/ConfigDumpSubCommand.ts";
+import ConfigGroupCommand from "./command/ConfigGroupCommand.ts";
 import {
   CONFIGURATION_SERVICE_ID,
   SECRET_SENTINEL_PREFIX,
@@ -63,7 +64,7 @@ class ConfigurationServiceImpl implements ConfigurationService {
  * {@link KeyValueServiceProvider} (which holds a direct reference to this provider - see
  * {@link getKeyValueData} and {@link flushIfDirty} - rather than looking this provider up via
  * {@link Context}, since only {@link configLocation}/{@link setConfigLocation} are safe to expose
- * generally; {@link getConfigString} is wired directly to {@link DumpConfigCommand} for the same
+ * generally; {@link getConfigString} is wired directly to {@link ConfigDumpSubCommand} for the same
  * reason - a full config dump would leak every other command's/service's key-value data if it
  * were reachable through a general lookup).
  *
@@ -222,7 +223,9 @@ export default class ConfigurationServiceProvider implements ServiceProvider {
 
     if (this.configEnabled) {
       commands.push(new ConfigCommand(this.servicePriority));
-      commands.push(new DumpConfigCommand(() => this.getConfigString()));
+      commands.push(
+        new ConfigGroupCommand([new ConfigDumpSubCommand(() => this.getConfigString())]),
+      );
     }
     if (this.secretServiceEnabled) {
       this.#defaultsSecretService = new DefaultSecretService(cliConfig.name, "defaults");

package/src/service/configuration/command/{DumpConfigCommand.ts → ConfigDumpSubCommand.ts}

@@ -1,21 +1,26 @@
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
-import type { GlobalCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { Option } from "@flowscripter/dynamic-cli-framework-api";
+import type { Positional } from "@flowscripter/dynamic-cli-framework-api";
+import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
 import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
 import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import type { SyntaxHighlighterService } from "@flowscripter/dynamic-cli-framework-api";
 import { SYNTAX_HIGHLIGHTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 
 /**
- * Command which dumps the configuration loaded by {@link ConfigurationServiceProvider}.
+ * Member of the `config` group which dumps the configuration loaded by
+ * {@link ConfigurationServiceProvider}.
  *
  * Takes a direct reference to {@link ConfigurationServiceProvider.getConfigString}, wired by the
  * provider that constructs this command, rather than looking it up via {@link Context} -
  * deliberately, since a full config dump is not something every command/task should be able to
  * reach through a general lookup (see {@link ConfigurationService}'s doc comment).
  */
-export default class DumpConfigCommand implements GlobalCommand {
-  readonly name = "dump-config";
+export default class ConfigDumpSubCommand implements SubCommand {
+  readonly name = "dump";
   readonly description = "Dump configuration values";
+  readonly options: ReadonlyArray<Option> = [];
+  readonly positionals: ReadonlyArray<Positional> = [];
 
   readonly #getConfigString: () => string;
 

package/src/service/configuration/command/ConfigGroupCommand.ts

@@ -0,0 +1,20 @@
+import type { Context } from "@flowscripter/dynamic-cli-framework-api";
+import type { GroupCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
+
+/**
+ * Group command named `config` whose members manage the configuration handled by
+ * {@link ConfigurationServiceProvider}.
+ */
+export default class ConfigGroupCommand implements GroupCommand {
+  readonly name = "config";
+  readonly description = "Manage configuration";
+  readonly enableConfiguration = false;
+  readonly memberSubCommands: ReadonlyArray<SubCommand>;
+
+  public constructor(memberSubCommands: ReadonlyArray<SubCommand>) {
+    this.memberSubCommands = memberSubCommands;
+  }
+
+  public async execute(_context: Context): Promise<void> {}
+}

package/dist/src/service/configuration/command/DumpConfigCommand.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DumpConfigCommand.d.ts","sourceRoot":"","sources":["../../../../../src/service/configuration/command/DumpConfigCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAM7E;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAkB,YAAW,aAAa;;IAC7D,QAAQ,CAAC,IAAI,iBAAiB;IAC9B,QAAQ,CAAC,WAAW,+BAA+B;IAInD,YAAmB,eAAe,EAAE,MAAM,MAAM,EAE/C;IAEY,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CASpD;CACF"}