@optique/core 1.0.0-dev.1514 → 1.0.0-dev.1523
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/constructs.cjs +5 -0
- package/dist/constructs.d.cts +12 -0
- package/dist/constructs.d.ts +12 -0
- package/dist/constructs.js +5 -0
- package/dist/doc.cjs +3 -3
- package/dist/doc.d.cts +2 -2
- package/dist/doc.d.ts +2 -2
- package/dist/doc.js +4 -4
- package/dist/facade.cjs +39 -0
- package/dist/facade.js +41 -2
- package/dist/index.cjs +3 -0
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/usage.cjs +171 -6
- package/dist/usage.d.cts +75 -5
- package/dist/usage.d.ts +75 -5
- package/dist/usage.js +169 -7
- package/dist/validate.cjs +89 -0
- package/dist/validate.js +88 -1
- package/package.json +1 -1
package/dist/constructs.cjs
CHANGED
|
@@ -2,6 +2,7 @@ const require_annotations = require('./annotations.cjs');
|
|
|
2
2
|
const require_message = require('./message.cjs');
|
|
3
3
|
const require_dependency = require('./dependency.cjs');
|
|
4
4
|
const require_mode_dispatch = require('./mode-dispatch.cjs');
|
|
5
|
+
const require_validate = require('./validate.cjs');
|
|
5
6
|
const require_usage = require('./usage.cjs');
|
|
6
7
|
const require_doc = require('./doc.cjs');
|
|
7
8
|
const require_suggestion = require('./suggestion.cjs');
|
|
@@ -1001,6 +1002,7 @@ async function resolveDeferredParseStatesAsync(fieldStates, initialRegistry) {
|
|
|
1001
1002
|
}
|
|
1002
1003
|
function object(labelOrParsers, maybeParsersOrOptions, maybeOptions) {
|
|
1003
1004
|
const label = typeof labelOrParsers === "string" ? labelOrParsers : void 0;
|
|
1005
|
+
if (label != null) require_validate.validateLabel(label);
|
|
1004
1006
|
let parsers;
|
|
1005
1007
|
let options = {};
|
|
1006
1008
|
if (typeof labelOrParsers === "string") {
|
|
@@ -1410,6 +1412,7 @@ async function* suggestTupleAsync(context, prefix, parsers) {
|
|
|
1410
1412
|
}
|
|
1411
1413
|
function tuple(labelOrParsers, maybeParsersOrOptions, maybeOptions) {
|
|
1412
1414
|
const label = typeof labelOrParsers === "string" ? labelOrParsers : void 0;
|
|
1415
|
+
if (label != null) require_validate.validateLabel(label);
|
|
1413
1416
|
let parsers;
|
|
1414
1417
|
let options = {};
|
|
1415
1418
|
if (typeof labelOrParsers === "string") {
|
|
@@ -1723,6 +1726,7 @@ function tuple(labelOrParsers, maybeParsersOrOptions, maybeOptions) {
|
|
|
1723
1726
|
}
|
|
1724
1727
|
function merge(...args) {
|
|
1725
1728
|
const label = typeof args[0] === "string" ? args[0] : void 0;
|
|
1729
|
+
if (label != null) require_validate.validateLabel(label);
|
|
1726
1730
|
const lastArg = args[args.length - 1];
|
|
1727
1731
|
const hasOptions = lastArg != null && typeof lastArg === "object" && !("$valueType" in lastArg);
|
|
1728
1732
|
const options = hasOptions ? lastArg : {};
|
|
@@ -2481,6 +2485,7 @@ function concat(...parsers) {
|
|
|
2481
2485
|
};
|
|
2482
2486
|
}
|
|
2483
2487
|
function group(label, parser, options = {}) {
|
|
2488
|
+
require_validate.validateLabel(label);
|
|
2484
2489
|
const groupParser = {
|
|
2485
2490
|
$mode: parser.$mode,
|
|
2486
2491
|
$valueType: parser.$valueType,
|
package/dist/constructs.d.cts
CHANGED
|
@@ -1023,6 +1023,8 @@ declare function object<T extends {
|
|
|
1023
1023
|
* @returns A {@link Parser} that produces an object with the same keys as
|
|
1024
1024
|
* the input, where each value is the result of the corresponding
|
|
1025
1025
|
* parser.
|
|
1026
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1027
|
+
* whitespace-only, or contains control characters.
|
|
1026
1028
|
*/
|
|
1027
1029
|
declare function object<T extends {
|
|
1028
1030
|
readonly [key: string | symbol]: Parser<Mode, unknown, unknown>;
|
|
@@ -1040,6 +1042,8 @@ declare function object<T extends {
|
|
|
1040
1042
|
* @returns A {@link Parser} that produces an object with the same keys as
|
|
1041
1043
|
* the input, where each value is the result of the corresponding
|
|
1042
1044
|
* parser.
|
|
1045
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1046
|
+
* whitespace-only, or contains control characters.
|
|
1043
1047
|
* @since 0.5.0
|
|
1044
1048
|
*/
|
|
1045
1049
|
declare function object<T extends {
|
|
@@ -1084,6 +1088,8 @@ declare function tuple<const T extends readonly Parser<Mode, unknown, unknown>[]
|
|
|
1084
1088
|
* @returns A {@link Parser} that produces a readonly tuple with the same length
|
|
1085
1089
|
* as the input array, where each element is the result of the
|
|
1086
1090
|
* corresponding parser.
|
|
1091
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1092
|
+
* whitespace-only, or contains control characters.
|
|
1087
1093
|
*/
|
|
1088
1094
|
declare function tuple<const T extends readonly Parser<Mode, unknown, unknown>[]>(label: string, parsers: T, options?: TupleOptions): Parser<CombineTupleModes<T>, { readonly [K in keyof T]: T[K]["$valueType"][number] extends (infer U) ? U : never }, { readonly [K in keyof T]: T[K]["$stateType"][number] extends (infer U2) ? U2 : never }>;
|
|
1089
1095
|
/**
|
|
@@ -1152,6 +1158,8 @@ declare function merge<const TParsers extends MergeParsers>(...rest: [...parsers
|
|
|
1152
1158
|
* @returns A parser that merges parsed object fields from all parsers.
|
|
1153
1159
|
* Type inference is precise for tuple calls up to 15 parser arguments.
|
|
1154
1160
|
* @throws {TypeError} If no parser arguments are provided.
|
|
1161
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1162
|
+
* whitespace-only, or contains control characters.
|
|
1155
1163
|
* @since 0.4.0
|
|
1156
1164
|
*/
|
|
1157
1165
|
declare function merge<const TParsers extends MergeParsers>(label: string, ...parsers: EnsureMergeParsers<TParsers> & MergeArityGuard<TParsers>): MergeReturnType<TParsers>;
|
|
@@ -1166,6 +1174,8 @@ declare function merge<const TParsers extends MergeParsers>(label: string, ...pa
|
|
|
1166
1174
|
* @returns A parser that merges parsed object fields from all parsers.
|
|
1167
1175
|
* Type inference is precise for tuple calls up to 15 parser arguments.
|
|
1168
1176
|
* @throws {TypeError} If no parser arguments are provided.
|
|
1177
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1178
|
+
* whitespace-only, or contains control characters.
|
|
1169
1179
|
* @since 0.7.0
|
|
1170
1180
|
*/
|
|
1171
1181
|
declare function merge<const TParsers extends MergeParsers>(label: string, ...rest: [...parsers: EnsureMergeParsers<TParsers>, options: MergeTailOptions] & MergeArityGuard<TParsers>): MergeReturnType<TParsers>;
|
|
@@ -1271,6 +1281,8 @@ declare function concat<const TParsers extends ConcatParsers>(...parsers: TParse
|
|
|
1271
1281
|
* @param options Optional visibility controls for the wrapped parser terms.
|
|
1272
1282
|
* @returns A new parser that behaves identically to the input parser
|
|
1273
1283
|
* but generates documentation within a labeled section.
|
|
1284
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1285
|
+
* whitespace-only, or contains control characters.
|
|
1274
1286
|
* @since 0.4.0
|
|
1275
1287
|
*/
|
|
1276
1288
|
/**
|
package/dist/constructs.d.ts
CHANGED
|
@@ -1023,6 +1023,8 @@ declare function object<T extends {
|
|
|
1023
1023
|
* @returns A {@link Parser} that produces an object with the same keys as
|
|
1024
1024
|
* the input, where each value is the result of the corresponding
|
|
1025
1025
|
* parser.
|
|
1026
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1027
|
+
* whitespace-only, or contains control characters.
|
|
1026
1028
|
*/
|
|
1027
1029
|
declare function object<T extends {
|
|
1028
1030
|
readonly [key: string | symbol]: Parser<Mode, unknown, unknown>;
|
|
@@ -1040,6 +1042,8 @@ declare function object<T extends {
|
|
|
1040
1042
|
* @returns A {@link Parser} that produces an object with the same keys as
|
|
1041
1043
|
* the input, where each value is the result of the corresponding
|
|
1042
1044
|
* parser.
|
|
1045
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1046
|
+
* whitespace-only, or contains control characters.
|
|
1043
1047
|
* @since 0.5.0
|
|
1044
1048
|
*/
|
|
1045
1049
|
declare function object<T extends {
|
|
@@ -1084,6 +1088,8 @@ declare function tuple<const T extends readonly Parser<Mode, unknown, unknown>[]
|
|
|
1084
1088
|
* @returns A {@link Parser} that produces a readonly tuple with the same length
|
|
1085
1089
|
* as the input array, where each element is the result of the
|
|
1086
1090
|
* corresponding parser.
|
|
1091
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1092
|
+
* whitespace-only, or contains control characters.
|
|
1087
1093
|
*/
|
|
1088
1094
|
declare function tuple<const T extends readonly Parser<Mode, unknown, unknown>[]>(label: string, parsers: T, options?: TupleOptions): Parser<CombineTupleModes<T>, { readonly [K in keyof T]: T[K]["$valueType"][number] extends (infer U) ? U : never }, { readonly [K in keyof T]: T[K]["$stateType"][number] extends (infer U2) ? U2 : never }>;
|
|
1089
1095
|
/**
|
|
@@ -1152,6 +1158,8 @@ declare function merge<const TParsers extends MergeParsers>(...rest: [...parsers
|
|
|
1152
1158
|
* @returns A parser that merges parsed object fields from all parsers.
|
|
1153
1159
|
* Type inference is precise for tuple calls up to 15 parser arguments.
|
|
1154
1160
|
* @throws {TypeError} If no parser arguments are provided.
|
|
1161
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1162
|
+
* whitespace-only, or contains control characters.
|
|
1155
1163
|
* @since 0.4.0
|
|
1156
1164
|
*/
|
|
1157
1165
|
declare function merge<const TParsers extends MergeParsers>(label: string, ...parsers: EnsureMergeParsers<TParsers> & MergeArityGuard<TParsers>): MergeReturnType<TParsers>;
|
|
@@ -1166,6 +1174,8 @@ declare function merge<const TParsers extends MergeParsers>(label: string, ...pa
|
|
|
1166
1174
|
* @returns A parser that merges parsed object fields from all parsers.
|
|
1167
1175
|
* Type inference is precise for tuple calls up to 15 parser arguments.
|
|
1168
1176
|
* @throws {TypeError} If no parser arguments are provided.
|
|
1177
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1178
|
+
* whitespace-only, or contains control characters.
|
|
1169
1179
|
* @since 0.7.0
|
|
1170
1180
|
*/
|
|
1171
1181
|
declare function merge<const TParsers extends MergeParsers>(label: string, ...rest: [...parsers: EnsureMergeParsers<TParsers>, options: MergeTailOptions] & MergeArityGuard<TParsers>): MergeReturnType<TParsers>;
|
|
@@ -1271,6 +1281,8 @@ declare function concat<const TParsers extends ConcatParsers>(...parsers: TParse
|
|
|
1271
1281
|
* @param options Optional visibility controls for the wrapped parser terms.
|
|
1272
1282
|
* @returns A new parser that behaves identically to the input parser
|
|
1273
1283
|
* but generates documentation within a labeled section.
|
|
1284
|
+
* @throws {TypeError} If the label is not a string, is empty,
|
|
1285
|
+
* whitespace-only, or contains control characters.
|
|
1274
1286
|
* @since 0.4.0
|
|
1275
1287
|
*/
|
|
1276
1288
|
/**
|
package/dist/constructs.js
CHANGED
|
@@ -2,6 +2,7 @@ import { getAnnotations, inheritAnnotations, injectAnnotations } from "./annotat
|
|
|
2
2
|
import { message, optionName, text, values } from "./message.js";
|
|
3
3
|
import { DependencyRegistry, createDependencySourceState, dependencyId, isDeferredParseState, isDependencySourceState, isPendingDependencySourceState, isWrappedDependencySource, parseWithDependency, wrappedDependencySourceMarker } from "./dependency.js";
|
|
4
4
|
import { dispatchByMode, dispatchIterableByMode } from "./mode-dispatch.js";
|
|
5
|
+
import { validateLabel } from "./validate.js";
|
|
5
6
|
import { extractArgumentMetavars, extractCommandNames, extractOptionNames, isDocHidden, mergeHidden } from "./usage.js";
|
|
6
7
|
import { deduplicateDocFragments } from "./doc.js";
|
|
7
8
|
import { DEFAULT_FIND_SIMILAR_OPTIONS, createErrorWithSuggestions, createSuggestionMessage, deduplicateSuggestions, findSimilar } from "./suggestion.js";
|
|
@@ -1001,6 +1002,7 @@ async function resolveDeferredParseStatesAsync(fieldStates, initialRegistry) {
|
|
|
1001
1002
|
}
|
|
1002
1003
|
function object(labelOrParsers, maybeParsersOrOptions, maybeOptions) {
|
|
1003
1004
|
const label = typeof labelOrParsers === "string" ? labelOrParsers : void 0;
|
|
1005
|
+
if (label != null) validateLabel(label);
|
|
1004
1006
|
let parsers;
|
|
1005
1007
|
let options = {};
|
|
1006
1008
|
if (typeof labelOrParsers === "string") {
|
|
@@ -1410,6 +1412,7 @@ async function* suggestTupleAsync(context, prefix, parsers) {
|
|
|
1410
1412
|
}
|
|
1411
1413
|
function tuple(labelOrParsers, maybeParsersOrOptions, maybeOptions) {
|
|
1412
1414
|
const label = typeof labelOrParsers === "string" ? labelOrParsers : void 0;
|
|
1415
|
+
if (label != null) validateLabel(label);
|
|
1413
1416
|
let parsers;
|
|
1414
1417
|
let options = {};
|
|
1415
1418
|
if (typeof labelOrParsers === "string") {
|
|
@@ -1723,6 +1726,7 @@ function tuple(labelOrParsers, maybeParsersOrOptions, maybeOptions) {
|
|
|
1723
1726
|
}
|
|
1724
1727
|
function merge(...args) {
|
|
1725
1728
|
const label = typeof args[0] === "string" ? args[0] : void 0;
|
|
1729
|
+
if (label != null) validateLabel(label);
|
|
1726
1730
|
const lastArg = args[args.length - 1];
|
|
1727
1731
|
const hasOptions = lastArg != null && typeof lastArg === "object" && !("$valueType" in lastArg);
|
|
1728
1732
|
const options = hasOptions ? lastArg : {};
|
|
@@ -2481,6 +2485,7 @@ function concat(...parsers) {
|
|
|
2481
2485
|
};
|
|
2482
2486
|
}
|
|
2483
2487
|
function group(label, parser, options = {}) {
|
|
2488
|
+
validateLabel(label);
|
|
2484
2489
|
const groupParser = {
|
|
2485
2490
|
$mode: parser.$mode,
|
|
2486
2491
|
$valueType: parser.$valueType,
|
package/dist/doc.cjs
CHANGED
|
@@ -185,8 +185,8 @@ function defaultSectionOrder(a, b) {
|
|
|
185
185
|
* @returns A formatted string representation of the documentation page
|
|
186
186
|
* @throws {TypeError} If `programName` is not a string, is empty,
|
|
187
187
|
* whitespace-only, or contains control characters, if any non-empty
|
|
188
|
-
* section's title is empty, whitespace-only, or contains
|
|
189
|
-
*
|
|
188
|
+
* section's title is not a string, is empty, whitespace-only, or contains
|
|
189
|
+
* control characters, or if `maxWidth` is not a finite integer.
|
|
190
190
|
* @throws {RangeError} If any entry needs a description column and `maxWidth`
|
|
191
191
|
* is too small to fit the minimum layout (less than `termIndent + 4`), or if
|
|
192
192
|
* `showChoices.maxItems` is less than `1`.
|
|
@@ -312,7 +312,7 @@ function formatDocPage(programName, page, options = {}) {
|
|
|
312
312
|
if (section.entries.length < 1) continue;
|
|
313
313
|
output += "\n";
|
|
314
314
|
if (section.title != null) {
|
|
315
|
-
|
|
315
|
+
require_validate.validateLabel(section.title);
|
|
316
316
|
const sectionLabel = options.colors ? `\x1b[1;2m${section.title}:\x1b[0m\n` : `${section.title}:\n`;
|
|
317
317
|
output += sectionLabel;
|
|
318
318
|
}
|
package/dist/doc.d.cts
CHANGED
|
@@ -313,8 +313,8 @@ interface DocPageFormatOptions {
|
|
|
313
313
|
* @returns A formatted string representation of the documentation page
|
|
314
314
|
* @throws {TypeError} If `programName` is not a string, is empty,
|
|
315
315
|
* whitespace-only, or contains control characters, if any non-empty
|
|
316
|
-
* section's title is empty, whitespace-only, or contains
|
|
317
|
-
*
|
|
316
|
+
* section's title is not a string, is empty, whitespace-only, or contains
|
|
317
|
+
* control characters, or if `maxWidth` is not a finite integer.
|
|
318
318
|
* @throws {RangeError} If any entry needs a description column and `maxWidth`
|
|
319
319
|
* is too small to fit the minimum layout (less than `termIndent + 4`), or if
|
|
320
320
|
* `showChoices.maxItems` is less than `1`.
|
package/dist/doc.d.ts
CHANGED
|
@@ -313,8 +313,8 @@ interface DocPageFormatOptions {
|
|
|
313
313
|
* @returns A formatted string representation of the documentation page
|
|
314
314
|
* @throws {TypeError} If `programName` is not a string, is empty,
|
|
315
315
|
* whitespace-only, or contains control characters, if any non-empty
|
|
316
|
-
* section's title is empty, whitespace-only, or contains
|
|
317
|
-
*
|
|
316
|
+
* section's title is not a string, is empty, whitespace-only, or contains
|
|
317
|
+
* control characters, or if `maxWidth` is not a finite integer.
|
|
318
318
|
* @throws {RangeError} If any entry needs a description column and `maxWidth`
|
|
319
319
|
* is too small to fit the minimum layout (less than `termIndent + 4`), or if
|
|
320
320
|
* `showChoices.maxItems` is less than `1`.
|
package/dist/doc.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { cloneMessage, formatMessage, text } from "./message.js";
|
|
2
|
-
import { validateProgramName } from "./validate.js";
|
|
2
|
+
import { validateLabel, validateProgramName } from "./validate.js";
|
|
3
3
|
import { cloneUsageTerm, formatUsage, formatUsageTerm, isDocHidden, isUsageHidden } from "./usage.js";
|
|
4
4
|
|
|
5
5
|
//#region src/doc.ts
|
|
@@ -185,8 +185,8 @@ function defaultSectionOrder(a, b) {
|
|
|
185
185
|
* @returns A formatted string representation of the documentation page
|
|
186
186
|
* @throws {TypeError} If `programName` is not a string, is empty,
|
|
187
187
|
* whitespace-only, or contains control characters, if any non-empty
|
|
188
|
-
* section's title is empty, whitespace-only, or contains
|
|
189
|
-
*
|
|
188
|
+
* section's title is not a string, is empty, whitespace-only, or contains
|
|
189
|
+
* control characters, or if `maxWidth` is not a finite integer.
|
|
190
190
|
* @throws {RangeError} If any entry needs a description column and `maxWidth`
|
|
191
191
|
* is too small to fit the minimum layout (less than `termIndent + 4`), or if
|
|
192
192
|
* `showChoices.maxItems` is less than `1`.
|
|
@@ -312,7 +312,7 @@ function formatDocPage(programName, page, options = {}) {
|
|
|
312
312
|
if (section.entries.length < 1) continue;
|
|
313
313
|
output += "\n";
|
|
314
314
|
if (section.title != null) {
|
|
315
|
-
|
|
315
|
+
validateLabel(section.title);
|
|
316
316
|
const sectionLabel = options.colors ? `\x1b[1;2m${section.title}:\x1b[0m\n` : `${section.title}:\n`;
|
|
317
317
|
output += sectionLabel;
|
|
318
318
|
}
|
package/dist/facade.cjs
CHANGED
|
@@ -587,6 +587,45 @@ function runParser(parserOrProgram, programNameOrArgs, argsOrOptions, optionsPar
|
|
|
587
587
|
const versionCommandNames = versionCommandConfig?.names ?? ["version"];
|
|
588
588
|
const completionCommandNames = completionCommandConfig?.names ?? ["completion"];
|
|
589
589
|
const completionOptionNames = completionOptionConfig?.names ?? ["--completion"];
|
|
590
|
+
const activeMetaEntries = [];
|
|
591
|
+
if (options.help && helpOptionConfig) activeMetaEntries.push([
|
|
592
|
+
"option",
|
|
593
|
+
"help option",
|
|
594
|
+
helpOptionNames
|
|
595
|
+
]);
|
|
596
|
+
if (options.help && helpCommandConfig) activeMetaEntries.push([
|
|
597
|
+
"command",
|
|
598
|
+
"help command",
|
|
599
|
+
helpCommandNames
|
|
600
|
+
]);
|
|
601
|
+
if (options.version && versionOptionConfig) activeMetaEntries.push([
|
|
602
|
+
"option",
|
|
603
|
+
"version option",
|
|
604
|
+
versionOptionNames
|
|
605
|
+
]);
|
|
606
|
+
if (options.version && versionCommandConfig) activeMetaEntries.push([
|
|
607
|
+
"command",
|
|
608
|
+
"version command",
|
|
609
|
+
versionCommandNames
|
|
610
|
+
]);
|
|
611
|
+
if (options.completion && completionOptionConfig) activeMetaEntries.push([
|
|
612
|
+
"option",
|
|
613
|
+
"completion option",
|
|
614
|
+
completionOptionNames,
|
|
615
|
+
true
|
|
616
|
+
]);
|
|
617
|
+
if (options.completion && completionCommandConfig) activeMetaEntries.push([
|
|
618
|
+
"command",
|
|
619
|
+
"completion command",
|
|
620
|
+
completionCommandNames
|
|
621
|
+
]);
|
|
622
|
+
require_validate.validateMetaNameCollisions({
|
|
623
|
+
leadingOptions: require_usage.extractLeadingOptionNames(parser.usage, true),
|
|
624
|
+
leadingCommands: require_usage.extractLeadingCommandNames(parser.usage, true),
|
|
625
|
+
allOptions: require_usage.extractOptionNames(parser.usage, true),
|
|
626
|
+
allCommands: require_usage.extractCommandNames(parser.usage, true),
|
|
627
|
+
allLiterals: require_usage.extractLiteralValues(parser.usage)
|
|
628
|
+
}, activeMetaEntries);
|
|
590
629
|
const defaultShells = {
|
|
591
630
|
bash: require_completion.bash,
|
|
592
631
|
fish: require_completion.fish,
|
package/dist/facade.js
CHANGED
|
@@ -2,8 +2,8 @@ import { injectAnnotations } from "./annotations.js";
|
|
|
2
2
|
import { commandLine, formatMessage, lineBreak, message, optionName, text, value } from "./message.js";
|
|
3
3
|
import { bash, fish, nu, pwsh, zsh } from "./completion.js";
|
|
4
4
|
import { dispatchByMode } from "./mode-dispatch.js";
|
|
5
|
-
import { validateCommandNames, validateOptionNames } from "./validate.js";
|
|
6
|
-
import { formatUsage } from "./usage.js";
|
|
5
|
+
import { validateCommandNames, validateMetaNameCollisions, validateOptionNames } from "./validate.js";
|
|
6
|
+
import { extractCommandNames, extractLeadingCommandNames, extractLeadingOptionNames, extractLiteralValues, extractOptionNames, formatUsage } from "./usage.js";
|
|
7
7
|
import { formatDocPage } from "./doc.js";
|
|
8
8
|
import { group, longestMatch, object } from "./constructs.js";
|
|
9
9
|
import { multiple, optional, withDefault } from "./modifiers.js";
|
|
@@ -587,6 +587,45 @@ function runParser(parserOrProgram, programNameOrArgs, argsOrOptions, optionsPar
|
|
|
587
587
|
const versionCommandNames = versionCommandConfig?.names ?? ["version"];
|
|
588
588
|
const completionCommandNames = completionCommandConfig?.names ?? ["completion"];
|
|
589
589
|
const completionOptionNames = completionOptionConfig?.names ?? ["--completion"];
|
|
590
|
+
const activeMetaEntries = [];
|
|
591
|
+
if (options.help && helpOptionConfig) activeMetaEntries.push([
|
|
592
|
+
"option",
|
|
593
|
+
"help option",
|
|
594
|
+
helpOptionNames
|
|
595
|
+
]);
|
|
596
|
+
if (options.help && helpCommandConfig) activeMetaEntries.push([
|
|
597
|
+
"command",
|
|
598
|
+
"help command",
|
|
599
|
+
helpCommandNames
|
|
600
|
+
]);
|
|
601
|
+
if (options.version && versionOptionConfig) activeMetaEntries.push([
|
|
602
|
+
"option",
|
|
603
|
+
"version option",
|
|
604
|
+
versionOptionNames
|
|
605
|
+
]);
|
|
606
|
+
if (options.version && versionCommandConfig) activeMetaEntries.push([
|
|
607
|
+
"command",
|
|
608
|
+
"version command",
|
|
609
|
+
versionCommandNames
|
|
610
|
+
]);
|
|
611
|
+
if (options.completion && completionOptionConfig) activeMetaEntries.push([
|
|
612
|
+
"option",
|
|
613
|
+
"completion option",
|
|
614
|
+
completionOptionNames,
|
|
615
|
+
true
|
|
616
|
+
]);
|
|
617
|
+
if (options.completion && completionCommandConfig) activeMetaEntries.push([
|
|
618
|
+
"command",
|
|
619
|
+
"completion command",
|
|
620
|
+
completionCommandNames
|
|
621
|
+
]);
|
|
622
|
+
validateMetaNameCollisions({
|
|
623
|
+
leadingOptions: extractLeadingOptionNames(parser.usage, true),
|
|
624
|
+
leadingCommands: extractLeadingCommandNames(parser.usage, true),
|
|
625
|
+
allOptions: extractOptionNames(parser.usage, true),
|
|
626
|
+
allCommands: extractCommandNames(parser.usage, true),
|
|
627
|
+
allLiterals: extractLiteralValues(parser.usage)
|
|
628
|
+
}, activeMetaEntries);
|
|
590
629
|
const defaultShells = {
|
|
591
630
|
bash,
|
|
592
631
|
fish,
|
package/dist/index.cjs
CHANGED
|
@@ -53,6 +53,9 @@ exports.ensureNonEmptyString = require_nonempty.ensureNonEmptyString;
|
|
|
53
53
|
exports.envVar = require_message.envVar;
|
|
54
54
|
exports.extractArgumentMetavars = require_usage.extractArgumentMetavars;
|
|
55
55
|
exports.extractCommandNames = require_usage.extractCommandNames;
|
|
56
|
+
exports.extractLeadingCommandNames = require_usage.extractLeadingCommandNames;
|
|
57
|
+
exports.extractLeadingOptionNames = require_usage.extractLeadingOptionNames;
|
|
58
|
+
exports.extractLiteralValues = require_usage.extractLiteralValues;
|
|
56
59
|
exports.extractOptionNames = require_usage.extractOptionNames;
|
|
57
60
|
exports.fail = require_primitives.fail;
|
|
58
61
|
exports.fish = require_completion.fish;
|
package/dist/index.d.cts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Annotations, ParseOptions, annotationKey, getAnnotations } from "./annotations.cjs";
|
|
2
2
|
import { NonEmptyString, ensureNonEmptyString, isNonEmptyString } from "./nonempty.cjs";
|
|
3
3
|
import { Message, MessageFormatOptions, MessageTerm, ValueSetOptions, commandLine, envVar, formatMessage, lineBreak, link, message, metavar, optionName, optionNames, text, value, valueSet, values } from "./message.cjs";
|
|
4
|
-
import { HiddenVisibility, OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, cloneUsage, cloneUsageTerm, extractArgumentMetavars, extractCommandNames, extractOptionNames, formatUsage, formatUsageTerm, isDocHidden, isSuggestionHidden, isUsageHidden, mergeHidden, normalizeUsage } from "./usage.cjs";
|
|
4
|
+
import { HiddenVisibility, OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, cloneUsage, cloneUsageTerm, extractArgumentMetavars, extractCommandNames, extractLeadingCommandNames, extractLeadingOptionNames, extractLiteralValues, extractOptionNames, formatUsage, formatUsageTerm, isDocHidden, isSuggestionHidden, isUsageHidden, mergeHidden, normalizeUsage } from "./usage.cjs";
|
|
5
5
|
import { DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, ShowChoicesOptions, ShowDefaultOptions, cloneDocEntry, deduplicateDocEntries, deduplicateDocFragments, formatDocPage, isDocEntryHidden } from "./doc.cjs";
|
|
6
6
|
import { ChoiceOptions, ChoiceOptionsBase, ChoiceOptionsNumber, ChoiceOptionsString, CidrOptions, CidrValue, DeferredMap, DomainOptions, EmailOptions, FloatOptions, HostnameOptions, IntegerOptionsBigInt, IntegerOptionsNumber, IpOptions, Ipv4Options, Ipv6Options, LocaleOptions, MacAddressOptions, PortOptionsBigInt, PortOptionsNumber, PortRangeOptionsBigInt, PortRangeOptionsNumber, PortRangeValueBigInt, PortRangeValueNumber, SocketAddressOptions, SocketAddressValue, StringOptions, UrlOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, checkBooleanOption, checkEnumOption, choice, cidr, domain, email, float, hostname, integer, ip, ipv4, ipv6, isValueParser, locale, macAddress, port, portRange, socketAddress, string, url, uuid } from "./valueparser.cjs";
|
|
7
7
|
import { ConditionalErrorOptions, ConditionalOptions, DuplicateOptionError, GroupOptions, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, NoMatchContext, ObjectErrorOptions, ObjectOptions, OrErrorOptions, OrOptions, TupleOptions, concat, conditional, group, longestMatch, merge, object, or, tuple } from "./constructs.cjs";
|
|
@@ -12,4 +12,4 @@ import { CombineModes, DocState, InferMode, InferValue, Mode, ModeIterable, Mode
|
|
|
12
12
|
import { ShellCompletion, bash, fish, nu, pwsh, zsh } from "./completion.cjs";
|
|
13
13
|
import { ParserValuePlaceholder, SourceContext } from "./context.cjs";
|
|
14
14
|
import { CommandSubConfig, ContextOptionsParam, ExtractRequiredOptions, OptionSubConfig, RunOptions, RunParserError, RunWithOptions, SubstituteParserValue, runParser, runParserAsync, runParserSync, runWith, runWithAsync, runWithSync } from "./facade.cjs";
|
|
15
|
-
export { type Annotations, AnyDependencySource, ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, ChoiceOptionsBase, ChoiceOptionsNumber, ChoiceOptionsString, CidrOptions, CidrValue, CombineMode, CombineModes, CombinedDependencyMode, CommandErrorOptions, CommandOptions, CommandSubConfig, ConditionalErrorOptions, ConditionalOptions, ContextOptionsParam, DeferredMap, DeferredParseState, DependencyError, DependencyMode, DependencyRegistry, DependencySource, DependencySourceState, DependencyValue, DependencyValues, DeriveAsyncOptions, DeriveFromAsyncOptions, DeriveFromOptions, DeriveFromSyncOptions, DeriveOptions, DeriveSyncOptions, DerivedValueParser, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, DomainOptions, DuplicateOptionError, EmailOptions, ExtractRequiredOptions, FlagErrorOptions, FlagOptions, FloatOptions, GroupOptions, HiddenVisibility, HostnameOptions, InferMode, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, IpOptions, Ipv4Options, Ipv6Options, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MacAddressOptions, MergeOptions, type Message, type MessageFormatOptions, type MessageTerm, Mode, ModeIterable, ModeValue, MultipleErrorOptions, MultipleOptions, NoMatchContext, NonEmptyString, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OptionState, OptionSubConfig, OrErrorOptions, OrOptions, type ParseOptions, Parser, ParserContext, ParserResult, ParserValuePlaceholder, PassThroughFormat, PassThroughOptions, PendingDependencySourceState, PortOptionsBigInt, PortOptionsNumber, PortRangeOptionsBigInt, PortRangeOptionsNumber, PortRangeValueBigInt, PortRangeValueNumber, ResolvedDependency, Result, RunOptions, RunParserError, RunWithOptions, ShellCompletion, ShowChoicesOptions, ShowDefaultOptions, SocketAddressOptions, SocketAddressValue, SourceContext, StringOptions, SubstituteParserValue, Suggestion, TupleOptions, UrlOptions, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, type ValueSetOptions, WithDefaultError, WithDefaultOptions, annotationKey, argument, bash, checkBooleanOption, checkEnumOption, choice, cidr, cloneDocEntry, cloneUsage, cloneUsageTerm, command, commandLine, concat, conditional, constant, createDeferredParseState, createDependencySourceState, createPendingDependencySourceState, deduplicateDocEntries, deduplicateDocFragments, defaultValues, deferredParseMarker, dependency, dependencyId, dependencyIds, dependencySourceMarker, dependencySourceStateMarker, deriveFrom, deriveFromAsync, deriveFromSync, derivedValueParserMarker, domain, email, ensureNonEmptyString, envVar, extractArgumentMetavars, extractCommandNames, extractOptionNames, fail, fish, flag, float, formatDependencyError, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getAnnotations, getDefaultValuesFunction, getDependencyIds, getDocPage, getDocPageAsync, getDocPageSync, group, hostname, integer, ip, ipv4, ipv6, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser, isDocEntryHidden, isDocHidden, isNonEmptyString, isPendingDependencySourceState, isSuggestionHidden, isUsageHidden, isValueParser, isWrappedDependencySource, lineBreak, link, locale, longestMatch, macAddress, map, merge, mergeHidden, message, metavar, multiple, nonEmpty, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, parseAsync, parseSync, parseWithDependency, passThrough, pendingDependencySourceStateMarker, port, portRange, pwsh, runParser, runParserAsync, runParserSync, runWith, runWithAsync, runWithSync, socketAddress, string, suggest, suggestAsync, suggestSync, suggestWithDependency, text, transformsDependencyValue, transformsDependencyValueMarker, tuple, url, uuid, value, valueSet, values, withDefault, wrappedDependencySourceMarker, zsh };
|
|
15
|
+
export { type Annotations, AnyDependencySource, ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, ChoiceOptionsBase, ChoiceOptionsNumber, ChoiceOptionsString, CidrOptions, CidrValue, CombineMode, CombineModes, CombinedDependencyMode, CommandErrorOptions, CommandOptions, CommandSubConfig, ConditionalErrorOptions, ConditionalOptions, ContextOptionsParam, DeferredMap, DeferredParseState, DependencyError, DependencyMode, DependencyRegistry, DependencySource, DependencySourceState, DependencyValue, DependencyValues, DeriveAsyncOptions, DeriveFromAsyncOptions, DeriveFromOptions, DeriveFromSyncOptions, DeriveOptions, DeriveSyncOptions, DerivedValueParser, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, DomainOptions, DuplicateOptionError, EmailOptions, ExtractRequiredOptions, FlagErrorOptions, FlagOptions, FloatOptions, GroupOptions, HiddenVisibility, HostnameOptions, InferMode, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, IpOptions, Ipv4Options, Ipv6Options, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MacAddressOptions, MergeOptions, type Message, type MessageFormatOptions, type MessageTerm, Mode, ModeIterable, ModeValue, MultipleErrorOptions, MultipleOptions, NoMatchContext, NonEmptyString, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OptionState, OptionSubConfig, OrErrorOptions, OrOptions, type ParseOptions, Parser, ParserContext, ParserResult, ParserValuePlaceholder, PassThroughFormat, PassThroughOptions, PendingDependencySourceState, PortOptionsBigInt, PortOptionsNumber, PortRangeOptionsBigInt, PortRangeOptionsNumber, PortRangeValueBigInt, PortRangeValueNumber, ResolvedDependency, Result, RunOptions, RunParserError, RunWithOptions, ShellCompletion, ShowChoicesOptions, ShowDefaultOptions, SocketAddressOptions, SocketAddressValue, SourceContext, StringOptions, SubstituteParserValue, Suggestion, TupleOptions, UrlOptions, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, type ValueSetOptions, WithDefaultError, WithDefaultOptions, annotationKey, argument, bash, checkBooleanOption, checkEnumOption, choice, cidr, cloneDocEntry, cloneUsage, cloneUsageTerm, command, commandLine, concat, conditional, constant, createDeferredParseState, createDependencySourceState, createPendingDependencySourceState, deduplicateDocEntries, deduplicateDocFragments, defaultValues, deferredParseMarker, dependency, dependencyId, dependencyIds, dependencySourceMarker, dependencySourceStateMarker, deriveFrom, deriveFromAsync, deriveFromSync, derivedValueParserMarker, domain, email, ensureNonEmptyString, envVar, extractArgumentMetavars, extractCommandNames, extractLeadingCommandNames, extractLeadingOptionNames, extractLiteralValues, extractOptionNames, fail, fish, flag, float, formatDependencyError, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getAnnotations, getDefaultValuesFunction, getDependencyIds, getDocPage, getDocPageAsync, getDocPageSync, group, hostname, integer, ip, ipv4, ipv6, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser, isDocEntryHidden, isDocHidden, isNonEmptyString, isPendingDependencySourceState, isSuggestionHidden, isUsageHidden, isValueParser, isWrappedDependencySource, lineBreak, link, locale, longestMatch, macAddress, map, merge, mergeHidden, message, metavar, multiple, nonEmpty, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, parseAsync, parseSync, parseWithDependency, passThrough, pendingDependencySourceStateMarker, port, portRange, pwsh, runParser, runParserAsync, runParserSync, runWith, runWithAsync, runWithSync, socketAddress, string, suggest, suggestAsync, suggestSync, suggestWithDependency, text, transformsDependencyValue, transformsDependencyValueMarker, tuple, url, uuid, value, valueSet, values, withDefault, wrappedDependencySourceMarker, zsh };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Annotations, ParseOptions, annotationKey, getAnnotations } from "./annotations.js";
|
|
2
2
|
import { NonEmptyString, ensureNonEmptyString, isNonEmptyString } from "./nonempty.js";
|
|
3
3
|
import { Message, MessageFormatOptions, MessageTerm, ValueSetOptions, commandLine, envVar, formatMessage, lineBreak, link, message, metavar, optionName, optionNames, text, value, valueSet, values } from "./message.js";
|
|
4
|
-
import { HiddenVisibility, OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, cloneUsage, cloneUsageTerm, extractArgumentMetavars, extractCommandNames, extractOptionNames, formatUsage, formatUsageTerm, isDocHidden, isSuggestionHidden, isUsageHidden, mergeHidden, normalizeUsage } from "./usage.js";
|
|
4
|
+
import { HiddenVisibility, OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, cloneUsage, cloneUsageTerm, extractArgumentMetavars, extractCommandNames, extractLeadingCommandNames, extractLeadingOptionNames, extractLiteralValues, extractOptionNames, formatUsage, formatUsageTerm, isDocHidden, isSuggestionHidden, isUsageHidden, mergeHidden, normalizeUsage } from "./usage.js";
|
|
5
5
|
import { DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, ShowChoicesOptions, ShowDefaultOptions, cloneDocEntry, deduplicateDocEntries, deduplicateDocFragments, formatDocPage, isDocEntryHidden } from "./doc.js";
|
|
6
6
|
import { ChoiceOptions, ChoiceOptionsBase, ChoiceOptionsNumber, ChoiceOptionsString, CidrOptions, CidrValue, DeferredMap, DomainOptions, EmailOptions, FloatOptions, HostnameOptions, IntegerOptionsBigInt, IntegerOptionsNumber, IpOptions, Ipv4Options, Ipv6Options, LocaleOptions, MacAddressOptions, PortOptionsBigInt, PortOptionsNumber, PortRangeOptionsBigInt, PortRangeOptionsNumber, PortRangeValueBigInt, PortRangeValueNumber, SocketAddressOptions, SocketAddressValue, StringOptions, UrlOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, checkBooleanOption, checkEnumOption, choice, cidr, domain, email, float, hostname, integer, ip, ipv4, ipv6, isValueParser, locale, macAddress, port, portRange, socketAddress, string, url, uuid } from "./valueparser.js";
|
|
7
7
|
import { ConditionalErrorOptions, ConditionalOptions, DuplicateOptionError, GroupOptions, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, NoMatchContext, ObjectErrorOptions, ObjectOptions, OrErrorOptions, OrOptions, TupleOptions, concat, conditional, group, longestMatch, merge, object, or, tuple } from "./constructs.js";
|
|
@@ -12,4 +12,4 @@ import { CombineModes, DocState, InferMode, InferValue, Mode, ModeIterable, Mode
|
|
|
12
12
|
import { ShellCompletion, bash, fish, nu, pwsh, zsh } from "./completion.js";
|
|
13
13
|
import { ParserValuePlaceholder, SourceContext } from "./context.js";
|
|
14
14
|
import { CommandSubConfig, ContextOptionsParam, ExtractRequiredOptions, OptionSubConfig, RunOptions, RunParserError, RunWithOptions, SubstituteParserValue, runParser, runParserAsync, runParserSync, runWith, runWithAsync, runWithSync } from "./facade.js";
|
|
15
|
-
export { type Annotations, AnyDependencySource, ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, ChoiceOptionsBase, ChoiceOptionsNumber, ChoiceOptionsString, CidrOptions, CidrValue, CombineMode, CombineModes, CombinedDependencyMode, CommandErrorOptions, CommandOptions, CommandSubConfig, ConditionalErrorOptions, ConditionalOptions, ContextOptionsParam, DeferredMap, DeferredParseState, DependencyError, DependencyMode, DependencyRegistry, DependencySource, DependencySourceState, DependencyValue, DependencyValues, DeriveAsyncOptions, DeriveFromAsyncOptions, DeriveFromOptions, DeriveFromSyncOptions, DeriveOptions, DeriveSyncOptions, DerivedValueParser, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, DomainOptions, DuplicateOptionError, EmailOptions, ExtractRequiredOptions, FlagErrorOptions, FlagOptions, FloatOptions, GroupOptions, HiddenVisibility, HostnameOptions, InferMode, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, IpOptions, Ipv4Options, Ipv6Options, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MacAddressOptions, MergeOptions, type Message, type MessageFormatOptions, type MessageTerm, Mode, ModeIterable, ModeValue, MultipleErrorOptions, MultipleOptions, NoMatchContext, NonEmptyString, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OptionState, OptionSubConfig, OrErrorOptions, OrOptions, type ParseOptions, Parser, ParserContext, ParserResult, ParserValuePlaceholder, PassThroughFormat, PassThroughOptions, PendingDependencySourceState, PortOptionsBigInt, PortOptionsNumber, PortRangeOptionsBigInt, PortRangeOptionsNumber, PortRangeValueBigInt, PortRangeValueNumber, ResolvedDependency, Result, RunOptions, RunParserError, RunWithOptions, ShellCompletion, ShowChoicesOptions, ShowDefaultOptions, SocketAddressOptions, SocketAddressValue, SourceContext, StringOptions, SubstituteParserValue, Suggestion, TupleOptions, UrlOptions, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, type ValueSetOptions, WithDefaultError, WithDefaultOptions, annotationKey, argument, bash, checkBooleanOption, checkEnumOption, choice, cidr, cloneDocEntry, cloneUsage, cloneUsageTerm, command, commandLine, concat, conditional, constant, createDeferredParseState, createDependencySourceState, createPendingDependencySourceState, deduplicateDocEntries, deduplicateDocFragments, defaultValues, deferredParseMarker, dependency, dependencyId, dependencyIds, dependencySourceMarker, dependencySourceStateMarker, deriveFrom, deriveFromAsync, deriveFromSync, derivedValueParserMarker, domain, email, ensureNonEmptyString, envVar, extractArgumentMetavars, extractCommandNames, extractOptionNames, fail, fish, flag, float, formatDependencyError, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getAnnotations, getDefaultValuesFunction, getDependencyIds, getDocPage, getDocPageAsync, getDocPageSync, group, hostname, integer, ip, ipv4, ipv6, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser, isDocEntryHidden, isDocHidden, isNonEmptyString, isPendingDependencySourceState, isSuggestionHidden, isUsageHidden, isValueParser, isWrappedDependencySource, lineBreak, link, locale, longestMatch, macAddress, map, merge, mergeHidden, message, metavar, multiple, nonEmpty, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, parseAsync, parseSync, parseWithDependency, passThrough, pendingDependencySourceStateMarker, port, portRange, pwsh, runParser, runParserAsync, runParserSync, runWith, runWithAsync, runWithSync, socketAddress, string, suggest, suggestAsync, suggestSync, suggestWithDependency, text, transformsDependencyValue, transformsDependencyValueMarker, tuple, url, uuid, value, valueSet, values, withDefault, wrappedDependencySourceMarker, zsh };
|
|
15
|
+
export { type Annotations, AnyDependencySource, ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, ChoiceOptionsBase, ChoiceOptionsNumber, ChoiceOptionsString, CidrOptions, CidrValue, CombineMode, CombineModes, CombinedDependencyMode, CommandErrorOptions, CommandOptions, CommandSubConfig, ConditionalErrorOptions, ConditionalOptions, ContextOptionsParam, DeferredMap, DeferredParseState, DependencyError, DependencyMode, DependencyRegistry, DependencySource, DependencySourceState, DependencyValue, DependencyValues, DeriveAsyncOptions, DeriveFromAsyncOptions, DeriveFromOptions, DeriveFromSyncOptions, DeriveOptions, DeriveSyncOptions, DerivedValueParser, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, DomainOptions, DuplicateOptionError, EmailOptions, ExtractRequiredOptions, FlagErrorOptions, FlagOptions, FloatOptions, GroupOptions, HiddenVisibility, HostnameOptions, InferMode, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, IpOptions, Ipv4Options, Ipv6Options, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MacAddressOptions, MergeOptions, type Message, type MessageFormatOptions, type MessageTerm, Mode, ModeIterable, ModeValue, MultipleErrorOptions, MultipleOptions, NoMatchContext, NonEmptyString, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OptionState, OptionSubConfig, OrErrorOptions, OrOptions, type ParseOptions, Parser, ParserContext, ParserResult, ParserValuePlaceholder, PassThroughFormat, PassThroughOptions, PendingDependencySourceState, PortOptionsBigInt, PortOptionsNumber, PortRangeOptionsBigInt, PortRangeOptionsNumber, PortRangeValueBigInt, PortRangeValueNumber, ResolvedDependency, Result, RunOptions, RunParserError, RunWithOptions, ShellCompletion, ShowChoicesOptions, ShowDefaultOptions, SocketAddressOptions, SocketAddressValue, SourceContext, StringOptions, SubstituteParserValue, Suggestion, TupleOptions, UrlOptions, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, type ValueSetOptions, WithDefaultError, WithDefaultOptions, annotationKey, argument, bash, checkBooleanOption, checkEnumOption, choice, cidr, cloneDocEntry, cloneUsage, cloneUsageTerm, command, commandLine, concat, conditional, constant, createDeferredParseState, createDependencySourceState, createPendingDependencySourceState, deduplicateDocEntries, deduplicateDocFragments, defaultValues, deferredParseMarker, dependency, dependencyId, dependencyIds, dependencySourceMarker, dependencySourceStateMarker, deriveFrom, deriveFromAsync, deriveFromSync, derivedValueParserMarker, domain, email, ensureNonEmptyString, envVar, extractArgumentMetavars, extractCommandNames, extractLeadingCommandNames, extractLeadingOptionNames, extractLiteralValues, extractOptionNames, fail, fish, flag, float, formatDependencyError, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getAnnotations, getDefaultValuesFunction, getDependencyIds, getDocPage, getDocPageAsync, getDocPageSync, group, hostname, integer, ip, ipv4, ipv6, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser, isDocEntryHidden, isDocHidden, isNonEmptyString, isPendingDependencySourceState, isSuggestionHidden, isUsageHidden, isValueParser, isWrappedDependencySource, lineBreak, link, locale, longestMatch, macAddress, map, merge, mergeHidden, message, metavar, multiple, nonEmpty, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, parseAsync, parseSync, parseWithDependency, passThrough, pendingDependencySourceStateMarker, port, portRange, pwsh, runParser, runParserAsync, runParserSync, runWith, runWithAsync, runWithSync, socketAddress, string, suggest, suggestAsync, suggestSync, suggestWithDependency, text, transformsDependencyValue, transformsDependencyValueMarker, tuple, url, uuid, value, valueSet, values, withDefault, wrappedDependencySourceMarker, zsh };
|
package/dist/index.js
CHANGED
|
@@ -2,7 +2,7 @@ import { annotationKey, getAnnotations } from "./annotations.js";
|
|
|
2
2
|
import { commandLine, envVar, formatMessage, lineBreak, link, message, metavar, optionName, optionNames, text, value, valueSet, values } from "./message.js";
|
|
3
3
|
import { bash, fish, nu, pwsh, zsh } from "./completion.js";
|
|
4
4
|
import { DependencyRegistry, createDeferredParseState, createDependencySourceState, createPendingDependencySourceState, defaultValues, deferredParseMarker, dependency, dependencyId, dependencyIds, dependencySourceMarker, dependencySourceStateMarker, deriveFrom, deriveFromAsync, deriveFromSync, derivedValueParserMarker, formatDependencyError, getDefaultValuesFunction, getDependencyIds, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser, isPendingDependencySourceState, isWrappedDependencySource, parseWithDependency, pendingDependencySourceStateMarker, suggestWithDependency, transformsDependencyValue, transformsDependencyValueMarker, wrappedDependencySourceMarker } from "./dependency.js";
|
|
5
|
-
import { cloneUsage, cloneUsageTerm, extractArgumentMetavars, extractCommandNames, extractOptionNames, formatUsage, formatUsageTerm, isDocHidden, isSuggestionHidden, isUsageHidden, mergeHidden, normalizeUsage } from "./usage.js";
|
|
5
|
+
import { cloneUsage, cloneUsageTerm, extractArgumentMetavars, extractCommandNames, extractLeadingCommandNames, extractLeadingOptionNames, extractLiteralValues, extractOptionNames, formatUsage, formatUsageTerm, isDocHidden, isSuggestionHidden, isUsageHidden, mergeHidden, normalizeUsage } from "./usage.js";
|
|
6
6
|
import { cloneDocEntry, deduplicateDocEntries, deduplicateDocFragments, formatDocPage, isDocEntryHidden } from "./doc.js";
|
|
7
7
|
import { DuplicateOptionError, concat, conditional, group, longestMatch, merge, object, or, tuple } from "./constructs.js";
|
|
8
8
|
import { WithDefaultError, map, multiple, nonEmpty, optional, withDefault } from "./modifiers.js";
|
|
@@ -12,4 +12,4 @@ import { argument, command, constant, fail, flag, option, passThrough } from "./
|
|
|
12
12
|
import { getDocPage, getDocPageAsync, getDocPageSync, parse, parseAsync, parseSync, suggest, suggestAsync, suggestSync } from "./parser.js";
|
|
13
13
|
import { RunParserError, runParser, runParserAsync, runParserSync, runWith, runWithAsync, runWithSync } from "./facade.js";
|
|
14
14
|
|
|
15
|
-
export { DependencyRegistry, DuplicateOptionError, RunParserError, WithDefaultError, annotationKey, argument, bash, checkBooleanOption, checkEnumOption, choice, cidr, cloneDocEntry, cloneUsage, cloneUsageTerm, command, commandLine, concat, conditional, constant, createDeferredParseState, createDependencySourceState, createPendingDependencySourceState, deduplicateDocEntries, deduplicateDocFragments, defaultValues, deferredParseMarker, dependency, dependencyId, dependencyIds, dependencySourceMarker, dependencySourceStateMarker, deriveFrom, deriveFromAsync, deriveFromSync, derivedValueParserMarker, domain, email, ensureNonEmptyString, envVar, extractArgumentMetavars, extractCommandNames, extractOptionNames, fail, fish, flag, float, formatDependencyError, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getAnnotations, getDefaultValuesFunction, getDependencyIds, getDocPage, getDocPageAsync, getDocPageSync, group, hostname, integer, ip, ipv4, ipv6, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser, isDocEntryHidden, isDocHidden, isNonEmptyString, isPendingDependencySourceState, isSuggestionHidden, isUsageHidden, isValueParser, isWrappedDependencySource, lineBreak, link, locale, longestMatch, macAddress, map, merge, mergeHidden, message, metavar, multiple, nonEmpty, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, parseAsync, parseSync, parseWithDependency, passThrough, pendingDependencySourceStateMarker, port, portRange, pwsh, runParser, runParserAsync, runParserSync, runWith, runWithAsync, runWithSync, socketAddress, string, suggest, suggestAsync, suggestSync, suggestWithDependency, text, transformsDependencyValue, transformsDependencyValueMarker, tuple, url, uuid, value, valueSet, values, withDefault, wrappedDependencySourceMarker, zsh };
|
|
15
|
+
export { DependencyRegistry, DuplicateOptionError, RunParserError, WithDefaultError, annotationKey, argument, bash, checkBooleanOption, checkEnumOption, choice, cidr, cloneDocEntry, cloneUsage, cloneUsageTerm, command, commandLine, concat, conditional, constant, createDeferredParseState, createDependencySourceState, createPendingDependencySourceState, deduplicateDocEntries, deduplicateDocFragments, defaultValues, deferredParseMarker, dependency, dependencyId, dependencyIds, dependencySourceMarker, dependencySourceStateMarker, deriveFrom, deriveFromAsync, deriveFromSync, derivedValueParserMarker, domain, email, ensureNonEmptyString, envVar, extractArgumentMetavars, extractCommandNames, extractLeadingCommandNames, extractLeadingOptionNames, extractLiteralValues, extractOptionNames, fail, fish, flag, float, formatDependencyError, formatDocPage, formatMessage, formatUsage, formatUsageTerm, getAnnotations, getDefaultValuesFunction, getDependencyIds, getDocPage, getDocPageAsync, getDocPageSync, group, hostname, integer, ip, ipv4, ipv6, isDeferredParseState, isDependencySource, isDependencySourceState, isDerivedValueParser, isDocEntryHidden, isDocHidden, isNonEmptyString, isPendingDependencySourceState, isSuggestionHidden, isUsageHidden, isValueParser, isWrappedDependencySource, lineBreak, link, locale, longestMatch, macAddress, map, merge, mergeHidden, message, metavar, multiple, nonEmpty, normalizeUsage, nu, object, option, optionName, optionNames, optional, or, parse, parseAsync, parseSync, parseWithDependency, passThrough, pendingDependencySourceStateMarker, port, portRange, pwsh, runParser, runParserAsync, runParserSync, runWith, runWithAsync, runWithSync, socketAddress, string, suggest, suggestAsync, suggestSync, suggestWithDependency, text, transformsDependencyValue, transformsDependencyValueMarker, tuple, url, uuid, value, valueSet, values, withDefault, wrappedDependencySourceMarker, zsh };
|