@qui-cli/core 4.0.1 → 5.0.0

package/CHANGELOG.md

@@ -2,28 +2,47 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
-## [4.0.1](https://github.com/battis/qui-cli/compare/core/4.0.0...core/4.0.1) (2025-08-04)
+## [5.0.0](https://github.com/battis/qui-cli/compare/core/4.1.0...core/5.0.0) (2025-11-07)
+
+### ⚠ BREAKING CHANGES
+
+- group arguments by plugin in usage
+- **plugin@4.0.0** auto-document default arg values
 
+### revert
+
+- group arguments by plugin in usage ([ec3d4bf](https://github.com/battis/qui-cli/commit/ec3d4bf6ef9c59a6da3ede8603554d2dcd2581ad))
+- **plugin@4.0.0** auto-document default arg values ([e01e157](https://github.com/battis/qui-cli/commit/e01e157f06a3a801628ca79366e3f0060be2322e))
 
 ### Bug Fixes
 
-* update lagging peer dependency specs ([30c0c27](https://github.com/battis/qui-cli/commit/30c0c279d4247a69a30efef8a7426442752cd9c0))
+- merge plugin option in Plugin.Registrar, not in Core ([9a7464f](https://github.com/battis/qui-cli/commit/9a7464fab863c7a9005ade54703726cc9679c8c4))
 
-## [4.0.0](https://github.com/battis/qui-cli/compare/core/3.1.0...core/4.0.0) (2025-08-02)
+## [4.1.0](https://github.com/battis/qui-cli/compare/core/4.0.1...core/4.1.0) (2025-11-04)
 
+### Features
 
-### ⚠ BREAKING CHANGES
+- support scripting markdown documentation for commands ([03ee6d5](https://github.com/battis/qui-cli/commit/03ee6d55f86f6d7b45bd205896cb0fb6a21523b5))
 
-* rename @battis/qui-cli.core --> @qui-cli/core
+## [4.0.1](https://github.com/battis/qui-cli/compare/core/4.0.0...core/4.0.1) (2025-08-04)
+
+### Bug Fixes
+
+- update lagging peer dependency specs ([30c0c27](https://github.com/battis/qui-cli/commit/30c0c279d4247a69a30efef8a7426442752cd9c0))
+
+## [4.0.0](https://github.com/battis/qui-cli/compare/core/3.1.0...core/4.0.0) (2025-08-02)
+
+### ⚠ BREAKING CHANGES
 
-* rename @battis/qui-cli.core --> @qui-cli/core ([43367e9](https://github.com/battis/qui-cli/commit/43367e9d4316aa22fb28078e9436e6de35564f1f))
+- rename @battis/qui-cli.core --> @qui-cli/core
 
+- rename @battis/qui-cli.core --> @qui-cli/core ([43367e9](https://github.com/battis/qui-cli/commit/43367e9d4316aa22fb28078e9436e6de35564f1f))
 
 ### Bug Fixes
 
-* update dependencies to renamed @qui-cli/colors ([ff80e86](https://github.com/battis/qui-cli/commit/ff80e8625ef98834afdf04e57bfedb1906834e2b))
-* update dependencies to renamed @qui-cli/log ([1c8f0fb](https://github.com/battis/qui-cli/commit/1c8f0fbd5561b4274032382c5d10d33912956e7f))
-* update dependencies to renamed @qui-cli/plugin ([117ea85](https://github.com/battis/qui-cli/commit/117ea85256ec69c807c5b56293546d9c350fd43f))
+- update dependencies to renamed @qui-cli/colors ([ff80e86](https://github.com/battis/qui-cli/commit/ff80e8625ef98834afdf04e57bfedb1906834e2b))
+- update dependencies to renamed @qui-cli/log ([1c8f0fb](https://github.com/battis/qui-cli/commit/1c8f0fbd5561b4274032382c5d10d33912956e7f))
+- update dependencies to renamed @qui-cli/plugin ([117ea85](https://github.com/battis/qui-cli/commit/117ea85256ec69c807c5b56293546d9c350fd43f))
 
 ## [3.1.0](https://github.com/battis/qui-cli/compare/core/3.0.0...core/3.1.0) (2025-08-01)
 

package/dist/Core.d.ts

@@ -10,6 +10,5 @@ export type Configuration = Plugin.Registrar.Configuration & {
     };
 };
 export declare function configure(config?: Configuration): Promise<void>;
-export declare function options(externalOptions?: Plugin.Options): Promise<Plugin.Options>;
 export declare function init(externalOptions?: Plugin.Options): Promise<Plugin.Arguments<Plugin.Options>>;
 export declare function run(externalOptions?: Plugin.Options): Promise<Plugin.AccumulatedResults | undefined>;

package/dist/Core.js

@@ -18,14 +18,6 @@ export async function configure(config = {}) {
     }
     await Plugin.Registrar.configure({ positionals, jackspeak });
 }
-export async function options(externalOptions = {}) {
-    /*
-     * TODO automate default value documentation
-       Issue URL: https://github.com/battis/qui-cli/issues/38
-     *  Including parsing `env` (#34) and `secret` (#33) fields
-     */
-    return Plugin.mergeOptions(await Plugin.Registrar.options(), externalOptions);
-}
 export async function init(externalOptions) {
     if (initialized) {
         throw new Error(`Already initialized with user-provided command line arguments.`);
@@ -36,7 +28,7 @@ export async function init(externalOptions) {
         }
     }
     if (externalOptions) {
-        JackSpeak.args(externalOptions);
+        JackSpeak.args(Plugin.documentDefaults(externalOptions));
     }
     const args = JackSpeak.parse();
     await Plugin.Registrar.init(args);

package/dist/JackSpeak.d.ts

@@ -6,4 +6,18 @@ export declare function jack(): Jack<{}>;
 export declare function configure(config?: Configuration): void;
 export declare function args(options: Plugin.Options): void;
 export declare function parse(): import("jackspeak").Parsed<{}>;
+export declare function toJSON(): {
+    [k: string]: {
+        hint?: string | undefined;
+        default?: import("jackspeak").ConfigValue | undefined;
+        validOptions?: readonly number[] | readonly string[] | undefined;
+        validate?: ((v: unknown) => boolean) | ((v: unknown) => v is import("jackspeak").ValidValue<import("jackspeak").ConfigType, boolean>) | undefined;
+        description?: string | undefined;
+        short?: string | undefined;
+        delim?: string | undefined;
+        multiple?: boolean | undefined;
+        type: import("jackspeak").ConfigType;
+    };
+};
 export declare function usage(): string;
+export declare function usageMarkdown(): string;

package/dist/JackSpeak.js

@@ -39,6 +39,12 @@ export function args(options) {
 export function parse() {
     return jack().parse();
 }
+export function toJSON() {
+    return jack().toJSON();
+}
 export function usage() {
     return jack().usage();
 }
+export function usageMarkdown() {
+    return jack().usageMarkdown();
+}

package/dist/Positionals.d.ts

@@ -38,7 +38,7 @@ export declare function maximumUnnamedCount(): number | undefined;
 export declare function requireNoMoreThanUnnamedArgs(maxUnnamed: number): void;
 export declare function init(args: Plugin.ExpectedArguments<() => Plugin.Options>): void;
 export declare function usageArgs(): string;
-export declare function usage(usage: string): string;
+export declare function usage(usage: string, isMarkdown?: boolean): string;
 export declare function run(): void;
 export declare function get(positionalArgName: string): string | undefined;
 export declare function namedArgs(): Record<string, string | undefined>;

package/dist/Positionals.js

@@ -155,10 +155,15 @@ function wrap(text, indent) {
     })
         .join('\n');
 }
-export function usage(usage) {
-    const pre = usage.slice(0, usage.indexOf('\n') + 1);
-    const cmd = usage.slice(pre.length, usage.indexOf('\n\n'));
-    const post = usage.slice(pre.length + cmd.length);
+export function usage(usage, isMarkdown = false) {
+    let pre = usage.slice(0, usage.indexOf('\n') + 1);
+    let cmd = usage.slice(pre.length, usage.indexOf('\n\n'));
+    let post = usage.slice(pre.length + cmd.length);
+    if (isMarkdown) {
+        pre = usage.slice(0, usage.indexOf('```\n') + 4);
+        cmd = usage.slice(pre.length, usage.indexOf('\n```', pre.length));
+        post = usage.slice(pre.length + cmd.length);
+    }
     return `${pre}${wrap(`${cmd
         .split('\n')
         .map((token) => token.trim())

package/dist/Usage.d.ts

@@ -1 +1,2 @@
 export declare function usage(): string;
+export declare function usageMarkdown(): string;

package/dist/Usage.js

@@ -11,3 +11,6 @@ function commandColor(usage) {
 export function usage() {
     return Positionals.usage(commandColor(JackSpeak.usage()));
 }
+export function usageMarkdown() {
+    return Positionals.usage(JackSpeak.usageMarkdown(), true);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qui-cli/core",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "description": "Core features of @qui-cli/qui-cli",
   "homepage": "https://github.com/battis/qui-cli/tree/main/packages/core#readme",
   "repository": {
@@ -18,21 +18,20 @@
   "types": "./dist/index.d.ts",
   "dependencies": {
     "jackspeak": "^4.1.1",
-    "wrap-ansi": "^9.0.0"
+    "wrap-ansi": "^9.0.2",
+    "@qui-cli/colors": "3.1.0"
   },
   "devDependencies": {
     "@tsconfig/node20": "^20.1.6",
-    "@types/node": "^24.1.0",
-    "commit-and-tag-version": "^12.5.2",
+    "@types/node": "^24.10.0",
+    "commit-and-tag-version": "^12.6.0",
     "del-cli": "^6.0.0",
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.9.2",
-    "@qui-cli/colors": "3.0.1",
-    "@qui-cli/plugin": "3.0.0"
+    "typescript": "^5.9.3",
+    "@qui-cli/plugin": "4.0.0"
   },
   "peerDependencies": {
-    "@qui-cli/colors": "3.x",
-    "@qui-cli/plugin": "3.x"
+    "@qui-cli/plugin": "4.x"
   },
   "target": "node",
   "scripts": {