@optique/core 0.1.0-dev.1

package/dist/index.cjs

@@ -0,0 +1,42 @@
+const require_message = require('./message.cjs');
+const require_usage = require('./usage.cjs');
+const require_doc = require('./doc.cjs');
+const require_valueparser = require('./valueparser.cjs');
+const require_parser = require('./parser.cjs');
+const require_facade = require('./facade.cjs');
+
+exports.RunError = require_facade.RunError;
+exports.argument = require_parser.argument;
+exports.choice = require_valueparser.choice;
+exports.command = require_parser.command;
+exports.constant = require_parser.constant;
+exports.float = require_valueparser.float;
+exports.formatDocPage = require_doc.formatDocPage;
+exports.formatMessage = require_message.formatMessage;
+exports.formatUsage = require_usage.formatUsage;
+exports.formatUsageTerm = require_usage.formatUsageTerm;
+exports.getDocPage = require_parser.getDocPage;
+exports.integer = require_valueparser.integer;
+exports.isValueParser = require_valueparser.isValueParser;
+exports.locale = require_valueparser.locale;
+exports.merge = require_parser.merge;
+exports.message = require_message.message;
+exports.metavar = require_message.metavar;
+exports.multiple = require_parser.multiple;
+exports.normalizeUsage = require_usage.normalizeUsage;
+exports.object = require_parser.object;
+exports.option = require_parser.option;
+exports.optionName = require_message.optionName;
+exports.optionNames = require_message.optionNames;
+exports.optional = require_parser.optional;
+exports.or = require_parser.or;
+exports.parse = require_parser.parse;
+exports.run = require_facade.run;
+exports.string = require_valueparser.string;
+exports.text = require_message.text;
+exports.tuple = require_parser.tuple;
+exports.url = require_valueparser.url;
+exports.uuid = require_valueparser.uuid;
+exports.value = require_message.value;
+exports.values = require_message.values;
+exports.withDefault = require_parser.withDefault;

package/dist/index.d.cts

@@ -0,0 +1,7 @@
+import { Message, MessageFormatOptions, MessageTerm, formatMessage, message, metavar, optionName, optionNames, text, value, values } from "./message.cjs";
+import { OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, formatUsage, formatUsageTerm, normalizeUsage } from "./usage.cjs";
+import { DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, formatDocPage } from "./doc.cjs";
+import { ChoiceOptions, FloatOptions, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, StringOptions, UrlOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, choice, float, integer, isValueParser, locale, string, url, uuid } from "./valueparser.cjs";
+import { ArgumentOptions, CommandOptions, InferValue, MultipleOptions, OptionOptions, Parser, ParserContext, ParserResult, Result, argument, command, constant, getDocPage, merge, multiple, object, option, optional, or, parse, tuple, withDefault } from "./parser.cjs";
+import { RunError, RunOptions, run } from "./facade.cjs";
+export { ArgumentOptions, ChoiceOptions, CommandOptions, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, FloatOptions, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, Message, MessageFormatOptions, MessageTerm, MultipleOptions, OptionName, OptionOptions, Parser, ParserContext, ParserResult, Result, RunError, RunOptions, StringOptions, UrlOptions, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, argument, choice, command, constant, float, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getDocPage, integer, isValueParser, locale, merge, message, metavar, multiple, normalizeUsage, object, option, optionName, optionNames, optional, or, parse, run, string, text, tuple, url, uuid, value, values, withDefault };

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { Message, MessageFormatOptions, MessageTerm, formatMessage, message, metavar, optionName, optionNames, text, value, values } from "./message.js";
+import { OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, formatUsage, formatUsageTerm, normalizeUsage } from "./usage.js";
+import { DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, formatDocPage } from "./doc.js";
+import { ChoiceOptions, FloatOptions, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, StringOptions, UrlOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, choice, float, integer, isValueParser, locale, string, url, uuid } from "./valueparser.js";
+import { ArgumentOptions, CommandOptions, InferValue, MultipleOptions, OptionOptions, Parser, ParserContext, ParserResult, Result, argument, command, constant, getDocPage, merge, multiple, object, option, optional, or, parse, tuple, withDefault } from "./parser.js";
+import { RunError, RunOptions, run } from "./facade.js";
+export { ArgumentOptions, ChoiceOptions, CommandOptions, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, FloatOptions, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, Message, MessageFormatOptions, MessageTerm, MultipleOptions, OptionName, OptionOptions, Parser, ParserContext, ParserResult, Result, RunError, RunOptions, StringOptions, UrlOptions, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, argument, choice, command, constant, float, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getDocPage, integer, isValueParser, locale, merge, message, metavar, multiple, normalizeUsage, object, option, optionName, optionNames, optional, or, parse, run, string, text, tuple, url, uuid, value, values, withDefault };

