@optique/core 1.2.9 → 1.2.11

package/dist/internal/command-doc-metadata.cjs

@@ -0,0 +1,90 @@
+
+//#region src/internal/command-doc-metadata.ts
+function withOrigin(metadata, origin) {
+	const result = { ...metadata };
+	Object.defineProperty(result, "origin", {
+		value: origin,
+		enumerable: false
+	});
+	return result;
+}
+const commandDocMetadata = Symbol.for("@optique/core/commandDocMetadata");
+const commandDocCarrier = Symbol.for("@optique/core/commandDocMetadataCarrier");
+/**
+* Reads effective page metadata, including custom collection-level fields.
+* @param docs The child's documentation.
+* @returns Its selected-command metadata, if any.
+*/
+function getCommandDocMetadata(docs) {
+	const carrier = docs.fragments[commandDocCarrier];
+	if (carrier != null) {
+		const brief = docs.brief === carrier.brief ? carrier.metadata.brief : docs.brief;
+		const origin = carrier.metadata.origin ?? "entry";
+		const customPage = origin === "entry" && (docs.brief !== carrier.brief || docs.footer !== carrier.footer);
+		const description = origin === "entry" && !customPage || docs.description === carrier.description ? carrier.metadata.description : docs.description;
+		const footer = docs.footer === carrier.footer ? carrier.metadata.footer : docs.footer;
+		return withOrigin({
+			...brief == null ? {} : { brief },
+			...description == null ? {} : { description },
+			...footer == null ? {} : { footer }
+		}, customPage ? "custom" : origin);
+	}
+	const metadata = docs[commandDocMetadata];
+	if (metadata != null) return metadata;
+	return docs.brief != null || docs.description != null || docs.footer != null ? withOrigin({
+		brief: docs.brief,
+		description: docs.description,
+		footer: docs.footer
+	}, "custom") : void 0;
+}
+/**
+* Preserves selected-command metadata when rebuilding documentation fragments.
+* @param docs The rebuilt documentation.
+* @param metadata The selected-command metadata to preserve.
+* @returns Documentation with the internal metadata attached.
+*/
+function withCommandDocMetadata(docs, metadata) {
+	if (metadata == null) return docs;
+	metadata = withOrigin(metadata, metadata.origin ?? "entry");
+	const fragments = [...docs.fragments];
+	Object.defineProperty(fragments, commandDocCarrier, { value: {
+		metadata,
+		brief: docs.brief,
+		description: docs.description,
+		footer: docs.footer
+	} });
+	const result = {
+		...docs,
+		fragments
+	};
+	Object.defineProperty(result, commandDocMetadata, { value: metadata });
+	return result;
+}
+/**
+* Collects selected-command metadata in documentation traversal order.
+* @param current Metadata from earlier children.
+* @param docs The next child's documentation.
+* @param includeCustom Whether to retain custom page fields inside merge().
+* @returns The first defined value from children with the same origin.
+*/
+function collectCommandDocMetadata(current, docs, includeCustom = false) {
+	const next = getCommandDocMetadata(docs);
+	if (next == null) return current;
+	const origin = next.origin ?? "entry";
+	if (origin === "entry" || origin === "custom" && !includeCustom) return current ?? withOrigin({}, "entry");
+	if (current?.origin === "command" && origin !== "command") return current;
+	if (current?.origin !== origin) current = void 0;
+	const brief = current?.brief ?? next.brief;
+	const description = current?.description ?? next.description;
+	const footer = current?.footer ?? next.footer;
+	return withOrigin({
+		...brief == null ? {} : { brief },
+		...description == null ? {} : { description },
+		...footer == null ? {} : { footer }
+	}, origin);
+}
+
+//#endregion
+exports.collectCommandDocMetadata = collectCommandDocMetadata;
+exports.getCommandDocMetadata = getCommandDocMetadata;
+exports.withCommandDocMetadata = withCommandDocMetadata;

package/dist/internal/command-doc-metadata.js

