@flowscripter/dynamic-cli-framework 12.0.1 → 12.2.0

package/dist/src/service/configuration/format/YamlConfigFormat.js

@@ -0,0 +1,63 @@
+import { Document, isMap, isSeq, parseDocument, stringify } from "yaml";
+function isPlainObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function reconcile(doc, path, existing, updated) {
+    if (isPlainObject(existing) && isPlainObject(updated)) {
+        for (const key of Object.keys(existing)) {
+            if (!(key in updated)) {
+                doc.deleteIn([...path, key]);
+            }
+        }
+        for (const key of Object.keys(updated)) {
+            if (key in existing) {
+                reconcile(doc, [...path, key], existing[key], updated[key]);
+            }
+            else {
+                doc.setIn([...path, key], updated[key]);
+            }
+        }
+    }
+    else if (Array.isArray(existing) &&
+        Array.isArray(updated) &&
+        existing.length === updated.length) {
+        updated.forEach((value, index) => reconcile(doc, [...path, index], existing[index], value));
+    }
+    else if (JSON.stringify(existing) !== JSON.stringify(updated)) {
+        doc.setIn(path, updated);
+    }
+}
+/**
+ * A YAML {@link ConfigFormat} which preserves comments, blank lines and key order when writing changes back.
+ *
+ * Requires the optional `yaml` peer dependency.
+ */
+const yamlFormat = {
+    fileExtension: "yaml",
+    parse(text) {
+        const doc = parseDocument(text);
+        if (doc.errors.length > 0) {
+            throw new Error(doc.errors.map((error) => error.message).join("; "));
+        }
+        const data = doc.toJS() ?? {};
+        if (!isPlainObject(data)) {
+            throw new Error("top level YAML value must be a mapping");
+        }
+        return { data, handle: doc };
+    },
+    apply(handle, changes) {
+        const doc = handle;
+        const existing = doc.toJS() ?? {};
+        if (!isMap(doc.contents) && !isSeq(doc.contents)) {
+            doc.contents = doc.createNode(changes);
+        }
+        else {
+            reconcile(doc, [], existing, changes);
+        }
+        return doc.toString();
+    },
+    serialize(data) {
+        return stringify(data);
+    },
+};
+export default yamlFormat;

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