package/dist/index.js

@@ -0,0 +1,8 @@
+import { formatMessage, message, metavar, optionName, optionNames, text, value, values } from "./message.js";
+import { formatUsage, formatUsageTerm, normalizeUsage } from "./usage.js";
+import { formatDocPage } from "./doc.js";
+import { choice, float, integer, isValueParser, locale, string, url, uuid } from "./valueparser.js";
+import { argument, command, constant, getDocPage, merge, multiple, object, option, optional, or, parse, tuple, withDefault } from "./parser.js";
+import { RunError, run } from "./facade.js";
+
+export { RunError, argument, choice, command, constant, float, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getDocPage, integer, isValueParser, locale, merge, message, metavar, multiple, normalizeUsage, object, option, optionName, optionNames, optional, or, parse, run, string, text, tuple, url, uuid, value, values, withDefault };

package/dist/message.cjs

@@ -0,0 +1,202 @@
+
+//#region src/message.ts
+/**
+* Creates a structured message with template strings and values.
+*
+* This function allows creating messages where specific values can be
+* highlighted or styled differently when displayed to the user.
+*
+* @example
+* ```typescript
+* const error = message`Expected number between ${min} and ${max}, got ${value}`;
+* const concat = message`${optionName("--age")}: ${error}`;
+* ```
+*
+* @param message Template strings array (from template literal).
+* @param values Values to be interpolated into the template.
+* @returns A structured Message object.
+*/
+function message(message$1, ...values$1) {
+	const messageTerms = [];
+	for (let i = 0; i < message$1.length; i++) {
+		if (message$1[i] !== "") messageTerms.push({
+			type: "text",
+			text: message$1[i]
+		});
+		if (i >= values$1.length) continue;
+		const value$1 = values$1[i];
+		if (typeof value$1 === "string") messageTerms.push({
+			type: "value",
+			value: value$1
+		});
+		else if (Array.isArray(value$1)) messageTerms.push(...value$1);
+		else if (typeof value$1 === "object" && value$1 != null && "type" in value$1) messageTerms.push(value$1);
+		else throw new TypeError(`Invalid value type in message: ${typeof value$1}.`);
+	}
+	return messageTerms;
+}
+/**
+* Creates a {@link MessageTerm} for plain text.  Usually used for
+* dynamically generated messages.
+* @param text The plain text to be included in the message.
+* @returns A {@link MessageTerm} representing the plain text.
+*/
+function text(text$1) {
+	return {
+		type: "text",
+		text: text$1
+	};
+}
+/**
+* Creates a {@link MessageTerm} for an option name.
+* @param name The name of the option, which can be a short or long option name.
+*             For example, `"-f"` or `"--foo"`.
+* @returns A {@link MessageTerm} representing the option name.
+*/
+function optionName(name) {
+	return {
+		type: "optionName",
+		optionName: name
+	};
+}
+/**
+* Creates a {@link MessageTerm} for a list of option names.
+* @param names The list of option names, which can include both short and long
+*              option names. For example, `["--foo", "--bar"]`.
+* @returns A {@link MessageTerm} representing the list of option names.
+*/
+function optionNames(names) {
+	return {
+		type: "optionNames",
+		optionNames: names
+	};
+}
+/**
+* Creates a {@link MessageTerm} for a metavariable.
+* @param metavar The metavariable name, which is a string that represents
+*                a variable in the message. For example, `"VALUE"` or
+*                `"ARG"`.
+* @returns A {@link MessageTerm} representing the metavariable.
+*/
+function metavar(metavar$1) {
+	return {
+		type: "metavar",
+		metavar: metavar$1
+	};
+}
+/**
+* Creates a {@link MessageTerm} for a single value.  However, you usually
+* don't need to use this function directly, as {@link message} string template
+* will automatically create a {@link MessageTerm} for a value when
+* you use a string in a template literal.
+* @param value The value, which can be any string representation of a value.
+*              For example, `"42"` or `"hello"`.
+* @returns A {@link MessageTerm} representing the value.
+*/
+function value(value$1) {
+	return {
+		type: "value",
+		value: value$1
+	};
+}
+/**
+* Creates a {@link MessageTerm} for a list of consecutive values.
+* @param values The list of consecutive values, which can include multiple
+*               string representations of consecutive values.
+*               For example, `["42", "hello"]`.
+* @returns A {@link MessageTerm} representing the list of values.
+*/
+function values(values$1) {
+	return {
+		type: "values",
+		values: values$1
+	};
+}
+/**
+* Formats a {@link Message} into a human-readable string for
+* the terminal.
+* @param msg The message to format, which is an array of
+*              {@link MessageTerm} objects.
+* @param options Optional formatting options to customize the output.
+* @returns A formatted string representation of the message.
+*/
+function formatMessage(msg, options = {}) {
+	const useColors = options.colors ?? false;
+	const useQuotes = options.quotes ?? true;
+	function* stream() {
+		const wordPattern = /\s*\S+\s*/g;
+		for (const term of msg) if (term.type === "text") while (true) {
+			const match = wordPattern.exec(term.text);
+			if (match == null) break;
+			yield {
+				text: match[0],
+				width: match[0].length
+			};
+		}
+		else if (term.type === "optionName") {
+			const name = useQuotes ? `\`${term.optionName}\`` : term.optionName;
+			yield {
+				text: useColors ? `\x1b[3m${name}\x1b[0m` : name,
+				width: name.length
+			};
+		} else if (term.type === "optionNames") {
+			const names = term.optionNames.map((name) => useQuotes ? `\`${name}\`` : name);
+			let i = 0;
+			for (const name of names) {
+				if (i > 0) yield {
+					text: "/",
+					width: 1
+				};
+				yield {
+					text: useColors ? `\x1b[3m${name}\x1b[0m` : name,
+					width: name.length
+				};
+				i++;
+			}
+		} else if (term.type === "metavar") {
+			const metavar$1 = useQuotes ? `\`${term.metavar}\`` : term.metavar;
+			yield {
+				text: useColors ? `\x1b[1m${metavar$1}\x1b[0m` : metavar$1,
+				width: metavar$1.length
+			};
+		} else if (term.type === "value") {
+			const value$1 = useQuotes ? `${JSON.stringify(term.value)}` : term.value;
+			yield {
+				text: useColors ? `\x1b[32m${value$1}\x1b[0m` : value$1,
+				width: value$1.length
+			};
+		} else if (term.type === "values") for (let i = 0; i < term.values.length; i++) {
+			if (i > 0) yield {
+				text: " ",
+				width: 1
+			};
+			const value$1 = useQuotes ? JSON.stringify(term.values[i]) : term.values[i];
+			yield {
+				text: useColors ? i <= 0 ? `\x1b[32m${value$1}` : i + 1 >= term.values.length ? `${value$1}\x1b[0m` : value$1 : value$1,
+				width: value$1.length
+			};
+		}
+		else throw new TypeError(`Invalid MessageTerm type: ${term["type"]}.`);
+	}
+	let output = "";
+	let totalWidth = 0;
+	for (const { text: text$1, width } of stream()) {
+		if (options.maxWidth != null && totalWidth + width > options.maxWidth) {
+			output += "\n";
+			totalWidth = 0;
+		}
+		output += text$1;
+		totalWidth += width;
+	}
+	return output;
+}
+
+//#endregion
+exports.formatMessage = formatMessage;
+exports.message = message;
+exports.metavar = metavar;
+exports.optionName = optionName;
+exports.optionNames = optionNames;
+exports.text = text;
+exports.value = value;
+exports.values = values;