@@ -0,0 +1,87 @@
+//#region src/internal/command-doc-metadata.ts
+function withOrigin(metadata, origin) {
+	const result = { ...metadata };
+	Object.defineProperty(result, "origin", {
+		value: origin,
+		enumerable: false
+	});
+	return result;
+}
+const commandDocMetadata = Symbol.for("@optique/core/commandDocMetadata");
+const commandDocCarrier = Symbol.for("@optique/core/commandDocMetadataCarrier");
+/**
+* Reads effective page metadata, including custom collection-level fields.
+* @param docs The child's documentation.
+* @returns Its selected-command metadata, if any.
+*/
+function getCommandDocMetadata(docs) {
+	const carrier = docs.fragments[commandDocCarrier];
+	if (carrier != null) {
+		const brief = docs.brief === carrier.brief ? carrier.metadata.brief : docs.brief;
+		const origin = carrier.metadata.origin ?? "entry";
+		const customPage = origin === "entry" && (docs.brief !== carrier.brief || docs.footer !== carrier.footer);
+		const description = origin === "entry" && !customPage || docs.description === carrier.description ? carrier.metadata.description : docs.description;
+		const footer = docs.footer === carrier.footer ? carrier.metadata.footer : docs.footer;
+		return withOrigin({
+			...brief == null ? {} : { brief },
+			...description == null ? {} : { description },
+			...footer == null ? {} : { footer }
+		}, customPage ? "custom" : origin);
+	}
+	const metadata = docs[commandDocMetadata];
+	if (metadata != null) return metadata;
+	return docs.brief != null || docs.description != null || docs.footer != null ? withOrigin({
+		brief: docs.brief,
+		description: docs.description,
+		footer: docs.footer
+	}, "custom") : void 0;
+}
+/**
+* Preserves selected-command metadata when rebuilding documentation fragments.
+* @param docs The rebuilt documentation.
+* @param metadata The selected-command metadata to preserve.
+* @returns Documentation with the internal metadata attached.
+*/
+function withCommandDocMetadata(docs, metadata) {
+	if (metadata == null) return docs;
+	metadata = withOrigin(metadata, metadata.origin ?? "entry");
+	const fragments = [...docs.fragments];
+	Object.defineProperty(fragments, commandDocCarrier, { value: {
+		metadata,
+		brief: docs.brief,
+		description: docs.description,
+		footer: docs.footer
+	} });
+	const result = {
+		...docs,
+		fragments
+	};
+	Object.defineProperty(result, commandDocMetadata, { value: metadata });
+	return result;
+}
+/**
+* Collects selected-command metadata in documentation traversal order.
+* @param current Metadata from earlier children.
+* @param docs The next child's documentation.
+* @param includeCustom Whether to retain custom page fields inside merge().
+* @returns The first defined value from children with the same origin.
+*/
+function collectCommandDocMetadata(current, docs, includeCustom = false) {
+	const next = getCommandDocMetadata(docs);
+	if (next == null) return current;
+	const origin = next.origin ?? "entry";
+	if (origin === "entry" || origin === "custom" && !includeCustom) return current ?? withOrigin({}, "entry");
+	if (current?.origin === "command" && origin !== "command") return current;
+	if (current?.origin !== origin) current = void 0;
+	const brief = current?.brief ?? next.brief;
+	const description = current?.description ?? next.description;
+	const footer = current?.footer ?? next.footer;
+	return withOrigin({
+		...brief == null ? {} : { brief },
+		...description == null ? {} : { description },
+		...footer == null ? {} : { footer }
+	}, origin);
+}
+
+//#endregion
+export { collectCommandDocMetadata, getCommandDocMetadata, withCommandDocMetadata };

package/dist/message.cjs

@@ -324,7 +324,8 @@ function formatMessage(msg, options = {}) {
 							if (match == null) break;
 							yield {
 								text: match[0],
-								width: require_displaywidth.getDisplayWidth(match[0])
+								width: require_displaywidth.getDisplayWidth(match[0]),
+								trimOnWrap: true
 							};
 						}
 					}
