@optique/core 0.7.12 → 0.7.13-dev.361

package/dist/constructs.cjs

@@ -24,6 +24,52 @@ function isOptionRequiringValue(usage, token) {
 	}
 	return traverse(usage);
 }
+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;
+}
 /**
 * Extracts required (non-optional) usage terms from a usage array.
 * @param usage The usage to extract required terms from
@@ -132,7 +178,7 @@ function or(...args) {
 					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 require_suggestion.createErrorWithSuggestions(defaultMsg, token, context.usage, "both", options?.errors?.suggestions);
+					return createUnexpectedInputErrorWithScopedSuggestions(defaultMsg, token, parsers, options?.errors?.suggestions);
 				})()
 			};
 			const orderedParsers = parsers.map((p, i) => [p, i]);
@@ -282,7 +328,7 @@ function longestMatch(...args) {
 					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 require_suggestion.createErrorWithSuggestions(defaultMsg, token, context.usage, "both", options?.errors?.suggestions);
+					return createUnexpectedInputErrorWithScopedSuggestions(defaultMsg, token, parsers, options?.errors?.suggestions);
 				})()
 			};
 			for (let i = 0; i < parsers.length; i++) {

package/dist/constructs.js

@@ -1,6 +1,6 @@
-import { message, optionName, values } from "./message.js";
+import { message, optionName, text, values } from "./message.js";
 import { extractArgumentMetavars, extractCommandNames, extractOptionNames } from "./usage.js";
-import { createErrorWithSuggestions } from "./suggestion.js";
+import { DEFAULT_FIND_SIMILAR_OPTIONS, createErrorWithSuggestions, createSuggestionMessage, findSimilar } from "./suggestion.js";
 
 //#region src/constructs.ts
 /**
@@ -24,6 +24,52 @@ function isOptionRequiringValue(usage, token) {
 	}
 	return traverse(usage);
 }
+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;
+}
 /**
 * Extracts required (non-optional) usage terms from a usage array.
 * @param usage The usage to extract required terms from
@@ -132,7 +178,7 @@ function or(...args) {
 					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 createErrorWithSuggestions(defaultMsg, token, context.usage, "both", options?.errors?.suggestions);
+					return createUnexpectedInputErrorWithScopedSuggestions(defaultMsg, token, parsers, options?.errors?.suggestions);
 				})()
 			};
 			const orderedParsers = parsers.map((p, i) => [p, i]);
@@ -282,7 +328,7 @@ function longestMatch(...args) {
 					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 createErrorWithSuggestions(defaultMsg, token, context.usage, "both", options?.errors?.suggestions);
+					return createUnexpectedInputErrorWithScopedSuggestions(defaultMsg, token, parsers, options?.errors?.suggestions);
 				})()
 			};
 			for (let i = 0; i < parsers.length; i++) {

package/dist/suggestion.cjs

@@ -183,4 +183,5 @@ function createErrorWithSuggestions(baseError, invalidInput, usage, type = "both
 //#endregion
 exports.DEFAULT_FIND_SIMILAR_OPTIONS = DEFAULT_FIND_SIMILAR_OPTIONS;
 exports.createErrorWithSuggestions = createErrorWithSuggestions;
+exports.createSuggestionMessage = createSuggestionMessage;
 exports.findSimilar = findSimilar;

package/dist/suggestion.js

@@ -181,4 +181,4 @@ function createErrorWithSuggestions(baseError, invalidInput, usage, type = "both
 }
 
 //#endregion
-export { DEFAULT_FIND_SIMILAR_OPTIONS, createErrorWithSuggestions, findSimilar };
+export { DEFAULT_FIND_SIMILAR_OPTIONS, createErrorWithSuggestions, createSuggestionMessage, findSimilar };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/core",
-  "version": "0.7.12",
+  "version": "0.7.13-dev.361+10f5601c",
   "description": "Type-safe combinatorial command-line interface parser",
   "keywords": [
     "CLI",