@@ -1 +1 @@
-{"version":3,"file":"resolveSecrets.d.ts","sourceRoot":"","sources":["../../../../src/service/configuration/resolveSecrets.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,wBAA8B,cAAc,CAAC,CAAC,EAC5C,KAAK,EAAE,CAAC,EACR,aAAa,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GACzD,OAAO,CAAC,CAAC,CAAC,CAoBZ"}
+{"version":3,"file":"resolveSecrets.d.ts","sourceRoot":"","sources":["../../../../src/service/configuration/resolveSecrets.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,wBAA8B,cAAc,CAAC,CAAC,EAC5C,KAAK,EAAE,CAAC,EACR,aAAa,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GACzD,OAAO,CAAC,CAAC,CAAC,CA0BZ"}

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

@@ -23,7 +23,13 @@ export default async function resolveSecrets(value, resolveSecret) {
         }
         const resolved = {};
         for (const [key, val] of Object.entries(value)) {
-            resolved[key] = await resolveSecrets(val, resolveSecret);
+            // defineProperty so a "__proto__" key is an own property rather than replacing the prototype
+            Object.defineProperty(resolved, key, {
+                value: await resolveSecrets(val, resolveSecret),
+                enumerable: true,
+                writable: true,
+                configurable: true,
+            });
         }
         return resolved;
     }

package/dist/toml.d.ts

@@ -0,0 +1,2 @@
+export { default as tomlFormat } from "./src/service/configuration/format/TomlConfigFormat.ts";
+//# sourceMappingURL=toml.d.ts.map

package/dist/toml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toml.d.ts","sourceRoot":"","sources":["../toml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,wDAAwD,CAAC"}

package/dist/toml.js

@@ -0,0 +1 @@
+export { default as tomlFormat } from "./src/service/configuration/format/TomlConfigFormat.js";

package/dist/yaml.d.ts

@@ -0,0 +1,2 @@
+export { default as yamlFormat } from "./src/service/configuration/format/YamlConfigFormat.ts";
+//# sourceMappingURL=yaml.d.ts.map

package/dist/yaml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"yaml.d.ts","sourceRoot":"","sources":["../yaml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,wDAAwD,CAAC"}

package/dist/yaml.js

@@ -0,0 +1 @@
+export { default as yamlFormat } from "./src/service/configuration/format/YamlConfigFormat.js";

package/index.ts

@@ -68,6 +68,9 @@ export {
   default as ConfigurationServiceProvider,
   type KeyValueServiceScopeType,
 } from "./src/service/configuration/ConfigurationServiceProvider.ts";
+export type { default as ConfigFormat } from "./src/service/configuration/format/ConfigFormat.ts";
+export type { ConfigData } from "./src/service/configuration/format/ConfigFormat.ts";
+export { default as jsonFormat } from "./src/service/configuration/format/JsonConfigFormat.ts";
 export { default as KeyValueServiceProvider } from "./src/service/configuration/KeyValueServiceProvider.ts";
 
 export { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowscripter/dynamic-cli-framework",
-  "version": "12.0.1",
+  "version": "12.2.0",
   "description": "A framework for developing CLI applications which supports dynamic discovery and installation of new commands",
   "keywords": [
     "bun",
@@ -22,6 +22,8 @@
     "src",
     "index.ts",
     "cli-plugin.ts",
+    "yaml.ts",
+    "toml.ts",
     "README.md",
     "LICENSE"
   ],
@@ -40,6 +42,16 @@
       "bun": "./cli-plugin.ts",
       "types": "./dist/cli-plugin.d.ts",
       "default": "./dist/cli-plugin.js"
+    },
+    "./yaml": {
+      "bun": "./yaml.ts",
+      "types": "./dist/yaml.d.ts",
+      "default": "./dist/yaml.js"
+    },
+    "./toml": {
+      "bun": "./toml.ts",
+      "types": "./dist/toml.d.ts",
+      "default": "./dist/toml.js"
     }
   },
   "publishConfig": {
@@ -61,14 +73,26 @@
     "supports-terminal-graphics": "^0.1.0"
   },
   "devDependencies": {
+    "@decimalturn/toml-patch": "^3.3.1",
     "@types/bun": "^1.4.3",
     "@types/node": "^26.6.5",
     "@types/semver": "^7.8.0",
     "oxfmt": "0.74.0",
-    "oxlint": "1.89.0"
+    "oxlint": "1.89.0",
+    "yaml": "^2.9.1"
   },
   "peerDependencies": {
-    "typescript": "^7.0.2"
+    "@decimalturn/toml-patch": "^3.3.1",
+    "typescript": "^7.0.2",
+    "yaml": "^2.9.1"
+  },
+  "peerDependenciesMeta": {
+    "yaml": {
+      "optional": true
+    },
+    "@decimalturn/toml-patch": {
+      "optional": true
+    }
   },
   "typedocOptions": {
     "readme": "none",

package/src/cli/BaseCLI.ts

@@ -31,6 +31,7 @@ import ShutdownServiceProvider from "../service/shutdown/ShutdownServiceProvider
 import StartupServiceProvider from "../service/startup/StartupServiceProvider.ts";
 import type { StartupTask } from "@flowscripter/dynamic-cli-framework-api";
 import { shutdownState } from "../service/shutdown/ShutdownState.ts";
+import jsonFormat from "../service/configuration/format/JsonConfigFormat.ts";
 import ConfigurationServiceProvider from "../service/configuration/ConfigurationServiceProvider.ts";
 import KeyValueServiceProvider from "../service/configuration/KeyValueServiceProvider.ts";
 import PrinterServiceProvider from "../service/printer/PrinterServiceProvider.ts";
@@ -162,6 +163,7 @@ export default class BaseCLI implements CLI {
     }
     this.#cliConfig = cliConfig;
     this.#options = {
+      configFormat: jsonFormat,
       configFileSupportEnabled: false,
       envVarsSupportEnabled: false,
       keyValueServiceEnabled: false,
@@ -392,6 +394,8 @@ export default class BaseCLI implements CLI {
       this.#options.envVarsSupportEnabled,
       this.#options.configFileSupportEnabled,
       this.#options.secretServiceEnabled,
+      this.#options.configFormat,
+      this.#commandRegistry,
     );
     this.addServiceProvider(configurationServiceProvider);
     const keyValueServiceProvider = new KeyValueServiceProvider(

package/src/cli/BaseCLIFeatureOptions.ts

@@ -1,3 +1,4 @@
+import type ConfigFormat from "../service/configuration/format/ConfigFormat.ts";
 import type { UpgradeLocationsConfig } from "../service/upgrade/UpgradeLocationsConfig.ts";
 import type {
   NpmjsPluginRepositoryConfig,
@@ -6,6 +7,11 @@ import type {
 
 export default interface BaseCLIFeatureOptions {
   readonly configFileSupportEnabled?: boolean;
+  /**
+   * The syntax of the configuration file. Defaults to JSON. YAML and TOML are available from the
+   * `@flowscripter/dynamic-cli-framework/yaml` and `@flowscripter/dynamic-cli-framework/toml` entry points.
+   */
+  readonly configFormat?: ConfigFormat;
   readonly envVarsSupportEnabled?: boolean;
   readonly keyValueServiceEnabled?: boolean;
   readonly secretServiceEnabled?: boolean;

package/src/runtime/runner.ts

@@ -121,8 +121,11 @@ async function executeParsedCommand(
       parseResult!.populatedArgumentValues,
     );
 
+    const commandScopeKey = parseResult.groupCommand
+      ? `${parseResult.groupCommand.name}:${parseResult.command.name}`
+      : parseResult.command.name;
     const commandContext = keyValueServiceProvider
-      ? keyValueServiceProvider.getContextForScope(context, "command", parseResult.command.name)
+      ? keyValueServiceProvider.getContextForScope(context, "command", commandScopeKey)
       : context;
     if (isSubCommand(parseResult.command)) {
       await parseResult.command.execute(