@@ -332,7 +333,8 @@ function formatMessage(msg, options = {}) {
 					const normalizedText = rawText.replace(/\n/g, " ");
 					if (normalizedText.trim() === "" && normalizedText.length > 0) yield {
 						text: " ",
-						width: 1
+						width: 1,
+						trimOnWrap: true
 					};
 					else {
 						wordPattern.lastIndex = 0;
@@ -341,7 +343,8 @@ function formatMessage(msg, options = {}) {
 							if (match == null) break;
 							yield {
 								text: match[0],
-								width: require_displaywidth.getDisplayWidth(match[0])
+								width: require_displaywidth.getDisplayWidth(match[0]),
+								trimOnWrap: true
 							};
 						}
 					}
@@ -381,7 +384,8 @@ function formatMessage(msg, options = {}) {
 			} else if (term.type === "values") for (let i = 0; i < term.values.length; i++) {
 				if (i > 0) yield {
 					text: " ",
-					width: 1
+					width: 1,
+					trimOnWrap: true
 				};
 				const value$1 = useQuotes ? JSON.stringify(term.values[i]) : term.values[i];
 				yield {
@@ -425,18 +429,40 @@ function formatMessage(msg, options = {}) {
 	}
 	let output = "";
 	let totalWidth = options.startWidth ?? 0;
-	for (const { text: text$1, width } of stream()) {
+	let pendingWrap = false;
+	let atWrappedLineStart = false;
+	for (const token of stream()) {
+		let { text: text$1, width } = token;
 		if (width === -1) {
 			output += text$1;
 			totalWidth = 0;
+			pendingWrap = false;
+			atWrappedLineStart = false;
+			continue;
+		}
+		const wraps = pendingWrap || options.maxWidth != null && totalWidth > 0 && totalWidth + width > options.maxWidth;
+		if ((wraps || atWrappedLineStart) && token.trimOnWrap) {
+			const trimmed = text$1.trimStart();
+			width -= require_displaywidth.getDisplayWidth(text$1.slice(0, text$1.length - trimmed.length));
+			text$1 = trimmed;
+			if (text$1 === "") {
+				if (wraps) pendingWrap = true;
+				continue;
+			}
+		}
+		if (pendingWrap && require_displaywidth.stripAnsi(text$1) === "") {
+			output += text$1;
 			continue;
 		}
-		if (options.maxWidth != null && totalWidth > 0 && totalWidth + width > options.maxWidth) {
+		if (wraps) {
 			output += "\n";
 			totalWidth = 0;
+			pendingWrap = false;
+			atWrappedLineStart = true;
 		}
 		output += text$1;
 		totalWidth += width;
+		if (width > 0) atWrappedLineStart = false;
 	}
 	return output;
 }

package/dist/message.js

@@ -1,4 +1,4 @@
-import { getDisplayWidth } from "./displaywidth.js";
+import { getDisplayWidth, stripAnsi } from "./displaywidth.js";
 
 //#region src/message.ts
 /**
@@ -324,7 +324,8 @@ function formatMessage(msg, options = {}) {
 							if (match == null) break;
 							yield {
 								text: match[0],
-								width: getDisplayWidth(match[0])
+								width: getDisplayWidth(match[0]),
+								trimOnWrap: true
 							};
 						}
 					}
@@ -332,7 +333,8 @@ function formatMessage(msg, options = {}) {
 					const normalizedText = rawText.replace(/\n/g, " ");
 					if (normalizedText.trim() === "" && normalizedText.length > 0) yield {
 						text: " ",
-						width: 1
+						width: 1,
+						trimOnWrap: true
 					};
 					else {
 						wordPattern.lastIndex = 0;
@@ -341,7 +343,8 @@ function formatMessage(msg, options = {}) {
 							if (match == null) break;
 							yield {
 								text: match[0],
-								width: getDisplayWidth(match[0])
+								width: getDisplayWidth(match[0]),
+								trimOnWrap: true
 							};
 						}
 					}
@@ -381,7 +384,8 @@ function formatMessage(msg, options = {}) {
 			} else if (term.type === "values") for (let i = 0; i < term.values.length; i++) {
 				if (i > 0) yield {
 					text: " ",
-					width: 1
+					width: 1,
+					trimOnWrap: true
 				};
 				const value$1 = useQuotes ? JSON.stringify(term.values[i]) : term.values[i];
 				yield {
@@ -425,18 +429,40 @@ function formatMessage(msg, options = {}) {
 	}
 	let output = "";
 	let totalWidth = options.startWidth ?? 0;
-	for (const { text: text$1, width } of stream()) {
+	let pendingWrap = false;
+	let atWrappedLineStart = false;
+	for (const token of stream()) {
+		let { text: text$1, width } = token;
 		if (width === -1) {
 			output += text$1;
 			totalWidth = 0;
+			pendingWrap = false;
+			atWrappedLineStart = false;
+			continue;
+		}
+		const wraps = pendingWrap || options.maxWidth != null && totalWidth > 0 && totalWidth + width > options.maxWidth;
+		if ((wraps || atWrappedLineStart) && token.trimOnWrap) {
+			const trimmed = text$1.trimStart();
+			width -= getDisplayWidth(text$1.slice(0, text$1.length - trimmed.length));
+			text$1 = trimmed;
+			if (text$1 === "") {
+				if (wraps) pendingWrap = true;
+				continue;
+			}
+		}
+		if (pendingWrap && stripAnsi(text$1) === "") {
+			output += text$1;
 			continue;
 		}
-		if (options.maxWidth != null && totalWidth > 0 && totalWidth + width > options.maxWidth) {
+		if (wraps) {
 			output += "\n";
 			totalWidth = 0;
+			pendingWrap = false;
+			atWrappedLineStart = true;
 		}
 		output += text$1;
 		totalWidth += width;
+		if (width > 0) atWrappedLineStart = false;
 	}
 	return output;
 }

package/dist/modifiers.cjs

@@ -3,6 +3,7 @@ const require_message = require('./message.cjs');
 const require_mode_dispatch = require('./internal/mode-dispatch.cjs');
 const require_internal_parser = require('./internal/parser.cjs');
 const require_annotation_state = require('./annotation-state.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');
 const require_phase2_seed = require('./phase2-seed.cjs');
@@ -636,10 +637,10 @@ function withDefault(parser, defaultValue, options) {
 					};
 					return fragment;
 				});
-				return {
+				return require_command_doc_metadata.withCommandDocMetadata({
 					...fragments,
 					fragments: modifiedFragments
-				};
+				}, require_command_doc_metadata.getCommandDocMetadata(fragments));
 			}
 			return fragments;
 		}

package/dist/modifiers.js

@@ -3,6 +3,7 @@ import { formatMessage, message, text } from "./message.js";
 import { dispatchByMode, dispatchIterableByMode, mapModeValue, wrapForMode } from "./internal/mode-dispatch.js";
 import { defineInheritedAnnotationParser, defineParseLanes, defineSourceBindingOnlyAnnotationCompletionParser, getOwnParseLanes, unmatchedNonCliDependencySourceStateMarker } from "./internal/parser.js";
 import { getDelegatedAnnotationState, hasDelegatedAnnotationCarrier, isAnnotationWrappedInitialState, normalizeDelegatedAnnotationState, normalizeNestedDelegatedAnnotationState } from "./annotation-state.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";
 import { completeOrExtractPhase2Seed, extractPhase2Seed, extractPhase2SeedKey, phase2SeedFromValueResult } from "./phase2-seed.js";
@@ -636,10 +637,10 @@ function withDefault(parser, defaultValue, options) {
 					};
 					return fragment;
 				});
-				return {
+				return withCommandDocMetadata({
 					...fragments,
 					fragments: modifiedFragments
-				};
+				}, getCommandDocMetadata(fragments));
 			}
 			return fragments;
 		}

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_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');
 const require_execution_context = require('./execution-context.cjs');
@@ -640,10 +641,10 @@ function option(...args) {
 			return suggestOptionSync(optionNames$1, valueParser, require_usage.isSuggestionHidden(options.hidden), options.description, context, prefix);
 		},
 		getDocFragments(_state, defaultValue) {
-			if (require_usage.isDocHidden(options.hidden)) return {
+			if (require_usage.isDocHidden(options.hidden)) return require_command_doc_metadata.withCommandDocMetadata({
 				fragments: [],
 				description: options.description
-			};
+			}, {});
 			const choicesMessage = valueParser?.choices != null && valueParser.choices.length > 0 ? require_message.valueSet(valueParser.choices.map((c) => valueParser.format(c)), {
 				fallback: "",
 				type: "unit"
@@ -659,10 +660,10 @@ function option(...args) {
 				default: defaultValue != null && valueParser != null ? require_message.message`${valueParser.format(defaultValue)}` : void 0,
 				choices: choicesMessage
 			}];
-			return {
+			return require_command_doc_metadata.withCommandDocMetadata({
 				fragments,
 				description: options.description
-			};
+			}, {});
 		},
 		[Symbol.for("Deno.customInspect")]() {
 			return `option(${optionNames$1.map((o) => JSON.stringify(o)).join(", ")})`;
@@ -931,10 +932,10 @@ function flag(...args) {
 			return suggestions;
 		},
 		getDocFragments(_state, _defaultValue) {
-			if (require_usage.isDocHidden(options.hidden)) return {
+			if (require_usage.isDocHidden(options.hidden)) return require_command_doc_metadata.withCommandDocMetadata({
 				fragments: [],
 				description: options.description
-			};
+			}, {});
 			const fragments = [{
 				type: "entry",
 				term: {
@@ -943,10 +944,10 @@ function flag(...args) {
 				},
 				description: options.description
 			}];
-			return {
+			return require_command_doc_metadata.withCommandDocMetadata({
 				fragments,
 				description: options.description
-			};
+			}, {});
 		},
 		[Symbol.for("Deno.customInspect")]() {
 			return `flag(${optionNames$1.map((o) => JSON.stringify(o)).join(", ")})`;
@@ -1303,10 +1304,10 @@ function argument(valueParser, options = {}) {
 			return suggestArgumentSync(valueParser, require_usage.isSuggestionHidden(options.hidden), prefix, context.dependencyRegistry, context.exec);
 		},
 		getDocFragments(_state, defaultValue) {
-			if (require_usage.isDocHidden(options.hidden)) return {
+			if (require_usage.isDocHidden(options.hidden)) return require_command_doc_metadata.withCommandDocMetadata({
 				fragments: [],
 				description: options.description
-			};
+			}, {});
 			const choicesMessage = valueParser.choices != null && valueParser.choices.length > 0 ? require_message.valueSet(valueParser.choices.map((c) => valueParser.format(c)), {
 				fallback: "",
 				type: "unit"
@@ -1318,10 +1319,10 @@ function argument(valueParser, options = {}) {
 				default: defaultValue == null ? void 0 : require_message.message`${valueParser.format(defaultValue)}`,
 				choices: choicesMessage
 			}];
-			return {
+			return require_command_doc_metadata.withCommandDocMetadata({
 				fragments,
 				description: options.description
-			};
+			}, {});
 		},
 		[Symbol.for("Deno.customInspect")]() {
 			return `argument()`;
@@ -1672,11 +1673,11 @@ function command(name, parser, options = {}) {
 		getDocFragments(state, defaultValue) {
 			const commandState = state.kind === "available" ? normalizeCommandState(state.state) : void 0;
 			if (state.kind === "unavailable" || typeof commandState === "undefined") {
-				if (require_usage.isDocHidden(options.hidden)) return {
+				if (require_usage.isDocHidden(options.hidden)) return require_command_doc_metadata.withCommandDocMetadata({
 					fragments: [],
 					description: options.description
-				};
-				return {
+				}, {});
+				return require_command_doc_metadata.withCommandDocMetadata({
 					description: options.description,
 					fragments: [{
 						type: "entry",
@@ -1686,7 +1687,7 @@ function command(name, parser, options = {}) {
 						},
 						description: options.brief ?? options.description
 					}]
-				};
+				}, {});
 			}
 			const innerState = commandState[0] === "parsing" ? {
 				kind: "available",
@@ -1696,12 +1697,18 @@ function command(name, parser, options = {}) {
 				state: getCommandChildState(state.state, parser.initialState, parser)
 			};
 			const innerFragments = parser.getDocFragments(innerState, defaultValue);
-			return {
+			const innerMetadata = require_command_doc_metadata.getCommandDocMetadata(innerFragments) ?? innerFragments;
+			return require_command_doc_metadata.withCommandDocMetadata({
 				...innerFragments,
 				brief: innerFragments.brief ?? options.brief,
 				description: innerFragments.description ?? options.description,
 				footer: innerFragments.footer ?? options.footer
-			};
+			}, {
+				origin: "command",
+				brief: innerMetadata?.brief ?? options.brief,
+				description: innerMetadata?.description ?? options.description,
+				footer: innerMetadata?.footer ?? options.footer
+			});
 		},
 		[Symbol.for("Deno.customInspect")]() {
 			return `command(${JSON.stringify(name)})`;
@@ -1902,18 +1909,18 @@ function passThrough(options = {}) {
 			return [];
 		},
 		getDocFragments(_state, _defaultValue) {
-			if (require_usage.isDocHidden(options.hidden)) return {
+			if (require_usage.isDocHidden(options.hidden)) return require_command_doc_metadata.withCommandDocMetadata({
 				fragments: [],
 				description: options.description
-			};
-			return {
+			}, {});
+			return require_command_doc_metadata.withCommandDocMetadata({
 				fragments: [{
 					type: "entry",
 					term: { type: "passthrough" },
 					description: options.description
 				}],
 				description: options.description
-			};
+			}, {});
 		},
 		[Symbol.for("Deno.customInspect")]() {
 			return `passThrough(${format})`;