package/dist/message.d.cts

@@ -0,0 +1,199 @@
+//#region src/message.d.ts
+/**
+ * Represents a single term in a message, which can be a text, an option
+ * name, a list of option names, a metavariable, a value, or a list of
+ * consecutive values.
+ */
+type MessageTerm =
+/**
+ * A plain text term in the message.
+ */
+{
+  /**
+   * The type of the term, which is always `"text"` for plain text.
+   */
+  readonly type: "text";
+  /**
+   * The text content of the term.
+   */
+  readonly text: string;
+}
+/**
+ * An option name term in the message, which can be a single
+ * option name.  Although it is named option name, it can also
+ * represent a subcommand.
+ */ | {
+  /**
+   * The type of the term, which is `"optionName"` for a single option name.
+   */
+  readonly type: "optionName";
+  /**
+   * The name of the option, which can be a short or long option name.
+   * For example, `"-f"` or `"--foo"`.
+   */
+  readonly optionName: string;
+}
+/**
+ * A list of option names term in the message, which can be a
+ * list of option names.
+ */ | {
+  /**
+   * The type of the term, which is `"optionNames"` for a list of option
+   * names.
+   */
+  readonly type: "optionNames";
+  /**
+   * The list of option names, which can include both short and long
+   * option names.  For example, `["--foo", "--bar"]`.
+   */
+  readonly optionNames: readonly string[];
+}
+/**
+ * A metavariable term in the message, which can be a single
+ * metavariable.
+ */ | {
+  /**
+   * The type of the term, which is `"metavar"` for a metavariable.
+   */
+  readonly type: "metavar";
+  /**
+   * The metavariable name, which is a string that represents
+   * a variable in the message.  For example, `"VALUE"` or `"ARG"`.
+   */
+  readonly metavar: string;
+}
+/**
+ * A value term in the message, which can be a single value.
+ */ | {
+  /**
+   * The type of the term, which is `"value"` for a single value.
+   */
+  readonly type: "value";
+  /**
+   * The value, which can be any string representation of a value.
+   * For example, `"42"` or `"hello"`.
+   */
+  readonly value: string;
+}
+/**
+ * A list of values term in the message, which can be a
+ * list of values.
+ */ | {
+  /**
+   * The type of the term, which is `"values"` for a list of consecutive
+   * values.
+   */
+  readonly type: "values";
+  /**
+   * The list of values, which can include multiple string
+   * representations of consecutive values.  For example, `["42", "hello"]`.
+   */
+  readonly values: readonly string[];
+};
+/**
+ * Type representing a message that can include styled/colored values.
+ * This type is used to create structured messages that can be
+ * displayed to the user with specific formatting.
+ */
+type Message = readonly MessageTerm[];
+/**
+ * Creates a structured message with template strings and values.
+ *
+ * This function allows creating messages where specific values can be
+ * highlighted or styled differently when displayed to the user.
+ *
+ * @example
+ * ```typescript
+ * const error = message`Expected number between ${min} and ${max}, got ${value}`;
+ * const concat = message`${optionName("--age")}: ${error}`;
+ * ```
+ *
+ * @param message Template strings array (from template literal).
+ * @param values Values to be interpolated into the template.
+ * @returns A structured Message object.
+ */
+declare function message(message: TemplateStringsArray, ...values: readonly (MessageTerm | Message | string)[]): Message;
+/**
+ * Creates a {@link MessageTerm} for plain text.  Usually used for
+ * dynamically generated messages.
+ * @param text The plain text to be included in the message.
+ * @returns A {@link MessageTerm} representing the plain text.
+ */
+declare function text(text: string): MessageTerm;
+/**
+ * Creates a {@link MessageTerm} for an option name.
+ * @param name The name of the option, which can be a short or long option name.
+ *             For example, `"-f"` or `"--foo"`.
+ * @returns A {@link MessageTerm} representing the option name.
+ */
+declare function optionName(name: string): MessageTerm;
+/**
+ * Creates a {@link MessageTerm} for a list of option names.
+ * @param names The list of option names, which can include both short and long
+ *              option names. For example, `["--foo", "--bar"]`.
+ * @returns A {@link MessageTerm} representing the list of option names.
+ */
+declare function optionNames(names: readonly string[]): MessageTerm;
+/**
+ * Creates a {@link MessageTerm} for a metavariable.
+ * @param metavar The metavariable name, which is a string that represents
+ *                a variable in the message. For example, `"VALUE"` or
+ *                `"ARG"`.
+ * @returns A {@link MessageTerm} representing the metavariable.
+ */
+declare function metavar(metavar: string): MessageTerm;
+/**
+ * Creates a {@link MessageTerm} for a single value.  However, you usually
+ * don't need to use this function directly, as {@link message} string template
+ * will automatically create a {@link MessageTerm} for a value when
+ * you use a string in a template literal.
+ * @param value The value, which can be any string representation of a value.
+ *              For example, `"42"` or `"hello"`.
+ * @returns A {@link MessageTerm} representing the value.
+ */
+declare function value(value: string): MessageTerm;
+/**
+ * Creates a {@link MessageTerm} for a list of consecutive values.
+ * @param values The list of consecutive values, which can include multiple
+ *               string representations of consecutive values.
+ *               For example, `["42", "hello"]`.
+ * @returns A {@link MessageTerm} representing the list of values.
+ */
+declare function values(values: readonly string[]): MessageTerm;
+/**
+ * Options for the {@link formatMessage} function.
+ */
+interface MessageFormatOptions {
+  /**
+   * Whether to use colors in the formatted message.  If `true`,
+   * the formatted message will include ANSI escape codes for colors.
+   * If `false`, the message will be plain text without colors.
+   * @default `false`
+   */
+  readonly colors?: boolean;
+  /**
+   * Whether to use quotes around values in the formatted message.
+   * If `true`, values will be wrapped in quotes (e.g., `"value"`).
+   * If `false`, values will be displayed without quotes.
+   * @default `true`
+   */
+  readonly quotes?: boolean;
+  /**
+   * The maximum width of the formatted message.  If specified,
+   * the message will be wrapped to fit within this width.
+   * If not specified, the message will not be wrapped.
+   * @default `undefined`
+   */
+  readonly maxWidth?: number;
+}
+/**
+ * Formats a {@link Message} into a human-readable string for
+ * the terminal.
+ * @param msg The message to format, which is an array of
+ *              {@link MessageTerm} objects.
+ * @param options Optional formatting options to customize the output.
+ * @returns A formatted string representation of the message.
+ */
+declare function formatMessage(msg: Message, options?: MessageFormatOptions): string;
+//#endregion
+export { Message, MessageFormatOptions, MessageTerm, formatMessage, message, metavar, optionName, optionNames, text, value, values };

