@optique/core 0.9.0-dev.175 → 0.9.0-dev.176

package/README.md

@@ -37,7 +37,7 @@ Quick example
 -------------
 
 ~~~~ typescript
-import { run } from "@optique/core/facade";
+import { runParser } from "@optique/core/facade";
 import { object, option, argument } from "@optique/core/parser";
 import { string, integer } from "@optique/core/valueparser";
 import process from "node:process";
@@ -48,7 +48,7 @@ const parser = object({
   verbose: option("-v", "--verbose"),
 });
 
-const config = run(parser, "myapp", process.argv.slice(2), {
+const config = runParser(parser, "myapp", process.argv.slice(2), {
   help: "both",
   onError: process.exit,
 });

package/dist/facade.cjs

@@ -416,11 +416,12 @@ function handleCompletion(completionArgs, programName, parser, completionParser,
 * @param options Configuration options for output formatting and callbacks.
 * @returns The parsed result value, or the return value of `onHelp`/`onError`
 *          callbacks.
-* @throws {RunError} When parsing fails and no `onError` callback is provided.
+* @throws {RunParserError} When parsing fails and no `onError` callback is
+*          provided.
 */
-function run(parser, programName, args, options = {}) {
+function runParser(parser, programName, args, options = {}) {
 	let { colors, maxWidth, showDefault, aboveError = "usage", onError = () => {
-		throw new RunError("Failed to parse command line arguments.");
+		throw new RunParserError("Failed to parse command line arguments.");
 	}, stderr = console.error, stdout = console.log, brief, description, footer } = options;
 	const helpMode = options.help?.mode ?? "option";
 	const onHelp = options.help?.onShow ?? (() => ({}));
@@ -490,7 +491,7 @@ function run(parser, programName, args, options = {}) {
 			} catch {
 				return onVersion();
 			}
-		case "completion": throw new RunError("Completion should be handled by early return");
+		case "completion": throw new RunParserError("Completion should be handled by early return");
 		case "help": {
 			let helpGeneratorParser;
 			const helpAsCommand = help === "command" || help === "both";
@@ -566,23 +567,37 @@ function run(parser, programName, args, options = {}) {
 			stderr(`Error: ${errorMessage}`);
 			return onError(1);
 		}
-		default: throw new RunError("Unexpected parse result type");
+		default: throw new RunParserError("Unexpected parse result type");
 	}
 }
 /**
+* @deprecated Use `runParser()` instead. This export will be removed in
+*             a future major version. The name `run` conflicts with
+*             `@optique/run`'s `run()` function, causing IDE autocomplete
+*             confusion.
+*/
+const run = runParser;
+/**
 * An error class used to indicate that the command line arguments
 * could not be parsed successfully.
 */
-var RunError = class extends Error {
+var RunParserError = class extends Error {
 	constructor(message$1) {
 		super(message$1);
-		this.name = "RunError";
+		this.name = "RunParserError";
 	}
 };
+/**
+* @deprecated Use `RunParserError` instead. This export will be removed in
+*             a future major version.
+*/
+const RunError = RunParserError;
 function indentLines(text$1, indent) {
 	return text$1.split("\n").join("\n" + " ".repeat(indent));
 }
 
 //#endregion
 exports.RunError = RunError;
-exports.run = run;
+exports.RunParserError = RunParserError;
+exports.run = run;
+exports.runParser = runParser;

package/dist/facade.d.cts

@@ -211,15 +211,28 @@ interface RunOptions<THelp, TError> {
  * @param options Configuration options for output formatting and callbacks.
  * @returns The parsed result value, or the return value of `onHelp`/`onError`
  *          callbacks.
- * @throws {RunError} When parsing fails and no `onError` callback is provided.
+ * @throws {RunParserError} When parsing fails and no `onError` callback is
+ *          provided.
  */
-declare function run<TParser extends Parser<unknown, unknown>, THelp = void, TError = never>(parser: TParser, programName: string, args: readonly string[], options?: RunOptions<THelp, TError>): InferValue<TParser>;
+declare function runParser<TParser extends Parser<unknown, unknown>, THelp = void, TError = never>(parser: TParser, programName: string, args: readonly string[], options?: RunOptions<THelp, TError>): InferValue<TParser>;
+/**
+ * @deprecated Use `runParser()` instead. This export will be removed in
+ *             a future major version. The name `run` conflicts with
+ *             `@optique/run`'s `run()` function, causing IDE autocomplete
+ *             confusion.
+ */
+declare const run: typeof runParser;
 /**
  * An error class used to indicate that the command line arguments
  * could not be parsed successfully.
  */
-declare class RunError extends Error {
+declare class RunParserError extends Error {
   constructor(message: string);
 }
+/**
+ * @deprecated Use `RunParserError` instead. This export will be removed in
+ *             a future major version.
+ */
+declare const RunError: typeof RunParserError;
 //#endregion
-export { RunError, RunOptions, run };
+export { RunError, RunOptions, RunParserError, run, runParser };

package/dist/facade.d.ts

@@ -211,15 +211,28 @@ interface RunOptions<THelp, TError> {
  * @param options Configuration options for output formatting and callbacks.
  * @returns The parsed result value, or the return value of `onHelp`/`onError`
  *          callbacks.
- * @throws {RunError} When parsing fails and no `onError` callback is provided.
+ * @throws {RunParserError} When parsing fails and no `onError` callback is
+ *          provided.
  */
-declare function run<TParser extends Parser<unknown, unknown>, THelp = void, TError = never>(parser: TParser, programName: string, args: readonly string[], options?: RunOptions<THelp, TError>): InferValue<TParser>;
+declare function runParser<TParser extends Parser<unknown, unknown>, THelp = void, TError = never>(parser: TParser, programName: string, args: readonly string[], options?: RunOptions<THelp, TError>): InferValue<TParser>;
+/**
+ * @deprecated Use `runParser()` instead. This export will be removed in
+ *             a future major version. The name `run` conflicts with
+ *             `@optique/run`'s `run()` function, causing IDE autocomplete
+ *             confusion.
+ */
+declare const run: typeof runParser;
 /**
  * An error class used to indicate that the command line arguments
  * could not be parsed successfully.
  */
-declare class RunError extends Error {
+declare class RunParserError extends Error {
   constructor(message: string);
 }
+/**
+ * @deprecated Use `RunParserError` instead. This export will be removed in
+ *             a future major version.
+ */
+declare const RunError: typeof RunParserError;
 //#endregion
-export { RunError, RunOptions, run };
+export { RunError, RunOptions, RunParserError, run, runParser };

package/dist/facade.js

@@ -416,11 +416,12 @@ function handleCompletion(completionArgs, programName, parser, completionParser,
 * @param options Configuration options for output formatting and callbacks.
 * @returns The parsed result value, or the return value of `onHelp`/`onError`
 *          callbacks.
-* @throws {RunError} When parsing fails and no `onError` callback is provided.
+* @throws {RunParserError} When parsing fails and no `onError` callback is
+*          provided.
 */
-function run(parser, programName, args, options = {}) {
+function runParser(parser, programName, args, options = {}) {
 	let { colors, maxWidth, showDefault, aboveError = "usage", onError = () => {
-		throw new RunError("Failed to parse command line arguments.");
+		throw new RunParserError("Failed to parse command line arguments.");
 	}, stderr = console.error, stdout = console.log, brief, description, footer } = options;
 	const helpMode = options.help?.mode ?? "option";
 	const onHelp = options.help?.onShow ?? (() => ({}));
@@ -490,7 +491,7 @@ function run(parser, programName, args, options = {}) {
 			} catch {
 				return onVersion();
 			}
-		case "completion": throw new RunError("Completion should be handled by early return");
+		case "completion": throw new RunParserError("Completion should be handled by early return");
 		case "help": {
 			let helpGeneratorParser;
 			const helpAsCommand = help === "command" || help === "both";
@@ -566,22 +567,34 @@ function run(parser, programName, args, options = {}) {
 			stderr(`Error: ${errorMessage}`);
 			return onError(1);
 		}
-		default: throw new RunError("Unexpected parse result type");
+		default: throw new RunParserError("Unexpected parse result type");
 	}
 }
 /**
+* @deprecated Use `runParser()` instead. This export will be removed in
+*             a future major version. The name `run` conflicts with
+*             `@optique/run`'s `run()` function, causing IDE autocomplete
+*             confusion.
+*/
+const run = runParser;
+/**
 * An error class used to indicate that the command line arguments
 * could not be parsed successfully.
 */
-var RunError = class extends Error {
+var RunParserError = class extends Error {
 	constructor(message$1) {
 		super(message$1);
-		this.name = "RunError";
+		this.name = "RunParserError";
 	}
 };
+/**
+* @deprecated Use `RunParserError` instead. This export will be removed in
+*             a future major version.
+*/
+const RunError = RunParserError;
 function indentLines(text$1, indent) {
 	return text$1.split("\n").join("\n" + " ".repeat(indent));
 }
 
 //#endregion
-export { RunError, run };
+export { RunError, RunParserError, run, runParser };

package/dist/index.cjs

@@ -11,6 +11,7 @@ const require_facade = require('./facade.cjs');
 
 exports.DuplicateOptionError = require_constructs.DuplicateOptionError;
 exports.RunError = require_facade.RunError;
+exports.RunParserError = require_facade.RunParserError;
 exports.WithDefaultError = require_modifiers.WithDefaultError;
 exports.argument = require_primitives.argument;
 exports.bash = require_completion.bash;
@@ -54,6 +55,7 @@ exports.parse = require_parser.parse;
 exports.passThrough = require_primitives.passThrough;
 exports.pwsh = require_completion.pwsh;
 exports.run = require_facade.run;
+exports.runParser = require_facade.runParser;
 exports.string = require_valueparser.string;
 exports.suggest = require_parser.suggest;
 exports.text = require_message.text;

package/dist/index.d.cts

@@ -7,5 +7,5 @@ import { ArgumentErrorOptions, ArgumentOptions, CommandErrorOptions, CommandOpti
 import { DocState, InferValue, Parser, ParserContext, ParserResult, Result, Suggestion, getDocPage, parse, suggest } from "./parser.cjs";
 import { ConditionalErrorOptions, ConditionalOptions, DuplicateOptionError, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, NoMatchContext, ObjectErrorOptions, ObjectOptions, OrErrorOptions, OrOptions, TupleOptions, concat, conditional, group, longestMatch, merge, object, or, tuple } from "./constructs.cjs";
 import { ShellCompletion, bash, fish, nu, pwsh, zsh } from "./completion.cjs";
-import { RunError, RunOptions, run } from "./facade.cjs";
-export { ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, CommandErrorOptions, CommandOptions, ConditionalErrorOptions, ConditionalOptions, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, DuplicateOptionError, FlagErrorOptions, FlagOptions, FloatOptions, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, Message, MessageFormatOptions, MessageTerm, MultipleErrorOptions, MultipleOptions, NoMatchContext, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OrErrorOptions, OrOptions, Parser, ParserContext, ParserResult, PassThroughFormat, PassThroughOptions, Result, RunError, RunOptions, ShellCompletion, ShowDefaultOptions, StringOptions, Suggestion, TupleOptions, UrlOptions, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, WithDefaultError, WithDefaultOptions, argument, bash, choice, command, commandLine, concat, conditional, constant, envVar, extractArgumentMetavars, extractCommandNames, extractOptionNames, fish, flag, float, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getDocPage, group, integer, isValueParser, locale, longestMatch, map, merge, message, metavar, multiple, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, passThrough, pwsh, run, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };
+import { RunError, RunOptions, RunParserError, run, runParser } from "./facade.cjs";
+export { ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, CommandErrorOptions, CommandOptions, ConditionalErrorOptions, ConditionalOptions, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, DuplicateOptionError, FlagErrorOptions, FlagOptions, FloatOptions, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, Message, MessageFormatOptions, MessageTerm, MultipleErrorOptions, MultipleOptions, NoMatchContext, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OrErrorOptions, OrOptions, Parser, ParserContext, ParserResult, PassThroughFormat, PassThroughOptions, Result, RunError, RunOptions, RunParserError, ShellCompletion, ShowDefaultOptions, StringOptions, Suggestion, TupleOptions, UrlOptions, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, WithDefaultError, WithDefaultOptions, argument, bash, choice, command, commandLine, concat, conditional, constant, envVar, extractArgumentMetavars, extractCommandNames, extractOptionNames, fish, flag, float, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getDocPage, group, integer, isValueParser, locale, longestMatch, map, merge, message, metavar, multiple, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, passThrough, pwsh, run, runParser, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };

package/dist/index.d.ts

@@ -7,5 +7,5 @@ import { ArgumentErrorOptions, ArgumentOptions, CommandErrorOptions, CommandOpti
 import { DocState, InferValue, Parser, ParserContext, ParserResult, Result, Suggestion, getDocPage, parse, suggest } from "./parser.js";
 import { ConditionalErrorOptions, ConditionalOptions, DuplicateOptionError, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, NoMatchContext, ObjectErrorOptions, ObjectOptions, OrErrorOptions, OrOptions, TupleOptions, concat, conditional, group, longestMatch, merge, object, or, tuple } from "./constructs.js";
 import { ShellCompletion, bash, fish, nu, pwsh, zsh } from "./completion.js";
-import { RunError, RunOptions, run } from "./facade.js";
-export { ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, CommandErrorOptions, CommandOptions, ConditionalErrorOptions, ConditionalOptions, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, DuplicateOptionError, FlagErrorOptions, FlagOptions, FloatOptions, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, Message, MessageFormatOptions, MessageTerm, MultipleErrorOptions, MultipleOptions, NoMatchContext, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OrErrorOptions, OrOptions, Parser, ParserContext, ParserResult, PassThroughFormat, PassThroughOptions, Result, RunError, RunOptions, ShellCompletion, ShowDefaultOptions, StringOptions, Suggestion, TupleOptions, UrlOptions, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, WithDefaultError, WithDefaultOptions, argument, bash, choice, command, commandLine, concat, conditional, constant, envVar, extractArgumentMetavars, extractCommandNames, extractOptionNames, fish, flag, float, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getDocPage, group, integer, isValueParser, locale, longestMatch, map, merge, message, metavar, multiple, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, passThrough, pwsh, run, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };
+import { RunError, RunOptions, RunParserError, run, runParser } from "./facade.js";
+export { ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, CommandErrorOptions, CommandOptions, ConditionalErrorOptions, ConditionalOptions, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, DuplicateOptionError, FlagErrorOptions, FlagOptions, FloatOptions, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, Message, MessageFormatOptions, MessageTerm, MultipleErrorOptions, MultipleOptions, NoMatchContext, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OrErrorOptions, OrOptions, Parser, ParserContext, ParserResult, PassThroughFormat, PassThroughOptions, Result, RunError, RunOptions, RunParserError, ShellCompletion, ShowDefaultOptions, StringOptions, Suggestion, TupleOptions, UrlOptions, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, WithDefaultError, WithDefaultOptions, argument, bash, choice, command, commandLine, concat, conditional, constant, envVar, extractArgumentMetavars, extractCommandNames, extractOptionNames, fish, flag, float, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getDocPage, group, integer, isValueParser, locale, longestMatch, map, merge, message, metavar, multiple, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, passThrough, pwsh, run, runParser, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };

package/dist/index.js

@@ -7,6 +7,6 @@ import { WithDefaultError, map, multiple, optional, withDefault } from "./modifi
 import { choice, float, integer, isValueParser, locale, string, url, uuid } from "./valueparser.js";
 import { argument, command, constant, flag, option, passThrough } from "./primitives.js";
 import { getDocPage, parse, suggest } from "./parser.js";
-import { RunError, run } from "./facade.js";
+import { RunError, RunParserError, run, runParser } from "./facade.js";
 
-export { DuplicateOptionError, RunError, WithDefaultError, argument, bash, choice, command, commandLine, concat, conditional, constant, envVar, extractArgumentMetavars, extractCommandNames, extractOptionNames, fish, flag, float, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getDocPage, group, integer, isValueParser, locale, longestMatch, map, merge, message, metavar, multiple, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, passThrough, pwsh, run, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };
+export { DuplicateOptionError, RunError, RunParserError, WithDefaultError, argument, bash, choice, command, commandLine, concat, conditional, constant, envVar, extractArgumentMetavars, extractCommandNames, extractOptionNames, fish, flag, float, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getDocPage, group, integer, isValueParser, locale, longestMatch, map, merge, message, metavar, multiple, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, passThrough, pwsh, run, runParser, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/core",
-  "version": "0.9.0-dev.175+64427b2f",
+  "version": "0.9.0-dev.176+1350294a",
   "description": "Type-safe combinatorial command-line interface parser",
   "keywords": [
     "CLI",