@optique/core 0.7.11 → 0.7.12

package/dist/constructs.cjs

@@ -193,7 +193,9 @@ function or(...args) {
 			});
 		},
 		getDocFragments(state, _defaultValue) {
+			let brief;
 			let description;
+			let footer;
 			let fragments;
 			if (state.kind === "unavailable" || state.state == null) fragments = parsers.flatMap((p) => p.getDocFragments({ kind: "unavailable" }, void 0).fragments);
 			else {
@@ -203,7 +205,9 @@ function or(...args) {
 					state: parserResult.next.state
 				} : { kind: "unavailable" };
 				const docFragments = parsers[index].getDocFragments(innerState, void 0);
+				brief = docFragments.brief;
 				description = docFragments.description;
+				footer = docFragments.footer;
 				fragments = docFragments.fragments;
 			}
 			const entries = fragments.filter((f) => f.type === "entry");
@@ -214,7 +218,9 @@ function or(...args) {
 				else sections.push(fragment);
 			}
 			return {
+				brief,
 				description,
+				footer,
 				fragments: [...sections.map((s) => ({
 					...s,
 					type: "section"
@@ -337,6 +343,7 @@ function longestMatch(...args) {
 			});
 		},
 		getDocFragments(state, _defaultValue) {
+			let brief;
 			let description;
 			let footer;
 			let fragments;
@@ -348,12 +355,14 @@ function longestMatch(...args) {
 						kind: "available",
 						state: result.next.state
 					});
+					brief = docResult.brief;
 					description = docResult.description;
 					footer = docResult.footer;
 					fragments = docResult.fragments;
 				} else fragments = parsers.flatMap((p) => p.getDocFragments({ kind: "unavailable" }).fragments);
 			}
 			return {
+				brief,
 				description,
 				fragments,
 				footer

package/dist/constructs.js

@@ -193,7 +193,9 @@ function or(...args) {
 			});
 		},
 		getDocFragments(state, _defaultValue) {
+			let brief;
 			let description;
+			let footer;
 			let fragments;
 			if (state.kind === "unavailable" || state.state == null) fragments = parsers.flatMap((p) => p.getDocFragments({ kind: "unavailable" }, void 0).fragments);
 			else {
@@ -203,7 +205,9 @@ function or(...args) {
 					state: parserResult.next.state
 				} : { kind: "unavailable" };
 				const docFragments = parsers[index].getDocFragments(innerState, void 0);
+				brief = docFragments.brief;
 				description = docFragments.description;
+				footer = docFragments.footer;
 				fragments = docFragments.fragments;
 			}
 			const entries = fragments.filter((f) => f.type === "entry");
@@ -214,7 +218,9 @@ function or(...args) {
 				else sections.push(fragment);
 			}
 			return {
+				brief,
 				description,
+				footer,
 				fragments: [...sections.map((s) => ({
 					...s,
 					type: "section"
@@ -337,6 +343,7 @@ function longestMatch(...args) {
 			});
 		},
 		getDocFragments(state, _defaultValue) {
+			let brief;
 			let description;
 			let footer;
 			let fragments;
@@ -348,12 +355,14 @@ function longestMatch(...args) {
 						kind: "available",
 						state: result.next.state
 					});
+					brief = docResult.brief;
 					description = docResult.description;
 					footer = docResult.footer;
 					fragments = docResult.fragments;
 				} else fragments = parsers.flatMap((p) => p.getDocFragments({ kind: "unavailable" }).fragments);
 			}
 			return {
+				brief,
 				description,
 				fragments,
 				footer

package/dist/doc.d.cts

@@ -60,6 +60,12 @@ type DocFragment = {
  * a final document page.
  */
 interface DocFragments {
+  /**
+   * An optional brief that provides a short summary for the collection
+   * of fragments.
+   * @since 0.7.12
+   */
+  readonly brief?: Message;
   /**
    * An optional description that applies to the entire collection of fragments.
    */

package/dist/doc.d.ts

@@ -60,6 +60,12 @@ type DocFragment = {
  * a final document page.
  */
 interface DocFragments {
+  /**
+   * An optional brief that provides a short summary for the collection
+   * of fragments.
+   * @since 0.7.12
+   */
+  readonly brief?: Message;
   /**
    * An optional description that applies to the entire collection of fragments.
    */

package/dist/facade.cjs

@@ -561,11 +561,13 @@ function run(parser, programName, args, options = {}) {
 			const doc = require_parser.getDocPage(helpGeneratorParser, classified.commands);
 			if (doc != null) {
 				const isMetaCommandHelp = (completionName === "singular" || completionName === "both" ? requestedCommand === "completion" : false) || (completionName === "plural" || completionName === "both" ? requestedCommand === "completions" : false) || requestedCommand === "help" || requestedCommand === "version";
+				const isSubcommandHelp = classified.commands.length > 0;
+				const shouldOverride = !isMetaCommandHelp && !isSubcommandHelp;
 				const augmentedDoc = {
 					...doc,
-					brief: !isMetaCommandHelp ? brief ?? doc.brief : doc.brief,
-					description: !isMetaCommandHelp ? description ?? doc.description : doc.description,
-					footer: !isMetaCommandHelp ? footer ?? doc.footer : doc.footer
+					brief: shouldOverride ? brief ?? doc.brief : doc.brief ?? brief,
+					description: shouldOverride ? description ?? doc.description : doc.description ?? description,
+					footer: shouldOverride ? footer ?? doc.footer : doc.footer ?? footer
 				};
 				stdout(require_doc.formatDocPage(programName, augmentedDoc, {
 					colors,

package/dist/facade.js

@@ -561,11 +561,13 @@ function run(parser, programName, args, options = {}) {
 			const doc = getDocPage(helpGeneratorParser, classified.commands);
 			if (doc != null) {
 				const isMetaCommandHelp = (completionName === "singular" || completionName === "both" ? requestedCommand === "completion" : false) || (completionName === "plural" || completionName === "both" ? requestedCommand === "completions" : false) || requestedCommand === "help" || requestedCommand === "version";
+				const isSubcommandHelp = classified.commands.length > 0;
+				const shouldOverride = !isMetaCommandHelp && !isSubcommandHelp;
 				const augmentedDoc = {
 					...doc,
-					brief: !isMetaCommandHelp ? brief ?? doc.brief : doc.brief,
-					description: !isMetaCommandHelp ? description ?? doc.description : doc.description,
-					footer: !isMetaCommandHelp ? footer ?? doc.footer : doc.footer
+					brief: shouldOverride ? brief ?? doc.brief : doc.brief ?? brief,
+					description: shouldOverride ? description ?? doc.description : doc.description ?? description,
+					footer: shouldOverride ? footer ?? doc.footer : doc.footer ?? footer
 				};
 				stdout(formatDocPage(programName, augmentedDoc, {
 					colors,

package/dist/parser.cjs

@@ -159,7 +159,7 @@ function getDocPage(parser, args = []) {
 		if (!result.success) break;
 		context = result.next;
 	} while (context.buffer.length > 0);
-	const { description, fragments, footer } = parser.getDocFragments({
+	const { brief, description, fragments, footer } = parser.getDocFragments({
 		kind: "available",
 		state: context.state
 	}, void 0);
@@ -184,6 +184,7 @@ function getDocPage(parser, args = []) {
 	return {
 		usage,
 		sections,
+		...brief != null && { brief },
 		...description != null && { description },
 		...footer != null && { footer }
 	};

package/dist/parser.js

@@ -159,7 +159,7 @@ function getDocPage(parser, args = []) {
 		if (!result.success) break;
 		context = result.next;
 	} while (context.buffer.length > 0);
-	const { description, fragments, footer } = parser.getDocFragments({
+	const { brief, description, fragments, footer } = parser.getDocFragments({
 		kind: "available",
 		state: context.state
 	}, void 0);
@@ -184,6 +184,7 @@ function getDocPage(parser, args = []) {
 	return {
 		usage,
 		sections,
+		...brief != null && { brief },
 		...description != null && { description },
 		...footer != null && { footer }
 	};

package/dist/primitives.cjs

@@ -725,6 +725,7 @@ function command(name, parser, options = {}) {
 			const innerFragments = parser.getDocFragments(innerState, defaultValue);
 			return {
 				...innerFragments,
+				brief: innerFragments.brief ?? options.brief,
 				description: innerFragments.description ?? options.description,
 				footer: innerFragments.footer ?? options.footer
 			};

package/dist/primitives.js

@@ -725,6 +725,7 @@ function command(name, parser, options = {}) {
 			const innerFragments = parser.getDocFragments(innerState, defaultValue);
 			return {
 				...innerFragments,
+				brief: innerFragments.brief ?? options.brief,
 				description: innerFragments.description ?? options.description,
 				footer: innerFragments.footer ?? options.footer
 			};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/core",
-  "version": "0.7.11",
+  "version": "0.7.12",
   "description": "Type-safe combinatorial command-line interface parser",
   "keywords": [
     "CLI",