package/dist/message.d.ts

@@ -0,0 +1,199 @@
+//#region src/message.d.ts
+/**
+ * Represents a single term in a message, which can be a text, an option
+ * name, a list of option names, a metavariable, a value, or a list of
+ * consecutive values.
+ */
+type MessageTerm =
+/**
+ * A plain text term in the message.
+ */
+{
+  /**
+   * The type of the term, which is always `"text"` for plain text.
+   */
+  readonly type: "text";
+  /**
+   * The text content of the term.
+   */
+  readonly text: string;
+}
+/**
+ * An option name term in the message, which can be a single
+ * option name.  Although it is named option name, it can also
+ * represent a subcommand.
+ */ | {
+  /**
+   * The type of the term, which is `"optionName"` for a single option name.
+   */
+  readonly type: "optionName";
+  /**
+   * The name of the option, which can be a short or long option name.
+   * For example, `"-f"` or `"--foo"`.
+   */
+  readonly optionName: string;
+}
+/**
+ * A list of option names term in the message, which can be a
+ * list of option names.
+ */ | {
+  /**
+   * The type of the term, which is `"optionNames"` for a list of option
+   * names.
+   */
+  readonly type: "optionNames";
+  /**
+   * The list of option names, which can include both short and long
+   * option names.  For example, `["--foo", "--bar"]`.
+   */
+  readonly optionNames: readonly string[];
+}
+/**
+ * A metavariable term in the message, which can be a single
+ * metavariable.
+ */ | {
+  /**
+   * The type of the term, which is `"metavar"` for a metavariable.
+   */
+  readonly type: "metavar";
+  /**
+   * The metavariable name, which is a string that represents
+   * a variable in the message.  For example, `"VALUE"` or `"ARG"`.
+   */
+  readonly metavar: string;
+}
+/**
+ * A value term in the message, which can be a single value.
+ */ | {
+  /**
+   * The type of the term, which is `"value"` for a single value.
+   */
+  readonly type: "value";
+  /**
+   * The value, which can be any string representation of a value.
+   * For example, `"42"` or `"hello"`.
+   */
+  readonly value: string;
+}
+/**
+ * A list of values term in the message, which can be a
+ * list of values.
+ */ | {
+  /**
+   * The type of the term, which is `"values"` for a list of consecutive
+   * values.
+   */
+  readonly type: "values";
+  /**
+   * The list of values, which can include multiple string
+   * representations of consecutive values.  For example, `["42", "hello"]`.
+   */
+  readonly values: readonly string[];
+};
+/**
+ * Type representing a message that can include styled/colored values.
+ * This type is used to create structured messages that can be
+ * displayed to the user with specific formatting.
+ */
+type Message = readonly MessageTerm[];
+/**
+ * Creates a structured message with template strings and values.
+ *
+ * This function allows creating messages where specific values can be
+ * highlighted or styled differently when displayed to the user.
+ *
+ * @example
+ * ```typescript
+ * const error = message`Expected number between ${min} and ${max}, got ${value}`;
+ * const concat = message`${optionName("--age")}: ${error}`;
+ * ```
+ *
+ * @param message Template strings array (from template literal).
+ * @param values Values to be interpolated into the template.
+ * @returns A structured Message object.
+ */
+declare function message(message: TemplateStringsArray, ...values: readonly (MessageTerm | Message | string)[]): Message;
+/**
+ * Creates a {@link MessageTerm} for plain text.  Usually used for
+ * dynamically generated messages.
+ * @param text The plain text to be included in the message.
+ * @returns A {@link MessageTerm} representing the plain text.
+ */
+declare function text(text: string): MessageTerm;
+/**
+ * Creates a {@link MessageTerm} for an option name.
+ * @param name The name of the option, which can be a short or long option name.
+ *             For example, `"-f"` or `"--foo"`.
+ * @returns A {@link MessageTerm} representing the option name.
+ */
+declare function optionName(name: string): MessageTerm;
+/**
+ * Creates a {@link MessageTerm} for a list of option names.
+ * @param names The list of option names, which can include both short and long
+ *              option names. For example, `["--foo", "--bar"]`.
+ * @returns A {@link MessageTerm} representing the list of option names.
+ */
+declare function optionNames(names: readonly string[]): MessageTerm;
+/**
+ * Creates a {@link MessageTerm} for a metavariable.
+ * @param metavar The metavariable name, which is a string that represents
+ *                a variable in the message. For example, `"VALUE"` or
+ *                `"ARG"`.
+ * @returns A {@link MessageTerm} representing the metavariable.
+ */
+declare function metavar(metavar: string): MessageTerm;
+/**
+ * Creates a {@link MessageTerm} for a single value.  However, you usually
+ * don't need to use this function directly, as {@link message} string template
+ * will automatically create a {@link MessageTerm} for a value when
+ * you use a string in a template literal.
+ * @param value The value, which can be any string representation of a value.
+ *              For example, `"42"` or `"hello"`.
+ * @returns A {@link MessageTerm} representing the value.
+ */
+declare function value(value: string): MessageTerm;
+/**
+ * Creates a {@link MessageTerm} for a list of consecutive values.
+ * @param values The list of consecutive values, which can include multiple
+ *               string representations of consecutive values.
+ *               For example, `["42", "hello"]`.
+ * @returns A {@link MessageTerm} representing the list of values.
+ */
+declare function values(values: readonly string[]): MessageTerm;
+/**
+ * Options for the {@link formatMessage} function.
+ */
+interface MessageFormatOptions {
+  /**
+   * Whether to use colors in the formatted message.  If `true`,
+   * the formatted message will include ANSI escape codes for colors.
+   * If `false`, the message will be plain text without colors.
+   * @default `false`
+   */
+  readonly colors?: boolean;
+  /**
+   * Whether to use quotes around values in the formatted message.
+   * If `true`, values will be wrapped in quotes (e.g., `"value"`).
+   * If `false`, values will be displayed without quotes.
+   * @default `true`
+   */
+  readonly quotes?: boolean;
+  /**
+   * The maximum width of the formatted message.  If specified,
+   * the message will be wrapped to fit within this width.
+   * If not specified, the message will not be wrapped.
+   * @default `undefined`
+   */
+  readonly maxWidth?: number;
+}
+/**
+ * Formats a {@link Message} into a human-readable string for
+ * the terminal.
+ * @param msg The message to format, which is an array of
+ *              {@link MessageTerm} objects.
+ * @param options Optional formatting options to customize the output.
+ * @returns A formatted string representation of the message.
+ */
+declare function formatMessage(msg: Message, options?: MessageFormatOptions): string;
+//#endregion
+export { Message, MessageFormatOptions, MessageTerm, formatMessage, message, metavar, optionName, optionNames, text, value, values };