@optique/core 0.9.3 → 0.9.5

package/dist/constructs.cjs

@@ -4,6 +4,57 @@ const require_suggestion = require('./suggestion.cjs');
 
 //#region src/constructs.ts
 /**
+* Collects option names and command names that are valid at the current
+* parse position by walking the usage tree.  Only "leading" candidates
+* (those reachable before a required positional argument) are collected.
+*/
+function collectLeadingCandidates(terms, optionNames, commandNames) {
+	if (!terms || !Array.isArray(terms)) return true;
+	for (const term of terms) {
+		if (term.type === "option") {
+			for (const name of term.names) optionNames.add(name);
+			return false;
+		}
+		if (term.type === "command") {
+			commandNames.add(term.name);
+			return false;
+		}
+		if (term.type === "argument") return false;
+		if (term.type === "optional") {
+			collectLeadingCandidates(term.terms, optionNames, commandNames);
+			continue;
+		}
+		if (term.type === "multiple") {
+			collectLeadingCandidates(term.terms, optionNames, commandNames);
+			if (term.min === 0) continue;
+			return false;
+		}
+		if (term.type === "exclusive") {
+			let allAlternativesSkippable = true;
+			for (const exclusiveUsage of term.terms) {
+				const alternativeSkippable = collectLeadingCandidates(exclusiveUsage, optionNames, commandNames);
+				allAlternativesSkippable = allAlternativesSkippable && alternativeSkippable;
+			}
+			if (allAlternativesSkippable) continue;
+			return false;
+		}
+	}
+	return true;
+}
+function createUnexpectedInputErrorWithScopedSuggestions(baseError, invalidInput, parsers, customFormatter) {
+	const options = /* @__PURE__ */ new Set();
+	const commands = /* @__PURE__ */ new Set();
+	for (const parser of parsers) collectLeadingCandidates(parser.usage, options, commands);
+	const candidates = new Set([...options, ...commands]);
+	const suggestions = require_suggestion.findSimilar(invalidInput, candidates, require_suggestion.DEFAULT_FIND_SIMILAR_OPTIONS);
+	const suggestionMsg = customFormatter ? customFormatter(suggestions) : require_suggestion.createSuggestionMessage(suggestions);
+	return suggestionMsg.length > 0 ? [
+		...baseError,
+		require_message.text("\n\n"),
+		...suggestionMsg
+	] : baseError;
+}
+/**
 * Checks if the given token is an option name that requires a value
 * (i.e., has a metavar) within the given usage terms.
 * @param usage The usage terms to search through.
@@ -202,16 +253,6 @@ function getNoMatchError(options, noMatchContext) {
 	return customNoMatch ? typeof customNoMatch === "function" ? customNoMatch(noMatchContext) : customNoMatch : generateNoMatchError(noMatchContext);
 }
 /**
-* Creates default error for parse() method when buffer is not empty.
-* Shared by or() and longestMatch().
-* @internal
-*/
-function createUnexpectedInputError(token, usage, options) {
-	const defaultMsg = require_message.message`Unexpected option or subcommand: ${require_message.optionName(token)}.`;
-	if (options?.errors?.unexpectedInput != null) return typeof options.errors.unexpectedInput === "function" ? options.errors.unexpectedInput(token) : options.errors.unexpectedInput;
-	return require_suggestion.createErrorWithSuggestions(defaultMsg, token, usage, "both", options?.errors?.suggestions);
-}
-/**
 * @since 0.5.0
 */
 function or(...args) {
@@ -230,7 +271,12 @@ function or(...args) {
 	const syncParsers = parsers;
 	const getInitialError = (context) => ({
 		consumed: 0,
-		error: context.buffer.length < 1 ? getNoMatchError(options, noMatchContext) : createUnexpectedInputError(context.buffer[0], context.usage, options)
+		error: context.buffer.length < 1 ? getNoMatchError(options, noMatchContext) : (() => {
+			const token = context.buffer[0];
+			const defaultMsg = require_message.message`Unexpected option or subcommand: ${require_message.optionName(token)}.`;
+			if (options?.errors?.unexpectedInput != null) return typeof options.errors.unexpectedInput === "function" ? options.errors.unexpectedInput(token) : options.errors.unexpectedInput;
+			return createUnexpectedInputErrorWithScopedSuggestions(defaultMsg, token, parsers, options?.errors?.suggestions);
+		})()
 	});
 	const parseSync = (context) => {
 		let error = getInitialError(context);
@@ -314,7 +360,9 @@ function or(...args) {
 		},
 		suggest: createExclusiveSuggest(parsers, isAsync),
 		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 {
@@ -324,7 +372,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");
@@ -335,7 +385,9 @@ function or(...args) {
 				else sections.push(fragment);
 			}
 			return {
+				brief,
 				description,
+				footer,
 				fragments: [...sections.map((s) => ({
 					...s,
 					type: "section"
@@ -366,7 +418,12 @@ function longestMatch(...args) {
 	const syncParsers = parsers;
 	const getInitialError = (context) => ({
 		consumed: 0,
-		error: context.buffer.length < 1 ? getNoMatchError(options, noMatchContext) : createUnexpectedInputError(context.buffer[0], context.usage, options)
+		error: context.buffer.length < 1 ? getNoMatchError(options, noMatchContext) : (() => {
+			const token = context.buffer[0];
+			const defaultMsg = require_message.message`Unexpected option or subcommand: ${require_message.optionName(token)}.`;
+			if (options?.errors?.unexpectedInput != null) return typeof options.errors.unexpectedInput === "function" ? options.errors.unexpectedInput(token) : options.errors.unexpectedInput;
+			return createUnexpectedInputErrorWithScopedSuggestions(defaultMsg, token, parsers, options?.errors?.suggestions);
+		})()
 	});
 	const parseSync = (context) => {
 		let bestMatch = null;
@@ -452,6 +509,7 @@ function longestMatch(...args) {
 		},
 		suggest: createExclusiveSuggest(parsers, isAsync),
 		getDocFragments(state, _defaultValue) {
+			let brief;
 			let description;
 			let footer;
 			let fragments;
@@ -463,12 +521,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

@@ -1,9 +1,60 @@
-import { message, optionName, values } from "./message.js";
+import { message, optionName, text, values } from "./message.js";
 import { extractArgumentMetavars, extractCommandNames, extractOptionNames } from "./usage.js";
-import { createErrorWithSuggestions, deduplicateSuggestions } from "./suggestion.js";
+import { DEFAULT_FIND_SIMILAR_OPTIONS, createErrorWithSuggestions, createSuggestionMessage, deduplicateSuggestions, findSimilar } from "./suggestion.js";
 
 //#region src/constructs.ts
 /**
+* Collects option names and command names that are valid at the current
+* parse position by walking the usage tree.  Only "leading" candidates
+* (those reachable before a required positional argument) are collected.
+*/
+function collectLeadingCandidates(terms, optionNames, commandNames) {
+	if (!terms || !Array.isArray(terms)) return true;
+	for (const term of terms) {
+		if (term.type === "option") {
+			for (const name of term.names) optionNames.add(name);
+			return false;
+		}
+		if (term.type === "command") {
+			commandNames.add(term.name);
+			return false;
+		}
+		if (term.type === "argument") return false;
+		if (term.type === "optional") {
+			collectLeadingCandidates(term.terms, optionNames, commandNames);
+			continue;
+		}
+		if (term.type === "multiple") {
+			collectLeadingCandidates(term.terms, optionNames, commandNames);
+			if (term.min === 0) continue;
+			return false;
+		}
+		if (term.type === "exclusive") {
+			let allAlternativesSkippable = true;
+			for (const exclusiveUsage of term.terms) {
+				const alternativeSkippable = collectLeadingCandidates(exclusiveUsage, optionNames, commandNames);
+				allAlternativesSkippable = allAlternativesSkippable && alternativeSkippable;
+			}
+			if (allAlternativesSkippable) continue;
+			return false;
+		}
+	}
+	return true;
+}
+function createUnexpectedInputErrorWithScopedSuggestions(baseError, invalidInput, parsers, customFormatter) {
+	const options = /* @__PURE__ */ new Set();
+	const commands = /* @__PURE__ */ new Set();
+	for (const parser of parsers) collectLeadingCandidates(parser.usage, options, commands);
+	const candidates = new Set([...options, ...commands]);
+	const suggestions = findSimilar(invalidInput, candidates, DEFAULT_FIND_SIMILAR_OPTIONS);
+	const suggestionMsg = customFormatter ? customFormatter(suggestions) : createSuggestionMessage(suggestions);
+	return suggestionMsg.length > 0 ? [
+		...baseError,
+		text("\n\n"),
+		...suggestionMsg
+	] : baseError;
+}
+/**
 * Checks if the given token is an option name that requires a value
 * (i.e., has a metavar) within the given usage terms.
 * @param usage The usage terms to search through.
@@ -202,16 +253,6 @@ function getNoMatchError(options, noMatchContext) {
 	return customNoMatch ? typeof customNoMatch === "function" ? customNoMatch(noMatchContext) : customNoMatch : generateNoMatchError(noMatchContext);
 }
 /**
-* Creates default error for parse() method when buffer is not empty.
-* Shared by or() and longestMatch().
-* @internal
-*/
-function createUnexpectedInputError(token, usage, options) {
-	const defaultMsg = message`Unexpected option or subcommand: ${optionName(token)}.`;
-	if (options?.errors?.unexpectedInput != null) return typeof options.errors.unexpectedInput === "function" ? options.errors.unexpectedInput(token) : options.errors.unexpectedInput;
-	return createErrorWithSuggestions(defaultMsg, token, usage, "both", options?.errors?.suggestions);
-}
-/**
 * @since 0.5.0
 */
 function or(...args) {
@@ -230,7 +271,12 @@ function or(...args) {
 	const syncParsers = parsers;
 	const getInitialError = (context) => ({
 		consumed: 0,
-		error: context.buffer.length < 1 ? getNoMatchError(options, noMatchContext) : createUnexpectedInputError(context.buffer[0], context.usage, options)
+		error: context.buffer.length < 1 ? getNoMatchError(options, noMatchContext) : (() => {
+			const token = context.buffer[0];
+			const defaultMsg = message`Unexpected option or subcommand: ${optionName(token)}.`;
+			if (options?.errors?.unexpectedInput != null) return typeof options.errors.unexpectedInput === "function" ? options.errors.unexpectedInput(token) : options.errors.unexpectedInput;
+			return createUnexpectedInputErrorWithScopedSuggestions(defaultMsg, token, parsers, options?.errors?.suggestions);
+		})()
 	});
 	const parseSync = (context) => {
 		let error = getInitialError(context);
@@ -314,7 +360,9 @@ function or(...args) {
 		},
 		suggest: createExclusiveSuggest(parsers, isAsync),
 		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 {
@@ -324,7 +372,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");
@@ -335,7 +385,9 @@ function or(...args) {
 				else sections.push(fragment);
 			}
 			return {
+				brief,
 				description,
+				footer,
 				fragments: [...sections.map((s) => ({
 					...s,
 					type: "section"
@@ -366,7 +418,12 @@ function longestMatch(...args) {
 	const syncParsers = parsers;
 	const getInitialError = (context) => ({
 		consumed: 0,
-		error: context.buffer.length < 1 ? getNoMatchError(options, noMatchContext) : createUnexpectedInputError(context.buffer[0], context.usage, options)
+		error: context.buffer.length < 1 ? getNoMatchError(options, noMatchContext) : (() => {
+			const token = context.buffer[0];
+			const defaultMsg = message`Unexpected option or subcommand: ${optionName(token)}.`;
+			if (options?.errors?.unexpectedInput != null) return typeof options.errors.unexpectedInput === "function" ? options.errors.unexpectedInput(token) : options.errors.unexpectedInput;
+			return createUnexpectedInputErrorWithScopedSuggestions(defaultMsg, token, parsers, options?.errors?.suggestions);
+		})()
 	});
 	const parseSync = (context) => {
 		let bestMatch = null;
@@ -452,6 +509,7 @@ function longestMatch(...args) {
 		},
 		suggest: createExclusiveSuggest(parsers, isAsync),
 		getDocFragments(state, _defaultValue) {
+			let brief;
 			let description;
 			let footer;
 			let fragments;
@@ -463,12 +521,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

@@ -455,9 +455,9 @@ function runParser(parser, programName, args, options = {}) {
 			} else {
 				const singularMatchExact = completionName === "singular" || completionName === "both" ? arg === "--completion" : false;
 				const pluralMatchExact = completionName === "plural" || completionName === "both" ? arg === "--completions" : false;
-				if ((singularMatchExact || pluralMatchExact) && i + 1 < args.length) {
-					const shell = args[i + 1];
-					const completionArgs = args.slice(i + 2);
+				if (singularMatchExact || pluralMatchExact) {
+					const shell = i + 1 < args.length ? args[i + 1] : "";
+					const completionArgs = i + 1 < args.length ? args.slice(i + 2) : [];
 					return handleCompletion([shell, ...completionArgs], programName, parser, completionParsers.completionCommand, stdout, stderr, onCompletion, onError, availableShells, colors, maxWidth, completionMode, completionName);
 				}
 			}
@@ -556,11 +556,13 @@ function runParser(parser, programName, args, options = {}) {
 				const displayHelp = (doc) => {
 					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

@@ -455,9 +455,9 @@ function runParser(parser, programName, args, options = {}) {
 			} else {
 				const singularMatchExact = completionName === "singular" || completionName === "both" ? arg === "--completion" : false;
 				const pluralMatchExact = completionName === "plural" || completionName === "both" ? arg === "--completions" : false;
-				if ((singularMatchExact || pluralMatchExact) && i + 1 < args.length) {
-					const shell = args[i + 1];
-					const completionArgs = args.slice(i + 2);
+				if (singularMatchExact || pluralMatchExact) {
+					const shell = i + 1 < args.length ? args[i + 1] : "";
+					const completionArgs = i + 1 < args.length ? args.slice(i + 2) : [];
 					return handleCompletion([shell, ...completionArgs], programName, parser, completionParsers.completionCommand, stdout, stderr, onCompletion, onError, availableShells, colors, maxWidth, completionMode, completionName);
 				}
 			}
@@ -556,11 +556,13 @@ function runParser(parser, programName, args, options = {}) {
 				const displayHelp = (doc) => {
 					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

@@ -337,7 +337,7 @@ async function getDocPageAsyncImpl(parser, args) {
 * Shared by both sync and async implementations.
 */
 function buildDocPage(parser, context, args) {
-	const { description, fragments, footer } = parser.getDocFragments({
+	const { brief, description, fragments, footer } = parser.getDocFragments({
 		kind: "available",
 		state: context.state
 	}, void 0);
@@ -363,6 +363,7 @@ function buildDocPage(parser, context, args) {
 	return {
 		usage,
 		sections,
+		...brief != null && { brief },
 		...description != null && { description },
 		...footer != null && { footer }
 	};

package/dist/parser.js

@@ -337,7 +337,7 @@ async function getDocPageAsyncImpl(parser, args) {
 * Shared by both sync and async implementations.
 */
 function buildDocPage(parser, context, args) {
-	const { description, fragments, footer } = parser.getDocFragments({
+	const { brief, description, fragments, footer } = parser.getDocFragments({
 		kind: "available",
 		state: context.state
 	}, void 0);
@@ -363,6 +363,7 @@ function buildDocPage(parser, context, args) {
 	return {
 		usage,
 		sections,
+		...brief != null && { brief },
 		...description != null && { description },
 		...footer != null && { footer }
 	};

package/dist/primitives.cjs

@@ -867,6 +867,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

@@ -867,6 +867,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/suggestion.cjs

@@ -232,5 +232,6 @@ function deduplicateSuggestions(suggestions) {
 //#endregion
 exports.DEFAULT_FIND_SIMILAR_OPTIONS = DEFAULT_FIND_SIMILAR_OPTIONS;
 exports.createErrorWithSuggestions = createErrorWithSuggestions;
+exports.createSuggestionMessage = createSuggestionMessage;
 exports.deduplicateSuggestions = deduplicateSuggestions;
 exports.findSimilar = findSimilar;

package/dist/suggestion.js

@@ -230,4 +230,4 @@ function deduplicateSuggestions(suggestions) {
 }
 
 //#endregion
-export { DEFAULT_FIND_SIMILAR_OPTIONS, createErrorWithSuggestions, deduplicateSuggestions, findSimilar };
+export { DEFAULT_FIND_SIMILAR_OPTIONS, createErrorWithSuggestions, createSuggestionMessage, deduplicateSuggestions, findSimilar };

package/package.json

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