@optique/core 1.3.5 → 1.3.7-dev.3001

package/dist/constructs.cjs

@@ -1019,12 +1019,16 @@ function analyzeNoMatchContext(parsers) {
 * construction. This is a programmer error, not a user error.
 */
 var DuplicateOptionError = class extends Error {
+	/** The option name shared by multiple fields. */
+	optionName;
+	/** The fields declaring the option. */
+	sources;
 	constructor(optionName$1, sources) {
 		const sourceNames = sources.map((s) => typeof s === "symbol" ? s.description ?? s.toString() : s);
 		super(`Duplicate option name "${optionName$1}" found in fields: ${sourceNames.join(", ")}. Each option name must be unique within a parser combinator.`);
+		this.name = "DuplicateOptionError";
 		this.optionName = optionName$1;
 		this.sources = sources;
-		this.name = "DuplicateOptionError";
 	}
 };
 /**
@@ -1032,6 +1036,8 @@ var DuplicateOptionError = class extends Error {
 * during parser construction. This is a programmer error, not a user error.
 */
 var DuplicateCommandNameError = class extends TypeError {
+	commandName;
+	sources;
 	constructor(commandName, sources) {
 		const sourceNames = sources.map((s) => typeof s === "symbol" ? s.description ?? s.toString() : s);
 		super(`Duplicate command name "${commandName}" found in parsers: ${sourceNames.join(", ")}. Each command name or alias must be unique within active parser alternatives.`);

package/dist/constructs.d.cts

@@ -103,7 +103,9 @@ interface OrErrorOptions {
  * construction. This is a programmer error, not a user error.
  */
 declare class DuplicateOptionError extends Error {
+  /** The option name shared by multiple fields. */
   readonly optionName: string;
+  /** The fields declaring the option. */
   readonly sources: readonly (string | symbol)[];
   constructor(optionName: string, sources: readonly (string | symbol)[]);
 }

package/dist/constructs.d.ts

@@ -103,7 +103,9 @@ interface OrErrorOptions {
  * construction. This is a programmer error, not a user error.
  */
 declare class DuplicateOptionError extends Error {
+  /** The option name shared by multiple fields. */
   readonly optionName: string;
+  /** The fields declaring the option. */
   readonly sources: readonly (string | symbol)[];
   constructor(optionName: string, sources: readonly (string | symbol)[]);
 }

package/dist/constructs.js

@@ -1019,12 +1019,16 @@ function analyzeNoMatchContext(parsers) {
 * construction. This is a programmer error, not a user error.
 */
 var DuplicateOptionError = class extends Error {
+	/** The option name shared by multiple fields. */
+	optionName;
+	/** The fields declaring the option. */
+	sources;
 	constructor(optionName$1, sources) {
 		const sourceNames = sources.map((s) => typeof s === "symbol" ? s.description ?? s.toString() : s);
 		super(`Duplicate option name "${optionName$1}" found in fields: ${sourceNames.join(", ")}. Each option name must be unique within a parser combinator.`);
+		this.name = "DuplicateOptionError";
 		this.optionName = optionName$1;
 		this.sources = sources;
-		this.name = "DuplicateOptionError";
 	}
 };
 /**
@@ -1032,6 +1036,8 @@ var DuplicateOptionError = class extends Error {
 * during parser construction. This is a programmer error, not a user error.
 */
 var DuplicateCommandNameError = class extends TypeError {
+	commandName;
+	sources;
 	constructor(commandName, sources) {
 		const sourceNames = sources.map((s) => typeof s === "symbol" ? s.description ?? s.toString() : s);
 		super(`Duplicate command name "${commandName}" found in parsers: ${sourceNames.join(", ")}. Each command name or alias must be unique within active parser alternatives.`);

package/dist/internal/joined-file-suggestion.cjs

@@ -0,0 +1,73 @@
+
+//#region src/internal/joined-file-suggestion.ts
+const joinedFiles = /* @__PURE__ */ new WeakMap();
+/**
+* Keeps a joined file fallback's origin available to the Bash encoder.
+* Other shells retain the existing literal representation.
+* @param prefix The option name and delimiter.
+* @param file The original file suggestion.
+* @param value The value prefix being completed.
+* @returns The literal fallback with private file metadata.
+* @internal
+*/
+function joinedFileSuggestion(prefix, file, value) {
+	const literal = {
+		kind: "literal",
+		text: prefix + (file.pattern ?? ""),
+		description: file.description
+	};
+	joinedFiles.set(literal, {
+		files: [{
+			prefix,
+			file: file.pattern === value && !/[?*]/.test(value) && !(file.prefix != null && file.prefix !== "" && value.startsWith(file.prefix)) ? {
+				...file,
+				pattern: void 0
+			} : file
+		}],
+		literal: false
+	});
+	return literal;
+}
+/**
+* Retrieves the originating file suggestion for a joined literal fallback.
+* @param suggestion The suggestion to inspect.
+* @returns Its private file metadata, if present.
+* @internal
+*/
+function getJoinedFileSuggestion(suggestion) {
+	return joinedFiles.get(suggestion);
+}
+/**
+* Preserves file origins when equal literal fallbacks are deduplicated.
+* @param target The retained suggestion.
+* @param source The duplicate suggestion.
+* @internal
+*/
+function mergeJoinedFileSuggestions(target, source) {
+	const a = joinedFiles.get(target);
+	const b = joinedFiles.get(source);
+	if (a === void 0 && b === void 0) return;
+	const files = [...a?.files ?? [], ...b?.files ?? []];
+	const seen = /* @__PURE__ */ new Set();
+	joinedFiles.set(target, {
+		literal: (a?.literal ?? true) || (b?.literal ?? true),
+		files: files.filter(({ prefix, file }) => {
+			const key = JSON.stringify([
+				prefix,
+				file.type,
+				file.pattern,
+				file.prefix,
+				file.includeHidden === true,
+				file.extensions?.toSorted()
+			]);
+			if (seen.has(key)) return false;
+			seen.add(key);
+			return true;
+		})
+	});
+}
+
+//#endregion
+exports.getJoinedFileSuggestion = getJoinedFileSuggestion;
+exports.joinedFileSuggestion = joinedFileSuggestion;
+exports.mergeJoinedFileSuggestions = mergeJoinedFileSuggestions;

package/dist/internal/joined-file-suggestion.js

@@ -0,0 +1,70 @@
+//#region src/internal/joined-file-suggestion.ts
+const joinedFiles = /* @__PURE__ */ new WeakMap();
+/**
+* Keeps a joined file fallback's origin available to the Bash encoder.
+* Other shells retain the existing literal representation.
+* @param prefix The option name and delimiter.
+* @param file The original file suggestion.
+* @param value The value prefix being completed.
+* @returns The literal fallback with private file metadata.
+* @internal
+*/
+function joinedFileSuggestion(prefix, file, value) {
+	const literal = {
+		kind: "literal",
+		text: prefix + (file.pattern ?? ""),
+		description: file.description
+	};
+	joinedFiles.set(literal, {
+		files: [{
+			prefix,
+			file: file.pattern === value && !/[?*]/.test(value) && !(file.prefix != null && file.prefix !== "" && value.startsWith(file.prefix)) ? {
+				...file,
+				pattern: void 0
+			} : file
+		}],
+		literal: false
+	});
+	return literal;
+}
+/**
+* Retrieves the originating file suggestion for a joined literal fallback.
+* @param suggestion The suggestion to inspect.
+* @returns Its private file metadata, if present.
+* @internal
+*/
+function getJoinedFileSuggestion(suggestion) {
+	return joinedFiles.get(suggestion);
+}
+/**
+* Preserves file origins when equal literal fallbacks are deduplicated.
+* @param target The retained suggestion.
+* @param source The duplicate suggestion.
+* @internal
+*/
+function mergeJoinedFileSuggestions(target, source) {
+	const a = joinedFiles.get(target);
+	const b = joinedFiles.get(source);
+	if (a === void 0 && b === void 0) return;
+	const files = [...a?.files ?? [], ...b?.files ?? []];
+	const seen = /* @__PURE__ */ new Set();
+	joinedFiles.set(target, {
+		literal: (a?.literal ?? true) || (b?.literal ?? true),
+		files: files.filter(({ prefix, file }) => {
+			const key = JSON.stringify([
+				prefix,
+				file.type,
+				file.pattern,
+				file.prefix,
+				file.includeHidden === true,
+				file.extensions?.toSorted()
+			]);
+			if (seen.has(key)) return false;
+			seen.add(key);
+			return true;
+		})
+	});
+}
+
+//#endregion
+export { getJoinedFileSuggestion, joinedFileSuggestion, mergeJoinedFileSuggestions };

package/dist/internal/parser.d.cts

@@ -758,6 +758,14 @@ type Suggestion = {
    * The current prefix/pattern for fallback when native completion is unavailable.
    */
   readonly pattern?: string;
+  /**
+   * Literal text at the start of `pattern` that is preserved on insertion
+   * but excluded from native filesystem matching, such as `output=`.
+   * Shell adapters ignore it if it does not lead both the pattern and
+   * the current word.  Regenerate installed scripts to use this field.
+   * @since 1.1.13
+   */
+  readonly prefix?: string;
   /**
    * The type of file system entries to complete.
    */

package/dist/internal/parser.d.ts

@@ -758,6 +758,14 @@ type Suggestion = {
    * The current prefix/pattern for fallback when native completion is unavailable.
    */
   readonly pattern?: string;
+  /**
+   * Literal text at the start of `pattern` that is preserved on insertion
+   * but excluded from native filesystem matching, such as `output=`.
+   * Shell adapters ignore it if it does not lead both the pattern and
+   * the current word.  Regenerate installed scripts to use this field.
+   * @since 1.1.13
+   */
+  readonly prefix?: string;
   /**
    * The type of file system entries to complete.
    */

package/dist/modifiers.cjs

@@ -4,6 +4,7 @@ const require_mode_dispatch = require('./internal/mode-dispatch.cjs');
 const require_dependency_runtime = require('./dependency-runtime.cjs');
 const require_internal_parser = require('./internal/parser.cjs');
 const require_annotation_state = require('./annotation-state.cjs');
+const require_joined_file_suggestion = require('./internal/joined-file-suggestion.cjs');
 const require_command_doc_metadata = require('./internal/command-doc-metadata.cjs');
 const require_passthrough = require('./internal/passthrough.cjs');
 const require_execution_context = require('./execution-context.cjs');
@@ -1516,6 +1517,7 @@ function multiple(parser, options = {}) {
 					"file",
 					suggestion.type,
 					suggestion.pattern ?? "",
+					suggestion.prefix ?? "",
 					suggestion.includeHidden === true,
 					suggestion.extensions == null ? "" : suggestion.extensions.toSorted().join("\0"),
 					description
@@ -1523,14 +1525,16 @@ function multiple(parser, options = {}) {
 			};
 			return require_mode_dispatch.dispatchIterableByMode(parser.mode, function* () {
 				const selectedValues = collectSelectedValuesSync();
-				const emitted = /* @__PURE__ */ new Set();
+				const emitted = /* @__PURE__ */ new Map();
 				const yieldUnique = function* (suggestions) {
 					for (const s of suggestions) {
 						const key = suggestionKey(s);
-						if (shouldInclude(selectedValues, s) && !emitted.has(key)) {
-							emitted.add(key);
+						if (!shouldInclude(selectedValues, s)) continue;
+						const existing = emitted.get(key);
+						if (existing === void 0) {
+							emitted.set(key, s);
 							yield s;
-						}
+						} else require_joined_file_suggestion.mergeJoinedFileSuggestions(existing, s);
 					}
 				};
 				let shouldTryFallback = false;
@@ -1543,14 +1547,16 @@ function multiple(parser, options = {}) {
 				if (shouldTryFallback) yield* yieldUnique(syncParser.suggest(require_execution_context.withChildContext(context, itemIndex, suggestFallbackState), prefix));
 			}, async function* () {
 				const selectedValues = await collectSelectedValuesAsync();
-				const emitted = /* @__PURE__ */ new Set();
+				const emitted = /* @__PURE__ */ new Map();
 				const yieldUnique = async function* (suggestions) {
 					for await (const s of suggestions) {
 						const key = suggestionKey(s);
-						if (shouldInclude(selectedValues, s) && !emitted.has(key)) {
-							emitted.add(key);
+						if (!shouldInclude(selectedValues, s)) continue;
+						const existing = emitted.get(key);
+						if (existing === void 0) {
+							emitted.set(key, s);
 							yield s;
-						}
+						} else require_joined_file_suggestion.mergeJoinedFileSuggestions(existing, s);
 					}
 				};
 				let shouldTryFallback = false;

package/dist/modifiers.js

@@ -4,6 +4,7 @@ import { dispatchByMode, dispatchIterableByMode, mapModeValue, wrapForMode } fro
 import { defineForwardedEffectfulSchedulingNodes } from "./dependency-runtime.js";
 import { defineInheritedAnnotationParser, defineParseLanes, defineSourceBindingOnlyAnnotationCompletionParser, getOwnParseLanes, unmatchedNonCliDependencySourceStateMarker } from "./internal/parser.js";
 import { getDelegatedAnnotationState, hasDelegatedAnnotationCarrier, isAnnotationWrappedInitialState, normalizeDelegatedAnnotationState, normalizeNestedDelegatedAnnotationState } from "./annotation-state.js";
+import { mergeJoinedFileSuggestions } from "./internal/joined-file-suggestion.js";
 import { getCommandDocMetadata, withCommandDocMetadata } from "./internal/command-doc-metadata.js";
 import { defineKnownCompletionLookup, defineOptionMatch, definePassThroughPriority, getKnownCompletion, getOptionMatch, getPassThroughPriority } from "./internal/passthrough.js";
 import { mergeChildExec, withChildContext, withChildExecPath } from "./execution-context.js";
@@ -1516,6 +1517,7 @@ function multiple(parser, options = {}) {
 					"file",
 					suggestion.type,
 					suggestion.pattern ?? "",
+					suggestion.prefix ?? "",
 					suggestion.includeHidden === true,
 					suggestion.extensions == null ? "" : suggestion.extensions.toSorted().join("\0"),
 					description
@@ -1523,14 +1525,16 @@ function multiple(parser, options = {}) {
 			};
 			return dispatchIterableByMode(parser.mode, function* () {
 				const selectedValues = collectSelectedValuesSync();
-				const emitted = /* @__PURE__ */ new Set();
+				const emitted = /* @__PURE__ */ new Map();
 				const yieldUnique = function* (suggestions) {
 					for (const s of suggestions) {
 						const key = suggestionKey(s);
-						if (shouldInclude(selectedValues, s) && !emitted.has(key)) {
-							emitted.add(key);
+						if (!shouldInclude(selectedValues, s)) continue;
+						const existing = emitted.get(key);
+						if (existing === void 0) {
+							emitted.set(key, s);
 							yield s;
-						}
+						} else mergeJoinedFileSuggestions(existing, s);
 					}
 				};
 				let shouldTryFallback = false;
@@ -1543,14 +1547,16 @@ function multiple(parser, options = {}) {
 				if (shouldTryFallback) yield* yieldUnique(syncParser.suggest(withChildContext(context, itemIndex, suggestFallbackState), prefix));
 			}, async function* () {
 				const selectedValues = await collectSelectedValuesAsync();
-				const emitted = /* @__PURE__ */ new Set();
+				const emitted = /* @__PURE__ */ new Map();
 				const yieldUnique = async function* (suggestions) {
 					for await (const s of suggestions) {
 						const key = suggestionKey(s);
-						if (shouldInclude(selectedValues, s) && !emitted.has(key)) {
-							emitted.add(key);
+						if (!shouldInclude(selectedValues, s)) continue;
+						const existing = emitted.get(key);
+						if (existing === void 0) {
+							emitted.set(key, s);
 							yield s;
-						}
+						} else mergeJoinedFileSuggestions(existing, s);
 					}
 				};
 				let shouldTryFallback = false;

package/dist/primitives.cjs

@@ -6,6 +6,7 @@ const require_mode_dispatch = require('./internal/mode-dispatch.cjs');
 const require_internal_dependency = require('./internal/dependency.cjs');
 const require_dependency_runtime = require('./dependency-runtime.cjs');
 const require_annotation_state = require('./annotation-state.cjs');
+const require_joined_file_suggestion = require('./internal/joined-file-suggestion.cjs');
 const require_command_doc_metadata = require('./internal/command-doc-metadata.cjs');
 const require_passthrough = require('./internal/passthrough.cjs');
 const require_command_alias = require('./internal/command-alias.cjs');
@@ -253,33 +254,33 @@ function* getSuggestionsWithDependency(valueParser, prefix, dependencyRegistry,
 	}
 	yield* valueParser.suggest(prefix);
 }
+/** Returns the joined prefix accepted by option parsing. */
+function joinedOptionPrefix(names, input) {
+	return names.filter((name) => name.startsWith("--") || name.startsWith("/") || name.startsWith("-") && name.length > 2).map((name) => name + (name.startsWith("/") ? ":" : "=")).find((prefix) => input.startsWith(prefix));
+}
 /**
 * Internal sync helper for option suggest functionality.
 * @internal
 */
 function* suggestOptionSync(optionNames$1, valueParser, hidden, description, context, prefix) {
 	if (hidden || context.optionsTerminated) return;
-	const equalsIndex = prefix.indexOf("=");
-	if (equalsIndex >= 0) {
-		const optionPart = prefix.slice(0, equalsIndex);
-		const valuePart = prefix.slice(equalsIndex + 1);
+	const expectingValue = context.buffer.length > 0 && optionNames$1.includes(context.buffer[context.buffer.length - 1]);
+	const joinedPrefix = joinedOptionPrefix(optionNames$1, prefix);
+	if (joinedPrefix !== void 0 && !expectingValue) {
+		const optionPart = joinedPrefix.slice(0, -1);
+		const valuePart = prefix.slice(joinedPrefix.length);
 		if (optionNames$1.includes(optionPart)) {
 			if (valueParser && valueParser.suggest) {
 				const valueSuggestions = getSuggestionsWithDependency(valueParser, valuePart, context.dependencyRegistry, context.exec);
 				for (const suggestion of valueSuggestions) if (suggestion.kind === "literal") yield {
 					kind: "literal",
-					text: `${optionPart}=${suggestion.text}`,
-					description: suggestion.description
-				};
-				else yield {
-					kind: "literal",
-					text: `${optionPart}=${suggestion.pattern || ""}`,
+					text: `${joinedPrefix}${suggestion.text}`,
 					description: suggestion.description
 				};
+				else yield require_joined_file_suggestion.joinedFileSuggestion(joinedPrefix, suggestion, valuePart);
 			}
 		}
 	} else {
-		const expectingValue = context.buffer.length > 0 && optionNames$1.includes(context.buffer[context.buffer.length - 1]);
 		if (!expectingValue && (prefix.startsWith("--") || prefix.startsWith("-") || prefix.startsWith("/") || prefix.startsWith("+"))) {
 			for (const optionName$1 of optionNames$1) if (optionName$1.startsWith(prefix)) {
 				if (prefix === "-" && optionName$1.length !== 2) continue;
@@ -344,27 +345,23 @@ async function* getSuggestionsWithDependencyAsync(valueParser, prefix, dependenc
 */
 async function* suggestOptionAsync(optionNames$1, valueParser, hidden, description, context, prefix) {
 	if (hidden || context.optionsTerminated) return;
-	const equalsIndex = prefix.indexOf("=");
-	if (equalsIndex >= 0) {
-		const optionPart = prefix.slice(0, equalsIndex);
-		const valuePart = prefix.slice(equalsIndex + 1);
+	const expectingValue = context.buffer.length > 0 && optionNames$1.includes(context.buffer[context.buffer.length - 1]);
+	const joinedPrefix = joinedOptionPrefix(optionNames$1, prefix);
+	if (joinedPrefix !== void 0 && !expectingValue) {
+		const optionPart = joinedPrefix.slice(0, -1);
+		const valuePart = prefix.slice(joinedPrefix.length);
 		if (optionNames$1.includes(optionPart)) {
 			if (valueParser && valueParser.suggest) {
 				const valueSuggestions = getSuggestionsWithDependencyAsync(valueParser, valuePart, context.dependencyRegistry, context.exec);
 				for await (const suggestion of valueSuggestions) if (suggestion.kind === "literal") yield {
 					kind: "literal",
-					text: `${optionPart}=${suggestion.text}`,
-					description: suggestion.description
-				};
-				else yield {
-					kind: "literal",
-					text: `${optionPart}=${suggestion.pattern || ""}`,
+					text: `${joinedPrefix}${suggestion.text}`,
 					description: suggestion.description
 				};
+				else yield require_joined_file_suggestion.joinedFileSuggestion(joinedPrefix, suggestion, valuePart);
 			}
 		}
 	} else {
-		const expectingValue = context.buffer.length > 0 && optionNames$1.includes(context.buffer[context.buffer.length - 1]);
 		if (!expectingValue && (prefix.startsWith("--") || prefix.startsWith("-") || prefix.startsWith("/") || prefix.startsWith("+"))) {
 			for (const optionName$1 of optionNames$1) if (optionName$1.startsWith(prefix)) {
 				if (prefix === "-" && optionName$1.length !== 2) continue;
@@ -1806,16 +1803,29 @@ function command(name, parser, options = {}) {
 * // mycli --debug --foo bar
 * // → { debug: true, extra: ["--foo", "bar"] }
 *
-* // greedy format: captures all remaining tokens
-* const parser = command("exec", object({
-*   container: argument(string()),
-*   args: passThrough({ format: "greedy" }),
-* }));
+* // greedy format: require a program name before capturing the rest
+* const parser = command("exec", map(
+*   seq(
+*     argument(string({ metavar: "PROGRAM" })),
+*     passThrough({ format: "greedy" }),
+*   ),
+*   ([program, args]) => ({ program, args }),
+* ));
 *
-* // myproxy exec mycontainer --verbose -it bash
-* // → { container: "mycontainer", args: ["--verbose", "-it", "bash"] }
+* // myproxy exec my-program --help
+* // → { program: "my-program", args: ["--help"] }
 * ```
 *
+* With built-in help enabled, `myproxy exec --help` displays help because `seq()`
+* does not reach pass-through until the program name is parsed. After the
+* program name, greedy capture can consume remaining tokens, including
+* `--help`, so they can be forwarded. Putting this parser last in an `object()`
+* does not establish the same boundary: fields are tried by priority, not
+* declaration order.
+* An immediate `--` after the program name is consumed by `seq()` as an
+* options terminator before greedy capture starts. Once capture starts,
+* subsequent `--` tokens are kept.
+*
 * @since 0.8.0
 */
 function passThrough(options = {}) {

package/dist/primitives.d.cts

@@ -584,16 +584,29 @@ interface PassThroughOptions {
  * // mycli --debug --foo bar
  * // → { debug: true, extra: ["--foo", "bar"] }
  *
- * // greedy format: captures all remaining tokens
- * const parser = command("exec", object({
- *   container: argument(string()),
- *   args: passThrough({ format: "greedy" }),
- * }));
+ * // greedy format: require a program name before capturing the rest
+ * const parser = command("exec", map(
+ *   seq(
+ *     argument(string({ metavar: "PROGRAM" })),
+ *     passThrough({ format: "greedy" }),
+ *   ),
+ *   ([program, args]) => ({ program, args }),
+ * ));
  *
- * // myproxy exec mycontainer --verbose -it bash
- * // → { container: "mycontainer", args: ["--verbose", "-it", "bash"] }
+ * // myproxy exec my-program --help
+ * // → { program: "my-program", args: ["--help"] }
  * ```
  *
+ * With built-in help enabled, `myproxy exec --help` displays help because `seq()`
+ * does not reach pass-through until the program name is parsed. After the
+ * program name, greedy capture can consume remaining tokens, including
+ * `--help`, so they can be forwarded. Putting this parser last in an `object()`
+ * does not establish the same boundary: fields are tried by priority, not
+ * declaration order.
+ * An immediate `--` after the program name is consumed by `seq()` as an
+ * options terminator before greedy capture starts. Once capture starts,
+ * subsequent `--` tokens are kept.
+ *
  * @since 0.8.0
  */
 declare function passThrough(options?: PassThroughOptions): FluentParser<"sync", readonly string[], readonly string[]>;

package/dist/primitives.d.ts

@@ -584,16 +584,29 @@ interface PassThroughOptions {
  * // mycli --debug --foo bar
  * // → { debug: true, extra: ["--foo", "bar"] }
  *
- * // greedy format: captures all remaining tokens
- * const parser = command("exec", object({
- *   container: argument(string()),
- *   args: passThrough({ format: "greedy" }),
- * }));
+ * // greedy format: require a program name before capturing the rest
+ * const parser = command("exec", map(
+ *   seq(
+ *     argument(string({ metavar: "PROGRAM" })),
+ *     passThrough({ format: "greedy" }),
+ *   ),
+ *   ([program, args]) => ({ program, args }),
+ * ));
  *
- * // myproxy exec mycontainer --verbose -it bash
- * // → { container: "mycontainer", args: ["--verbose", "-it", "bash"] }
+ * // myproxy exec my-program --help
+ * // → { program: "my-program", args: ["--help"] }
  * ```
  *
+ * With built-in help enabled, `myproxy exec --help` displays help because `seq()`
+ * does not reach pass-through until the program name is parsed. After the
+ * program name, greedy capture can consume remaining tokens, including
+ * `--help`, so they can be forwarded. Putting this parser last in an `object()`
+ * does not establish the same boundary: fields are tried by priority, not
+ * declaration order.
+ * An immediate `--` after the program name is consumed by `seq()` as an
+ * options terminator before greedy capture starts. Once capture starts,
+ * subsequent `--` tokens are kept.
+ *
  * @since 0.8.0
  */
 declare function passThrough(options?: PassThroughOptions): FluentParser<"sync", readonly string[], readonly string[]>;