@optique/core 0.7.0-dev.127 → 0.7.0-dev.129
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/README.md +1 -1
- package/dist/constructs.cjs +8 -3
- package/dist/constructs.d.cts +33 -0
- package/dist/constructs.d.ts +33 -0
- package/dist/constructs.js +8 -3
- package/dist/index.cjs +1 -0
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/message.cjs +39 -6
- package/dist/message.js +39 -6
- package/dist/parser.cjs +6 -3
- package/dist/parser.d.cts +8 -0
- package/dist/parser.d.ts +8 -0
- package/dist/parser.js +6 -3
- package/dist/primitives.cjs +48 -4
- package/dist/primitives.d.cts +23 -1
- package/dist/primitives.d.ts +23 -1
- package/dist/primitives.js +48 -4
- package/dist/suggestion.cjs +186 -0
- package/dist/suggestion.js +184 -0
- package/dist/usage.cjs +33 -0
- package/dist/usage.d.cts +22 -1
- package/dist/usage.d.ts +22 -1
- package/dist/usage.js +33 -1
- package/package.json +1 -1
package/README.md
CHANGED
package/dist/constructs.cjs
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
const require_message = require('./message.cjs');
|
|
2
2
|
const require_usage = require('./usage.cjs');
|
|
3
|
+
const require_suggestion = require('./suggestion.cjs');
|
|
3
4
|
|
|
4
5
|
//#region src/constructs.ts
|
|
5
6
|
/**
|
|
@@ -42,7 +43,8 @@ function or(...args) {
|
|
|
42
43
|
error: context.buffer.length < 1 ? options?.errors?.noMatch ?? require_message.message`No matching option or command found.` : (() => {
|
|
43
44
|
const token = context.buffer[0];
|
|
44
45
|
const defaultMsg = require_message.message`Unexpected option or subcommand: ${require_message.optionName(token)}.`;
|
|
45
|
-
|
|
46
|
+
if (options?.errors?.unexpectedInput != null) return typeof options.errors.unexpectedInput === "function" ? options.errors.unexpectedInput(token) : options.errors.unexpectedInput;
|
|
47
|
+
return require_suggestion.createErrorWithSuggestions(defaultMsg, token, context.usage, "both", options?.errors?.suggestions);
|
|
46
48
|
})()
|
|
47
49
|
};
|
|
48
50
|
const orderedParsers = parsers.map((p, i) => [p, i]);
|
|
@@ -177,7 +179,8 @@ function longestMatch(...args) {
|
|
|
177
179
|
error: context.buffer.length < 1 ? options?.errors?.noMatch ?? require_message.message`No matching option or command found.` : (() => {
|
|
178
180
|
const token = context.buffer[0];
|
|
179
181
|
const defaultMsg = require_message.message`Unexpected option or subcommand: ${require_message.optionName(token)}.`;
|
|
180
|
-
|
|
182
|
+
if (options?.errors?.unexpectedInput != null) return typeof options.errors.unexpectedInput === "function" ? options.errors.unexpectedInput(token) : options.errors.unexpectedInput;
|
|
183
|
+
return require_suggestion.createErrorWithSuggestions(defaultMsg, token, context.usage, "both", options?.errors?.suggestions);
|
|
181
184
|
})()
|
|
182
185
|
};
|
|
183
186
|
for (let i = 0; i < parsers.length; i++) {
|
|
@@ -299,7 +302,9 @@ function object(labelOrParsers, maybeParsersOrOptions, maybeOptions) {
|
|
|
299
302
|
error: context.buffer.length > 0 ? (() => {
|
|
300
303
|
const token = context.buffer[0];
|
|
301
304
|
const customMessage = options.errors?.unexpectedInput;
|
|
302
|
-
|
|
305
|
+
if (customMessage) return typeof customMessage === "function" ? customMessage(token) : customMessage;
|
|
306
|
+
const baseError = require_message.message`Unexpected option or argument: ${token}.`;
|
|
307
|
+
return require_suggestion.createErrorWithSuggestions(baseError, token, context.usage, "both", options.errors?.suggestions);
|
|
303
308
|
})() : options.errors?.endOfInput ?? require_message.message`Expected an option or argument, but got end of input.`
|
|
304
309
|
};
|
|
305
310
|
let currentContext = context;
|
package/dist/constructs.d.cts
CHANGED
|
@@ -27,6 +27,17 @@ interface OrErrorOptions {
|
|
|
27
27
|
* Can be a static message or a function that receives the unexpected token.
|
|
28
28
|
*/
|
|
29
29
|
unexpectedInput?: Message | ((token: string) => Message);
|
|
30
|
+
/**
|
|
31
|
+
* Custom function to format suggestion messages.
|
|
32
|
+
* If provided, this will be used instead of the default "Did you mean?"
|
|
33
|
+
* formatting. The function receives an array of similar valid options/commands
|
|
34
|
+
* and should return a formatted message to append to the error.
|
|
35
|
+
*
|
|
36
|
+
* @param suggestions Array of similar valid option/command names
|
|
37
|
+
* @returns Formatted message to append to the error (can be empty array for no suggestions)
|
|
38
|
+
* @since 0.7.0
|
|
39
|
+
*/
|
|
40
|
+
suggestions?: (suggestions: readonly string[]) => Message;
|
|
30
41
|
}
|
|
31
42
|
/**
|
|
32
43
|
* Creates a parser that combines two mutually exclusive parsers into one.
|
|
@@ -302,6 +313,17 @@ interface LongestMatchErrorOptions {
|
|
|
302
313
|
* Can be a static message or a function that receives the unexpected token.
|
|
303
314
|
*/
|
|
304
315
|
unexpectedInput?: Message | ((token: string) => Message);
|
|
316
|
+
/**
|
|
317
|
+
* Custom function to format suggestion messages.
|
|
318
|
+
* If provided, this will be used instead of the default "Did you mean?"
|
|
319
|
+
* formatting. The function receives an array of similar valid options/commands
|
|
320
|
+
* and should return a formatted message to append to the error.
|
|
321
|
+
*
|
|
322
|
+
* @param suggestions Array of similar valid option/command names
|
|
323
|
+
* @returns Formatted message to append to the error (can be empty array for no suggestions)
|
|
324
|
+
* @since 0.7.0
|
|
325
|
+
*/
|
|
326
|
+
suggestions?: (suggestions: readonly string[]) => Message;
|
|
305
327
|
}
|
|
306
328
|
/**
|
|
307
329
|
* Creates a parser that combines two mutually exclusive parsers into one,
|
|
@@ -427,6 +449,17 @@ interface ObjectErrorOptions {
|
|
|
427
449
|
* Error message when end of input is reached unexpectedly.
|
|
428
450
|
*/
|
|
429
451
|
readonly endOfInput?: Message;
|
|
452
|
+
/**
|
|
453
|
+
* Custom function to format suggestion messages.
|
|
454
|
+
* If provided, this will be used instead of the default "Did you mean?"
|
|
455
|
+
* formatting. The function receives an array of similar valid options/commands
|
|
456
|
+
* and should return a formatted message to append to the error.
|
|
457
|
+
*
|
|
458
|
+
* @param suggestions Array of similar valid option/command names
|
|
459
|
+
* @returns Formatted message to append to the error (can be empty array for no suggestions)
|
|
460
|
+
* @since 0.7.0
|
|
461
|
+
*/
|
|
462
|
+
readonly suggestions?: (suggestions: readonly string[]) => Message;
|
|
430
463
|
}
|
|
431
464
|
/**
|
|
432
465
|
* Creates a parser that combines multiple parsers into a single object parser.
|
package/dist/constructs.d.ts
CHANGED
|
@@ -27,6 +27,17 @@ interface OrErrorOptions {
|
|
|
27
27
|
* Can be a static message or a function that receives the unexpected token.
|
|
28
28
|
*/
|
|
29
29
|
unexpectedInput?: Message | ((token: string) => Message);
|
|
30
|
+
/**
|
|
31
|
+
* Custom function to format suggestion messages.
|
|
32
|
+
* If provided, this will be used instead of the default "Did you mean?"
|
|
33
|
+
* formatting. The function receives an array of similar valid options/commands
|
|
34
|
+
* and should return a formatted message to append to the error.
|
|
35
|
+
*
|
|
36
|
+
* @param suggestions Array of similar valid option/command names
|
|
37
|
+
* @returns Formatted message to append to the error (can be empty array for no suggestions)
|
|
38
|
+
* @since 0.7.0
|
|
39
|
+
*/
|
|
40
|
+
suggestions?: (suggestions: readonly string[]) => Message;
|
|
30
41
|
}
|
|
31
42
|
/**
|
|
32
43
|
* Creates a parser that combines two mutually exclusive parsers into one.
|
|
@@ -302,6 +313,17 @@ interface LongestMatchErrorOptions {
|
|
|
302
313
|
* Can be a static message or a function that receives the unexpected token.
|
|
303
314
|
*/
|
|
304
315
|
unexpectedInput?: Message | ((token: string) => Message);
|
|
316
|
+
/**
|
|
317
|
+
* Custom function to format suggestion messages.
|
|
318
|
+
* If provided, this will be used instead of the default "Did you mean?"
|
|
319
|
+
* formatting. The function receives an array of similar valid options/commands
|
|
320
|
+
* and should return a formatted message to append to the error.
|
|
321
|
+
*
|
|
322
|
+
* @param suggestions Array of similar valid option/command names
|
|
323
|
+
* @returns Formatted message to append to the error (can be empty array for no suggestions)
|
|
324
|
+
* @since 0.7.0
|
|
325
|
+
*/
|
|
326
|
+
suggestions?: (suggestions: readonly string[]) => Message;
|
|
305
327
|
}
|
|
306
328
|
/**
|
|
307
329
|
* Creates a parser that combines two mutually exclusive parsers into one,
|
|
@@ -427,6 +449,17 @@ interface ObjectErrorOptions {
|
|
|
427
449
|
* Error message when end of input is reached unexpectedly.
|
|
428
450
|
*/
|
|
429
451
|
readonly endOfInput?: Message;
|
|
452
|
+
/**
|
|
453
|
+
* Custom function to format suggestion messages.
|
|
454
|
+
* If provided, this will be used instead of the default "Did you mean?"
|
|
455
|
+
* formatting. The function receives an array of similar valid options/commands
|
|
456
|
+
* and should return a formatted message to append to the error.
|
|
457
|
+
*
|
|
458
|
+
* @param suggestions Array of similar valid option/command names
|
|
459
|
+
* @returns Formatted message to append to the error (can be empty array for no suggestions)
|
|
460
|
+
* @since 0.7.0
|
|
461
|
+
*/
|
|
462
|
+
readonly suggestions?: (suggestions: readonly string[]) => Message;
|
|
430
463
|
}
|
|
431
464
|
/**
|
|
432
465
|
* Creates a parser that combines multiple parsers into a single object parser.
|
package/dist/constructs.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { message, optionName, values } from "./message.js";
|
|
2
2
|
import { extractOptionNames } from "./usage.js";
|
|
3
|
+
import { createErrorWithSuggestions } from "./suggestion.js";
|
|
3
4
|
|
|
4
5
|
//#region src/constructs.ts
|
|
5
6
|
/**
|
|
@@ -42,7 +43,8 @@ function or(...args) {
|
|
|
42
43
|
error: context.buffer.length < 1 ? options?.errors?.noMatch ?? message`No matching option or command found.` : (() => {
|
|
43
44
|
const token = context.buffer[0];
|
|
44
45
|
const defaultMsg = message`Unexpected option or subcommand: ${optionName(token)}.`;
|
|
45
|
-
|
|
46
|
+
if (options?.errors?.unexpectedInput != null) return typeof options.errors.unexpectedInput === "function" ? options.errors.unexpectedInput(token) : options.errors.unexpectedInput;
|
|
47
|
+
return createErrorWithSuggestions(defaultMsg, token, context.usage, "both", options?.errors?.suggestions);
|
|
46
48
|
})()
|
|
47
49
|
};
|
|
48
50
|
const orderedParsers = parsers.map((p, i) => [p, i]);
|
|
@@ -177,7 +179,8 @@ function longestMatch(...args) {
|
|
|
177
179
|
error: context.buffer.length < 1 ? options?.errors?.noMatch ?? message`No matching option or command found.` : (() => {
|
|
178
180
|
const token = context.buffer[0];
|
|
179
181
|
const defaultMsg = message`Unexpected option or subcommand: ${optionName(token)}.`;
|
|
180
|
-
|
|
182
|
+
if (options?.errors?.unexpectedInput != null) return typeof options.errors.unexpectedInput === "function" ? options.errors.unexpectedInput(token) : options.errors.unexpectedInput;
|
|
183
|
+
return createErrorWithSuggestions(defaultMsg, token, context.usage, "both", options?.errors?.suggestions);
|
|
181
184
|
})()
|
|
182
185
|
};
|
|
183
186
|
for (let i = 0; i < parsers.length; i++) {
|
|
@@ -299,7 +302,9 @@ function object(labelOrParsers, maybeParsersOrOptions, maybeOptions) {
|
|
|
299
302
|
error: context.buffer.length > 0 ? (() => {
|
|
300
303
|
const token = context.buffer[0];
|
|
301
304
|
const customMessage = options.errors?.unexpectedInput;
|
|
302
|
-
|
|
305
|
+
if (customMessage) return typeof customMessage === "function" ? customMessage(token) : customMessage;
|
|
306
|
+
const baseError = message`Unexpected option or argument: ${token}.`;
|
|
307
|
+
return createErrorWithSuggestions(baseError, token, context.usage, "both", options.errors?.suggestions);
|
|
303
308
|
})() : options.errors?.endOfInput ?? message`Expected an option or argument, but got end of input.`
|
|
304
309
|
};
|
|
305
310
|
let currentContext = context;
|
package/dist/index.cjs
CHANGED
|
@@ -19,6 +19,7 @@ exports.commandLine = require_message.commandLine;
|
|
|
19
19
|
exports.concat = require_constructs.concat;
|
|
20
20
|
exports.constant = require_primitives.constant;
|
|
21
21
|
exports.envVar = require_message.envVar;
|
|
22
|
+
exports.extractCommandNames = require_usage.extractCommandNames;
|
|
22
23
|
exports.extractOptionNames = require_usage.extractOptionNames;
|
|
23
24
|
exports.fish = require_completion.fish;
|
|
24
25
|
exports.flag = require_primitives.flag;
|
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Message, MessageFormatOptions, MessageTerm, commandLine, envVar, formatMessage, message, metavar, optionName, optionNames, text, value, values } from "./message.cjs";
|
|
2
|
-
import { OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage } from "./usage.cjs";
|
|
2
|
+
import { OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, extractCommandNames, extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage } from "./usage.cjs";
|
|
3
3
|
import { DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, ShowDefaultOptions, formatDocPage } from "./doc.cjs";
|
|
4
4
|
import { ChoiceOptions, FloatOptions, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, StringOptions, UrlOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, choice, float, integer, isValueParser, locale, string, url, uuid } from "./valueparser.cjs";
|
|
5
5
|
import { MultipleErrorOptions, MultipleOptions, WithDefaultError, WithDefaultOptions, map, multiple, optional, withDefault } from "./modifiers.cjs";
|
|
@@ -8,4 +8,4 @@ import { DocState, InferValue, Parser, ParserContext, ParserResult, Result, Sugg
|
|
|
8
8
|
import { LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, ObjectErrorOptions, ObjectOptions, OrErrorOptions, OrOptions, TupleOptions, concat, group, longestMatch, merge, object, or, tuple } from "./constructs.cjs";
|
|
9
9
|
import { ShellCompletion, bash, fish, nu, pwsh, zsh } from "./completion.cjs";
|
|
10
10
|
import { RunError, RunOptions, run } from "./facade.cjs";
|
|
11
|
-
export { ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, CommandErrorOptions, CommandOptions, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, FlagErrorOptions, FlagOptions, FloatOptions, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, Message, MessageFormatOptions, MessageTerm, MultipleErrorOptions, MultipleOptions, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OrErrorOptions, OrOptions, Parser, ParserContext, ParserResult, 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, constant, envVar, 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, pwsh, run, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };
|
|
11
|
+
export { ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, CommandErrorOptions, CommandOptions, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, FlagErrorOptions, FlagOptions, FloatOptions, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, Message, MessageFormatOptions, MessageTerm, MultipleErrorOptions, MultipleOptions, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OrErrorOptions, OrOptions, Parser, ParserContext, ParserResult, 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, constant, envVar, 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, pwsh, run, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Message, MessageFormatOptions, MessageTerm, commandLine, envVar, formatMessage, message, metavar, optionName, optionNames, text, value, values } from "./message.js";
|
|
2
|
-
import { OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage } from "./usage.js";
|
|
2
|
+
import { OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, extractCommandNames, extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage } from "./usage.js";
|
|
3
3
|
import { DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, ShowDefaultOptions, formatDocPage } from "./doc.js";
|
|
4
4
|
import { ChoiceOptions, FloatOptions, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, StringOptions, UrlOptions, Uuid, UuidOptions, ValueParser, ValueParserResult, choice, float, integer, isValueParser, locale, string, url, uuid } from "./valueparser.js";
|
|
5
5
|
import { MultipleErrorOptions, MultipleOptions, WithDefaultError, WithDefaultOptions, map, multiple, optional, withDefault } from "./modifiers.js";
|
|
@@ -8,4 +8,4 @@ import { DocState, InferValue, Parser, ParserContext, ParserResult, Result, Sugg
|
|
|
8
8
|
import { LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, ObjectErrorOptions, ObjectOptions, OrErrorOptions, OrOptions, TupleOptions, concat, group, longestMatch, merge, object, or, tuple } from "./constructs.js";
|
|
9
9
|
import { ShellCompletion, bash, fish, nu, pwsh, zsh } from "./completion.js";
|
|
10
10
|
import { RunError, RunOptions, run } from "./facade.js";
|
|
11
|
-
export { ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, CommandErrorOptions, CommandOptions, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, FlagErrorOptions, FlagOptions, FloatOptions, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, Message, MessageFormatOptions, MessageTerm, MultipleErrorOptions, MultipleOptions, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OrErrorOptions, OrOptions, Parser, ParserContext, ParserResult, 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, constant, envVar, 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, pwsh, run, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };
|
|
11
|
+
export { ArgumentErrorOptions, ArgumentOptions, ChoiceOptions, CommandErrorOptions, CommandOptions, DocEntry, DocFragment, DocFragments, DocPage, DocPageFormatOptions, DocSection, DocState, FlagErrorOptions, FlagOptions, FloatOptions, InferValue, IntegerOptionsBigInt, IntegerOptionsNumber, LocaleOptions, LongestMatchErrorOptions, LongestMatchOptions, MergeOptions, Message, MessageFormatOptions, MessageTerm, MultipleErrorOptions, MultipleOptions, ObjectErrorOptions, ObjectOptions, OptionErrorOptions, OptionName, OptionOptions, OrErrorOptions, OrOptions, Parser, ParserContext, ParserResult, 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, constant, envVar, 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, pwsh, run, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };
|
package/dist/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { commandLine, envVar, formatMessage, message, metavar, optionName, optionNames, text, value, values } from "./message.js";
|
|
2
|
-
import { extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage } from "./usage.js";
|
|
2
|
+
import { extractCommandNames, extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage } from "./usage.js";
|
|
3
3
|
import { concat, group, longestMatch, merge, object, or, tuple } from "./constructs.js";
|
|
4
4
|
import { formatDocPage } from "./doc.js";
|
|
5
5
|
import { bash, fish, nu, pwsh, zsh } from "./completion.js";
|
|
@@ -9,4 +9,4 @@ import { argument, command, constant, flag, option } from "./primitives.js";
|
|
|
9
9
|
import { getDocPage, parse, suggest } from "./parser.js";
|
|
10
10
|
import { RunError, run } from "./facade.js";
|
|
11
11
|
|
|
12
|
-
export { RunError, WithDefaultError, argument, bash, choice, command, commandLine, concat, constant, envVar, 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, pwsh, run, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };
|
|
12
|
+
export { RunError, WithDefaultError, argument, bash, choice, command, commandLine, concat, constant, envVar, 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, pwsh, run, string, suggest, text, tuple, url, uuid, value, values, withDefault, zsh };
|
package/dist/message.cjs
CHANGED
|
@@ -155,13 +155,41 @@ function formatMessage(msg, options = {}) {
|
|
|
155
155
|
const resetSequence = `\x1b[0m${resetSuffix}`;
|
|
156
156
|
function* stream() {
|
|
157
157
|
const wordPattern = /\s*\S+\s*/g;
|
|
158
|
-
for (const term of msg) if (term.type === "text")
|
|
159
|
-
const
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
158
|
+
for (const term of msg) if (term.type === "text") if (term.text.includes("\n\n")) {
|
|
159
|
+
const paragraphs = term.text.split(/\n\n+/);
|
|
160
|
+
for (let paragraphIndex = 0; paragraphIndex < paragraphs.length; paragraphIndex++) {
|
|
161
|
+
if (paragraphIndex > 0) yield {
|
|
162
|
+
text: "\n",
|
|
163
|
+
width: -1
|
|
164
|
+
};
|
|
165
|
+
const paragraph = paragraphs[paragraphIndex].replace(/\n/g, " ");
|
|
166
|
+
wordPattern.lastIndex = 0;
|
|
167
|
+
while (true) {
|
|
168
|
+
const match = wordPattern.exec(paragraph);
|
|
169
|
+
if (match == null) break;
|
|
170
|
+
yield {
|
|
171
|
+
text: match[0],
|
|
172
|
+
width: match[0].length
|
|
173
|
+
};
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
} else {
|
|
177
|
+
const normalizedText = term.text.replace(/\n/g, " ");
|
|
178
|
+
if (normalizedText.trim() === "" && normalizedText.length > 0) yield {
|
|
179
|
+
text: " ",
|
|
180
|
+
width: 1
|
|
164
181
|
};
|
|
182
|
+
else {
|
|
183
|
+
wordPattern.lastIndex = 0;
|
|
184
|
+
while (true) {
|
|
185
|
+
const match = wordPattern.exec(normalizedText);
|
|
186
|
+
if (match == null) break;
|
|
187
|
+
yield {
|
|
188
|
+
text: match[0],
|
|
189
|
+
width: match[0].length
|
|
190
|
+
};
|
|
191
|
+
}
|
|
192
|
+
}
|
|
165
193
|
}
|
|
166
194
|
else if (term.type === "optionName") {
|
|
167
195
|
const name = useQuotes ? `\`${term.optionName}\`` : term.optionName;
|
|
@@ -223,6 +251,11 @@ function formatMessage(msg, options = {}) {
|
|
|
223
251
|
let output = "";
|
|
224
252
|
let totalWidth = 0;
|
|
225
253
|
for (const { text: text$1, width } of stream()) {
|
|
254
|
+
if (width === -1) {
|
|
255
|
+
output += text$1;
|
|
256
|
+
totalWidth = 0;
|
|
257
|
+
continue;
|
|
258
|
+
}
|
|
226
259
|
if (options.maxWidth != null && totalWidth + width > options.maxWidth) {
|
|
227
260
|
output += "\n";
|
|
228
261
|
totalWidth = 0;
|
package/dist/message.js
CHANGED
|
@@ -154,13 +154,41 @@ function formatMessage(msg, options = {}) {
|
|
|
154
154
|
const resetSequence = `\x1b[0m${resetSuffix}`;
|
|
155
155
|
function* stream() {
|
|
156
156
|
const wordPattern = /\s*\S+\s*/g;
|
|
157
|
-
for (const term of msg) if (term.type === "text")
|
|
158
|
-
const
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
157
|
+
for (const term of msg) if (term.type === "text") if (term.text.includes("\n\n")) {
|
|
158
|
+
const paragraphs = term.text.split(/\n\n+/);
|
|
159
|
+
for (let paragraphIndex = 0; paragraphIndex < paragraphs.length; paragraphIndex++) {
|
|
160
|
+
if (paragraphIndex > 0) yield {
|
|
161
|
+
text: "\n",
|
|
162
|
+
width: -1
|
|
163
|
+
};
|
|
164
|
+
const paragraph = paragraphs[paragraphIndex].replace(/\n/g, " ");
|
|
165
|
+
wordPattern.lastIndex = 0;
|
|
166
|
+
while (true) {
|
|
167
|
+
const match = wordPattern.exec(paragraph);
|
|
168
|
+
if (match == null) break;
|
|
169
|
+
yield {
|
|
170
|
+
text: match[0],
|
|
171
|
+
width: match[0].length
|
|
172
|
+
};
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
} else {
|
|
176
|
+
const normalizedText = term.text.replace(/\n/g, " ");
|
|
177
|
+
if (normalizedText.trim() === "" && normalizedText.length > 0) yield {
|
|
178
|
+
text: " ",
|
|
179
|
+
width: 1
|
|
163
180
|
};
|
|
181
|
+
else {
|
|
182
|
+
wordPattern.lastIndex = 0;
|
|
183
|
+
while (true) {
|
|
184
|
+
const match = wordPattern.exec(normalizedText);
|
|
185
|
+
if (match == null) break;
|
|
186
|
+
yield {
|
|
187
|
+
text: match[0],
|
|
188
|
+
width: match[0].length
|
|
189
|
+
};
|
|
190
|
+
}
|
|
191
|
+
}
|
|
164
192
|
}
|
|
165
193
|
else if (term.type === "optionName") {
|
|
166
194
|
const name = useQuotes ? `\`${term.optionName}\`` : term.optionName;
|
|
@@ -222,6 +250,11 @@ function formatMessage(msg, options = {}) {
|
|
|
222
250
|
let output = "";
|
|
223
251
|
let totalWidth = 0;
|
|
224
252
|
for (const { text: text$1, width } of stream()) {
|
|
253
|
+
if (width === -1) {
|
|
254
|
+
output += text$1;
|
|
255
|
+
totalWidth = 0;
|
|
256
|
+
continue;
|
|
257
|
+
}
|
|
225
258
|
if (options.maxWidth != null && totalWidth + width > options.maxWidth) {
|
|
226
259
|
output += "\n";
|
|
227
260
|
totalWidth = 0;
|
package/dist/parser.cjs
CHANGED
|
@@ -23,7 +23,8 @@ function parse(parser, args) {
|
|
|
23
23
|
let context = {
|
|
24
24
|
buffer: args,
|
|
25
25
|
optionsTerminated: false,
|
|
26
|
-
state: parser.initialState
|
|
26
|
+
state: parser.initialState,
|
|
27
|
+
usage: parser.usage
|
|
27
28
|
};
|
|
28
29
|
do {
|
|
29
30
|
const result = parser.parse(context);
|
|
@@ -81,7 +82,8 @@ function suggest(parser, args) {
|
|
|
81
82
|
let context = {
|
|
82
83
|
buffer: allButLast,
|
|
83
84
|
optionsTerminated: false,
|
|
84
|
-
state: parser.initialState
|
|
85
|
+
state: parser.initialState,
|
|
86
|
+
usage: parser.usage
|
|
85
87
|
};
|
|
86
88
|
while (context.buffer.length > 0) {
|
|
87
89
|
const result = parser.parse(context);
|
|
@@ -129,7 +131,8 @@ function getDocPage(parser, args = []) {
|
|
|
129
131
|
let context = {
|
|
130
132
|
buffer: args,
|
|
131
133
|
optionsTerminated: false,
|
|
132
|
-
state: parser.initialState
|
|
134
|
+
state: parser.initialState,
|
|
135
|
+
usage: parser.usage
|
|
133
136
|
};
|
|
134
137
|
do {
|
|
135
138
|
const result = parser.parse(context);
|
package/dist/parser.d.cts
CHANGED
|
@@ -125,6 +125,14 @@ interface ParserContext<TState> {
|
|
|
125
125
|
* that no further options should be processed.
|
|
126
126
|
*/
|
|
127
127
|
readonly optionsTerminated: boolean;
|
|
128
|
+
/**
|
|
129
|
+
* Usage information for the entire parser tree.
|
|
130
|
+
* Used to provide better error messages with suggestions for typos.
|
|
131
|
+
* When a parser encounters an invalid option or command, it can use
|
|
132
|
+
* this information to suggest similar valid options.
|
|
133
|
+
* @since 0.7.0
|
|
134
|
+
*/
|
|
135
|
+
readonly usage: Usage;
|
|
128
136
|
}
|
|
129
137
|
/**
|
|
130
138
|
* Represents a suggestion for command-line completion or guidance.
|
package/dist/parser.d.ts
CHANGED
|
@@ -125,6 +125,14 @@ interface ParserContext<TState> {
|
|
|
125
125
|
* that no further options should be processed.
|
|
126
126
|
*/
|
|
127
127
|
readonly optionsTerminated: boolean;
|
|
128
|
+
/**
|
|
129
|
+
* Usage information for the entire parser tree.
|
|
130
|
+
* Used to provide better error messages with suggestions for typos.
|
|
131
|
+
* When a parser encounters an invalid option or command, it can use
|
|
132
|
+
* this information to suggest similar valid options.
|
|
133
|
+
* @since 0.7.0
|
|
134
|
+
*/
|
|
135
|
+
readonly usage: Usage;
|
|
128
136
|
}
|
|
129
137
|
/**
|
|
130
138
|
* Represents a suggestion for command-line completion or guidance.
|
package/dist/parser.js
CHANGED
|
@@ -23,7 +23,8 @@ function parse(parser, args) {
|
|
|
23
23
|
let context = {
|
|
24
24
|
buffer: args,
|
|
25
25
|
optionsTerminated: false,
|
|
26
|
-
state: parser.initialState
|
|
26
|
+
state: parser.initialState,
|
|
27
|
+
usage: parser.usage
|
|
27
28
|
};
|
|
28
29
|
do {
|
|
29
30
|
const result = parser.parse(context);
|
|
@@ -81,7 +82,8 @@ function suggest(parser, args) {
|
|
|
81
82
|
let context = {
|
|
82
83
|
buffer: allButLast,
|
|
83
84
|
optionsTerminated: false,
|
|
84
|
-
state: parser.initialState
|
|
85
|
+
state: parser.initialState,
|
|
86
|
+
usage: parser.usage
|
|
85
87
|
};
|
|
86
88
|
while (context.buffer.length > 0) {
|
|
87
89
|
const result = parser.parse(context);
|
|
@@ -129,7 +131,8 @@ function getDocPage(parser, args = []) {
|
|
|
129
131
|
let context = {
|
|
130
132
|
buffer: args,
|
|
131
133
|
optionsTerminated: false,
|
|
132
|
-
state: parser.initialState
|
|
134
|
+
state: parser.initialState,
|
|
135
|
+
usage: parser.usage
|
|
133
136
|
};
|
|
134
137
|
do {
|
|
135
138
|
const result = parser.parse(context);
|
package/dist/primitives.cjs
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
const require_message = require('./message.cjs');
|
|
2
|
+
const require_usage = require('./usage.cjs');
|
|
3
|
+
const require_suggestion = require('./suggestion.cjs');
|
|
2
4
|
const require_valueparser = require('./valueparser.cjs');
|
|
3
5
|
|
|
4
6
|
//#region src/primitives.ts
|
|
@@ -182,10 +184,23 @@ function option(...args) {
|
|
|
182
184
|
};
|
|
183
185
|
}
|
|
184
186
|
}
|
|
187
|
+
const invalidOption = context.buffer[0];
|
|
188
|
+
if (options.errors?.noMatch) {
|
|
189
|
+
const candidates = /* @__PURE__ */ new Set();
|
|
190
|
+
for (const name of require_usage.extractOptionNames(context.usage)) candidates.add(name);
|
|
191
|
+
const suggestions = require_suggestion.findSimilar(invalidOption, candidates, require_suggestion.DEFAULT_FIND_SIMILAR_OPTIONS);
|
|
192
|
+
const errorMessage = typeof options.errors.noMatch === "function" ? options.errors.noMatch(invalidOption, suggestions) : options.errors.noMatch;
|
|
193
|
+
return {
|
|
194
|
+
success: false,
|
|
195
|
+
consumed: 0,
|
|
196
|
+
error: errorMessage
|
|
197
|
+
};
|
|
198
|
+
}
|
|
199
|
+
const baseError = require_message.message`No matched option for ${require_message.optionName(invalidOption)}.`;
|
|
185
200
|
return {
|
|
186
201
|
success: false,
|
|
187
202
|
consumed: 0,
|
|
188
|
-
error:
|
|
203
|
+
error: require_suggestion.createErrorWithSuggestions(baseError, invalidOption, context.usage, "option")
|
|
189
204
|
};
|
|
190
205
|
},
|
|
191
206
|
complete(state) {
|
|
@@ -386,10 +401,23 @@ function flag(...args) {
|
|
|
386
401
|
consumed: [context.buffer[0].slice(0, 2)]
|
|
387
402
|
};
|
|
388
403
|
}
|
|
404
|
+
const invalidOption = context.buffer[0];
|
|
405
|
+
if (options.errors?.noMatch) {
|
|
406
|
+
const candidates = /* @__PURE__ */ new Set();
|
|
407
|
+
for (const name of require_usage.extractOptionNames(context.usage)) candidates.add(name);
|
|
408
|
+
const suggestions = require_suggestion.findSimilar(invalidOption, candidates, require_suggestion.DEFAULT_FIND_SIMILAR_OPTIONS);
|
|
409
|
+
const errorMessage = typeof options.errors.noMatch === "function" ? options.errors.noMatch(invalidOption, suggestions) : options.errors.noMatch;
|
|
410
|
+
return {
|
|
411
|
+
success: false,
|
|
412
|
+
consumed: 0,
|
|
413
|
+
error: errorMessage
|
|
414
|
+
};
|
|
415
|
+
}
|
|
416
|
+
const baseError = require_message.message`No matched option for ${require_message.optionName(invalidOption)}.`;
|
|
389
417
|
return {
|
|
390
418
|
success: false,
|
|
391
419
|
consumed: 0,
|
|
392
|
-
error:
|
|
420
|
+
error: require_suggestion.createErrorWithSuggestions(baseError, invalidOption, context.usage, "option")
|
|
393
421
|
};
|
|
394
422
|
},
|
|
395
423
|
complete(state) {
|
|
@@ -565,11 +593,27 @@ function command(name, parser, options = {}) {
|
|
|
565
593
|
if (context.state === void 0) {
|
|
566
594
|
if (context.buffer.length < 1 || context.buffer[0] !== name) {
|
|
567
595
|
const actual = context.buffer.length > 0 ? context.buffer[0] : null;
|
|
568
|
-
|
|
596
|
+
if (options.errors?.notMatched) {
|
|
597
|
+
const errorMessage = options.errors.notMatched;
|
|
598
|
+
const candidates = /* @__PURE__ */ new Set();
|
|
599
|
+
for (const cmdName of require_usage.extractCommandNames(context.usage)) candidates.add(cmdName);
|
|
600
|
+
const suggestions = actual ? require_suggestion.findSimilar(actual, candidates, require_suggestion.DEFAULT_FIND_SIMILAR_OPTIONS) : [];
|
|
601
|
+
return {
|
|
602
|
+
success: false,
|
|
603
|
+
consumed: 0,
|
|
604
|
+
error: typeof errorMessage === "function" ? errorMessage(name, actual, suggestions) : errorMessage
|
|
605
|
+
};
|
|
606
|
+
}
|
|
607
|
+
if (actual == null) return {
|
|
608
|
+
success: false,
|
|
609
|
+
consumed: 0,
|
|
610
|
+
error: require_message.message`Expected command ${require_message.optionName(name)}, but got end of input.`
|
|
611
|
+
};
|
|
612
|
+
const baseError = require_message.message`Expected command ${require_message.optionName(name)}, but got ${actual}.`;
|
|
569
613
|
return {
|
|
570
614
|
success: false,
|
|
571
615
|
consumed: 0,
|
|
572
|
-
error:
|
|
616
|
+
error: require_suggestion.createErrorWithSuggestions(baseError, actual, context.usage, "command")
|
|
573
617
|
};
|
|
574
618
|
}
|
|
575
619
|
return {
|
package/dist/primitives.d.cts
CHANGED
|
@@ -58,6 +58,15 @@ interface OptionErrorOptions {
|
|
|
58
58
|
* Can be a static message or a function that receives the value.
|
|
59
59
|
*/
|
|
60
60
|
unexpectedValue?: Message | ((value: string) => Message);
|
|
61
|
+
/**
|
|
62
|
+
* Custom error message when no matching option is found.
|
|
63
|
+
* Can be a static message or a function that receives:
|
|
64
|
+
* - invalidOption: The invalid option name that was provided
|
|
65
|
+
* - suggestions: Array of similar valid option names (can be empty)
|
|
66
|
+
*
|
|
67
|
+
* @since 0.7.0
|
|
68
|
+
*/
|
|
69
|
+
noMatch?: Message | ((invalidOption: string, suggestions: readonly string[]) => Message);
|
|
61
70
|
}
|
|
62
71
|
/**
|
|
63
72
|
* Creates a parser for various styles of command-line options that take an
|
|
@@ -138,6 +147,15 @@ interface FlagErrorOptions {
|
|
|
138
147
|
* Can be a static message or a function that receives the token.
|
|
139
148
|
*/
|
|
140
149
|
duplicate?: Message | ((token: string) => Message);
|
|
150
|
+
/**
|
|
151
|
+
* Custom error message when no matching flag is found.
|
|
152
|
+
* Can be a static message or a function that receives:
|
|
153
|
+
* - invalidOption: The invalid option name that was provided
|
|
154
|
+
* - suggestions: Array of similar valid option names (can be empty)
|
|
155
|
+
*
|
|
156
|
+
* @since 0.7.0
|
|
157
|
+
*/
|
|
158
|
+
noMatch?: Message | ((invalidOption: string, suggestions: readonly string[]) => Message);
|
|
141
159
|
}
|
|
142
160
|
/**
|
|
143
161
|
* Creates a parser for command-line flags that must be explicitly provided.
|
|
@@ -255,8 +273,12 @@ interface CommandOptions {
|
|
|
255
273
|
interface CommandErrorOptions {
|
|
256
274
|
/**
|
|
257
275
|
* Error message when command is expected but not found.
|
|
276
|
+
* Since version 0.7.0, the function signature now includes suggestions:
|
|
277
|
+
* - expected: The expected command name
|
|
278
|
+
* - actual: The actual input (or null if no input)
|
|
279
|
+
* - suggestions: Array of similar valid command names (can be empty)
|
|
258
280
|
*/
|
|
259
|
-
readonly notMatched?: Message | ((expected: string, actual: string | null) => Message);
|
|
281
|
+
readonly notMatched?: Message | ((expected: string, actual: string | null, suggestions?: readonly string[]) => Message);
|
|
260
282
|
/**
|
|
261
283
|
* Error message when command was not matched during completion.
|
|
262
284
|
*/
|
package/dist/primitives.d.ts
CHANGED
|
@@ -58,6 +58,15 @@ interface OptionErrorOptions {
|
|
|
58
58
|
* Can be a static message or a function that receives the value.
|
|
59
59
|
*/
|
|
60
60
|
unexpectedValue?: Message | ((value: string) => Message);
|
|
61
|
+
/**
|
|
62
|
+
* Custom error message when no matching option is found.
|
|
63
|
+
* Can be a static message or a function that receives:
|
|
64
|
+
* - invalidOption: The invalid option name that was provided
|
|
65
|
+
* - suggestions: Array of similar valid option names (can be empty)
|
|
66
|
+
*
|
|
67
|
+
* @since 0.7.0
|
|
68
|
+
*/
|
|
69
|
+
noMatch?: Message | ((invalidOption: string, suggestions: readonly string[]) => Message);
|
|
61
70
|
}
|
|
62
71
|
/**
|
|
63
72
|
* Creates a parser for various styles of command-line options that take an
|
|
@@ -138,6 +147,15 @@ interface FlagErrorOptions {
|
|
|
138
147
|
* Can be a static message or a function that receives the token.
|
|
139
148
|
*/
|
|
140
149
|
duplicate?: Message | ((token: string) => Message);
|
|
150
|
+
/**
|
|
151
|
+
* Custom error message when no matching flag is found.
|
|
152
|
+
* Can be a static message or a function that receives:
|
|
153
|
+
* - invalidOption: The invalid option name that was provided
|
|
154
|
+
* - suggestions: Array of similar valid option names (can be empty)
|
|
155
|
+
*
|
|
156
|
+
* @since 0.7.0
|
|
157
|
+
*/
|
|
158
|
+
noMatch?: Message | ((invalidOption: string, suggestions: readonly string[]) => Message);
|
|
141
159
|
}
|
|
142
160
|
/**
|
|
143
161
|
* Creates a parser for command-line flags that must be explicitly provided.
|
|
@@ -255,8 +273,12 @@ interface CommandOptions {
|
|
|
255
273
|
interface CommandErrorOptions {
|
|
256
274
|
/**
|
|
257
275
|
* Error message when command is expected but not found.
|
|
276
|
+
* Since version 0.7.0, the function signature now includes suggestions:
|
|
277
|
+
* - expected: The expected command name
|
|
278
|
+
* - actual: The actual input (or null if no input)
|
|
279
|
+
* - suggestions: Array of similar valid command names (can be empty)
|
|
258
280
|
*/
|
|
259
|
-
readonly notMatched?: Message | ((expected: string, actual: string | null) => Message);
|
|
281
|
+
readonly notMatched?: Message | ((expected: string, actual: string | null, suggestions?: readonly string[]) => Message);
|
|
260
282
|
/**
|
|
261
283
|
* Error message when command was not matched during completion.
|
|
262
284
|
*/
|
package/dist/primitives.js
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { message, metavar, optionName, optionNames } from "./message.js";
|
|
2
|
+
import { extractCommandNames, extractOptionNames } from "./usage.js";
|
|
3
|
+
import { DEFAULT_FIND_SIMILAR_OPTIONS, createErrorWithSuggestions, findSimilar } from "./suggestion.js";
|
|
2
4
|
import { isValueParser } from "./valueparser.js";
|
|
3
5
|
|
|
4
6
|
//#region src/primitives.ts
|
|
@@ -182,10 +184,23 @@ function option(...args) {
|
|
|
182
184
|
};
|
|
183
185
|
}
|
|
184
186
|
}
|
|
187
|
+
const invalidOption = context.buffer[0];
|
|
188
|
+
if (options.errors?.noMatch) {
|
|
189
|
+
const candidates = /* @__PURE__ */ new Set();
|
|
190
|
+
for (const name of extractOptionNames(context.usage)) candidates.add(name);
|
|
191
|
+
const suggestions = findSimilar(invalidOption, candidates, DEFAULT_FIND_SIMILAR_OPTIONS);
|
|
192
|
+
const errorMessage = typeof options.errors.noMatch === "function" ? options.errors.noMatch(invalidOption, suggestions) : options.errors.noMatch;
|
|
193
|
+
return {
|
|
194
|
+
success: false,
|
|
195
|
+
consumed: 0,
|
|
196
|
+
error: errorMessage
|
|
197
|
+
};
|
|
198
|
+
}
|
|
199
|
+
const baseError = message`No matched option for ${optionName(invalidOption)}.`;
|
|
185
200
|
return {
|
|
186
201
|
success: false,
|
|
187
202
|
consumed: 0,
|
|
188
|
-
error:
|
|
203
|
+
error: createErrorWithSuggestions(baseError, invalidOption, context.usage, "option")
|
|
189
204
|
};
|
|
190
205
|
},
|
|
191
206
|
complete(state) {
|
|
@@ -386,10 +401,23 @@ function flag(...args) {
|
|
|
386
401
|
consumed: [context.buffer[0].slice(0, 2)]
|
|
387
402
|
};
|
|
388
403
|
}
|
|
404
|
+
const invalidOption = context.buffer[0];
|
|
405
|
+
if (options.errors?.noMatch) {
|
|
406
|
+
const candidates = /* @__PURE__ */ new Set();
|
|
407
|
+
for (const name of extractOptionNames(context.usage)) candidates.add(name);
|
|
408
|
+
const suggestions = findSimilar(invalidOption, candidates, DEFAULT_FIND_SIMILAR_OPTIONS);
|
|
409
|
+
const errorMessage = typeof options.errors.noMatch === "function" ? options.errors.noMatch(invalidOption, suggestions) : options.errors.noMatch;
|
|
410
|
+
return {
|
|
411
|
+
success: false,
|
|
412
|
+
consumed: 0,
|
|
413
|
+
error: errorMessage
|
|
414
|
+
};
|
|
415
|
+
}
|
|
416
|
+
const baseError = message`No matched option for ${optionName(invalidOption)}.`;
|
|
389
417
|
return {
|
|
390
418
|
success: false,
|
|
391
419
|
consumed: 0,
|
|
392
|
-
error:
|
|
420
|
+
error: createErrorWithSuggestions(baseError, invalidOption, context.usage, "option")
|
|
393
421
|
};
|
|
394
422
|
},
|
|
395
423
|
complete(state) {
|
|
@@ -565,11 +593,27 @@ function command(name, parser, options = {}) {
|
|
|
565
593
|
if (context.state === void 0) {
|
|
566
594
|
if (context.buffer.length < 1 || context.buffer[0] !== name) {
|
|
567
595
|
const actual = context.buffer.length > 0 ? context.buffer[0] : null;
|
|
568
|
-
|
|
596
|
+
if (options.errors?.notMatched) {
|
|
597
|
+
const errorMessage = options.errors.notMatched;
|
|
598
|
+
const candidates = /* @__PURE__ */ new Set();
|
|
599
|
+
for (const cmdName of extractCommandNames(context.usage)) candidates.add(cmdName);
|
|
600
|
+
const suggestions = actual ? findSimilar(actual, candidates, DEFAULT_FIND_SIMILAR_OPTIONS) : [];
|
|
601
|
+
return {
|
|
602
|
+
success: false,
|
|
603
|
+
consumed: 0,
|
|
604
|
+
error: typeof errorMessage === "function" ? errorMessage(name, actual, suggestions) : errorMessage
|
|
605
|
+
};
|
|
606
|
+
}
|
|
607
|
+
if (actual == null) return {
|
|
608
|
+
success: false,
|
|
609
|
+
consumed: 0,
|
|
610
|
+
error: message`Expected command ${optionName(name)}, but got end of input.`
|
|
611
|
+
};
|
|
612
|
+
const baseError = message`Expected command ${optionName(name)}, but got ${actual}.`;
|
|
569
613
|
return {
|
|
570
614
|
success: false,
|
|
571
615
|
consumed: 0,
|
|
572
|
-
error:
|
|
616
|
+
error: createErrorWithSuggestions(baseError, actual, context.usage, "command")
|
|
573
617
|
};
|
|
574
618
|
}
|
|
575
619
|
return {
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
const require_message = require('./message.cjs');
|
|
2
|
+
const require_usage = require('./usage.cjs');
|
|
3
|
+
|
|
4
|
+
//#region src/suggestion.ts
|
|
5
|
+
/**
|
|
6
|
+
* Calculates the Levenshtein distance between two strings.
|
|
7
|
+
*
|
|
8
|
+
* The Levenshtein distance is the minimum number of single-character edits
|
|
9
|
+
* (insertions, deletions, or substitutions) required to transform one string
|
|
10
|
+
* into another.
|
|
11
|
+
*
|
|
12
|
+
* @param source The source string
|
|
13
|
+
* @param target The target string
|
|
14
|
+
* @returns The edit distance (number of insertions, deletions, substitutions)
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* levenshteinDistance("kitten", "sitting"); // returns 3
|
|
19
|
+
* levenshteinDistance("--verbos", "--verbose"); // returns 1
|
|
20
|
+
* levenshteinDistance("hello", "hello"); // returns 0
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
function levenshteinDistance(source, target) {
|
|
24
|
+
if (source.length === 0) return target.length;
|
|
25
|
+
if (target.length === 0) return source.length;
|
|
26
|
+
if (source.length > target.length) [source, target] = [target, source];
|
|
27
|
+
let previousRow = new Array(source.length + 1);
|
|
28
|
+
let currentRow = new Array(source.length + 1);
|
|
29
|
+
for (let i = 0; i <= source.length; i++) previousRow[i] = i;
|
|
30
|
+
for (let j = 1; j <= target.length; j++) {
|
|
31
|
+
currentRow[0] = j;
|
|
32
|
+
for (let i = 1; i <= source.length; i++) {
|
|
33
|
+
const cost = source[i - 1] === target[j - 1] ? 0 : 1;
|
|
34
|
+
currentRow[i] = Math.min(currentRow[i - 1] + 1, previousRow[i] + 1, previousRow[i - 1] + cost);
|
|
35
|
+
}
|
|
36
|
+
[previousRow, currentRow] = [currentRow, previousRow];
|
|
37
|
+
}
|
|
38
|
+
return previousRow[source.length];
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Default options for finding similar strings.
|
|
42
|
+
* These values are optimized for command-line option/command name suggestions.
|
|
43
|
+
*
|
|
44
|
+
* @since 0.7.0
|
|
45
|
+
*/
|
|
46
|
+
const DEFAULT_FIND_SIMILAR_OPTIONS = {
|
|
47
|
+
maxDistance: 3,
|
|
48
|
+
maxDistanceRatio: .5,
|
|
49
|
+
maxSuggestions: 3,
|
|
50
|
+
caseSensitive: false
|
|
51
|
+
};
|
|
52
|
+
/**
|
|
53
|
+
* Finds similar strings from a list of candidates.
|
|
54
|
+
*
|
|
55
|
+
* This function uses Levenshtein distance to find strings that are similar
|
|
56
|
+
* to the input string. Results are sorted by similarity (most similar first).
|
|
57
|
+
*
|
|
58
|
+
* @param input The input string to find matches for
|
|
59
|
+
* @param candidates List of candidate strings to compare against
|
|
60
|
+
* @param options Configuration options
|
|
61
|
+
* @returns Array of similar strings, sorted by similarity (most similar first)
|
|
62
|
+
*
|
|
63
|
+
* @example
|
|
64
|
+
* ```typescript
|
|
65
|
+
* const candidates = ["--verbose", "--version", "--verify", "--help"];
|
|
66
|
+
* findSimilar("--verbos", candidates);
|
|
67
|
+
* // returns ["--verbose"]
|
|
68
|
+
*
|
|
69
|
+
* findSimilar("--ver", candidates, { maxDistance: 5 });
|
|
70
|
+
* // returns ["--verify", "--version", "--verbose"]
|
|
71
|
+
*
|
|
72
|
+
* findSimilar("--xyz", candidates);
|
|
73
|
+
* // returns [] (no similar matches)
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
76
|
+
function findSimilar(input, candidates, options = {}) {
|
|
77
|
+
const maxDistance = options.maxDistance ?? DEFAULT_FIND_SIMILAR_OPTIONS.maxDistance;
|
|
78
|
+
const maxDistanceRatio = options.maxDistanceRatio ?? DEFAULT_FIND_SIMILAR_OPTIONS.maxDistanceRatio;
|
|
79
|
+
const maxSuggestions = options.maxSuggestions ?? DEFAULT_FIND_SIMILAR_OPTIONS.maxSuggestions;
|
|
80
|
+
const caseSensitive = options.caseSensitive ?? DEFAULT_FIND_SIMILAR_OPTIONS.caseSensitive;
|
|
81
|
+
if (input.length === 0) return [];
|
|
82
|
+
const normalizedInput = caseSensitive ? input : input.toLowerCase();
|
|
83
|
+
const matches = [];
|
|
84
|
+
for (const candidate of candidates) {
|
|
85
|
+
const normalizedCandidate = caseSensitive ? candidate : candidate.toLowerCase();
|
|
86
|
+
const distance = levenshteinDistance(normalizedInput, normalizedCandidate);
|
|
87
|
+
if (distance === 0) return [candidate];
|
|
88
|
+
const distanceRatio = distance / input.length;
|
|
89
|
+
if (distance <= maxDistance && distanceRatio <= maxDistanceRatio) matches.push({
|
|
90
|
+
candidate,
|
|
91
|
+
distance
|
|
92
|
+
});
|
|
93
|
+
}
|
|
94
|
+
matches.sort((a, b) => {
|
|
95
|
+
if (a.distance !== b.distance) return a.distance - b.distance;
|
|
96
|
+
const lengthDiffA = Math.abs(a.candidate.length - input.length);
|
|
97
|
+
const lengthDiffB = Math.abs(b.candidate.length - input.length);
|
|
98
|
+
if (lengthDiffA !== lengthDiffB) return lengthDiffA - lengthDiffB;
|
|
99
|
+
return a.candidate.localeCompare(b.candidate);
|
|
100
|
+
});
|
|
101
|
+
return matches.slice(0, maxSuggestions).map((m) => m.candidate);
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Creates a suggestion message for a mismatched option/command.
|
|
105
|
+
*
|
|
106
|
+
* This function formats suggestions in a user-friendly way:
|
|
107
|
+
* - No suggestions: returns empty message
|
|
108
|
+
* - One suggestion: "Did you mean `option`?"
|
|
109
|
+
* - Multiple suggestions: "Did you mean one of these?\n option1\n option2"
|
|
110
|
+
*
|
|
111
|
+
* @param suggestions List of similar valid options/commands
|
|
112
|
+
* @returns A Message array with suggestion text
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* ```typescript
|
|
116
|
+
* createSuggestionMessage(["--verbose", "--version"]);
|
|
117
|
+
* // returns message parts for:
|
|
118
|
+
* // "Did you mean one of these?
|
|
119
|
+
* // --verbose
|
|
120
|
+
* // --version"
|
|
121
|
+
*
|
|
122
|
+
* createSuggestionMessage(["--verbose"]);
|
|
123
|
+
* // returns message parts for:
|
|
124
|
+
* // "Did you mean `--verbose`?"
|
|
125
|
+
*
|
|
126
|
+
* createSuggestionMessage([]);
|
|
127
|
+
* // returns []
|
|
128
|
+
* ```
|
|
129
|
+
*/
|
|
130
|
+
function createSuggestionMessage(suggestions) {
|
|
131
|
+
if (suggestions.length === 0) return [];
|
|
132
|
+
if (suggestions.length === 1) return require_message.message`Did you mean ${require_message.optionName(suggestions[0])}?`;
|
|
133
|
+
const messageParts = [require_message.text("Did you mean one of these?")];
|
|
134
|
+
for (const suggestion of suggestions) {
|
|
135
|
+
messageParts.push(require_message.text("\n "));
|
|
136
|
+
messageParts.push(require_message.optionName(suggestion));
|
|
137
|
+
}
|
|
138
|
+
return messageParts;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Creates an error message with suggestions for similar options or commands.
|
|
142
|
+
*
|
|
143
|
+
* This is a convenience function that combines the functionality of
|
|
144
|
+
* `findSimilar()` and `createSuggestionMessage()` to generate user-friendly
|
|
145
|
+
* error messages with "Did you mean?" suggestions.
|
|
146
|
+
*
|
|
147
|
+
* @param baseError The base error message to display
|
|
148
|
+
* @param invalidInput The invalid option or command name that the user typed
|
|
149
|
+
* @param usage The usage information to extract available options/commands from
|
|
150
|
+
* @param type What type of names to suggest ("option", "command", or "both")
|
|
151
|
+
* @param customFormatter Optional custom function to format suggestions instead
|
|
152
|
+
* of using the default "Did you mean?" formatting
|
|
153
|
+
* @returns A message combining the base error with suggestions, or just the
|
|
154
|
+
* base error if no similar names are found
|
|
155
|
+
*
|
|
156
|
+
* @example
|
|
157
|
+
* ```typescript
|
|
158
|
+
* const baseError = message`No matched option for ${optionName("--verbos")}.`;
|
|
159
|
+
* const error = createErrorWithSuggestions(
|
|
160
|
+
* baseError,
|
|
161
|
+
* "--verbos",
|
|
162
|
+
* context.usage,
|
|
163
|
+
* "option"
|
|
164
|
+
* );
|
|
165
|
+
* // Returns: "No matched option for `--verbos`.\nDid you mean `--verbose`?"
|
|
166
|
+
* ```
|
|
167
|
+
*
|
|
168
|
+
* @since 0.7.0
|
|
169
|
+
*/
|
|
170
|
+
function createErrorWithSuggestions(baseError, invalidInput, usage, type = "both", customFormatter) {
|
|
171
|
+
const candidates = /* @__PURE__ */ new Set();
|
|
172
|
+
if (type === "option" || type === "both") for (const name of require_usage.extractOptionNames(usage)) candidates.add(name);
|
|
173
|
+
if (type === "command" || type === "both") for (const name of require_usage.extractCommandNames(usage)) candidates.add(name);
|
|
174
|
+
const suggestions = findSimilar(invalidInput, candidates, DEFAULT_FIND_SIMILAR_OPTIONS);
|
|
175
|
+
const suggestionMsg = customFormatter ? customFormatter(suggestions) : createSuggestionMessage(suggestions);
|
|
176
|
+
return suggestionMsg.length > 0 ? [
|
|
177
|
+
...baseError,
|
|
178
|
+
require_message.text("\n\n"),
|
|
179
|
+
...suggestionMsg
|
|
180
|
+
] : baseError;
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
//#endregion
|
|
184
|
+
exports.DEFAULT_FIND_SIMILAR_OPTIONS = DEFAULT_FIND_SIMILAR_OPTIONS;
|
|
185
|
+
exports.createErrorWithSuggestions = createErrorWithSuggestions;
|
|
186
|
+
exports.findSimilar = findSimilar;
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
import { message, optionName, text } from "./message.js";
|
|
2
|
+
import { extractCommandNames, extractOptionNames } from "./usage.js";
|
|
3
|
+
|
|
4
|
+
//#region src/suggestion.ts
|
|
5
|
+
/**
|
|
6
|
+
* Calculates the Levenshtein distance between two strings.
|
|
7
|
+
*
|
|
8
|
+
* The Levenshtein distance is the minimum number of single-character edits
|
|
9
|
+
* (insertions, deletions, or substitutions) required to transform one string
|
|
10
|
+
* into another.
|
|
11
|
+
*
|
|
12
|
+
* @param source The source string
|
|
13
|
+
* @param target The target string
|
|
14
|
+
* @returns The edit distance (number of insertions, deletions, substitutions)
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* levenshteinDistance("kitten", "sitting"); // returns 3
|
|
19
|
+
* levenshteinDistance("--verbos", "--verbose"); // returns 1
|
|
20
|
+
* levenshteinDistance("hello", "hello"); // returns 0
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
function levenshteinDistance(source, target) {
|
|
24
|
+
if (source.length === 0) return target.length;
|
|
25
|
+
if (target.length === 0) return source.length;
|
|
26
|
+
if (source.length > target.length) [source, target] = [target, source];
|
|
27
|
+
let previousRow = new Array(source.length + 1);
|
|
28
|
+
let currentRow = new Array(source.length + 1);
|
|
29
|
+
for (let i = 0; i <= source.length; i++) previousRow[i] = i;
|
|
30
|
+
for (let j = 1; j <= target.length; j++) {
|
|
31
|
+
currentRow[0] = j;
|
|
32
|
+
for (let i = 1; i <= source.length; i++) {
|
|
33
|
+
const cost = source[i - 1] === target[j - 1] ? 0 : 1;
|
|
34
|
+
currentRow[i] = Math.min(currentRow[i - 1] + 1, previousRow[i] + 1, previousRow[i - 1] + cost);
|
|
35
|
+
}
|
|
36
|
+
[previousRow, currentRow] = [currentRow, previousRow];
|
|
37
|
+
}
|
|
38
|
+
return previousRow[source.length];
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Default options for finding similar strings.
|
|
42
|
+
* These values are optimized for command-line option/command name suggestions.
|
|
43
|
+
*
|
|
44
|
+
* @since 0.7.0
|
|
45
|
+
*/
|
|
46
|
+
const DEFAULT_FIND_SIMILAR_OPTIONS = {
|
|
47
|
+
maxDistance: 3,
|
|
48
|
+
maxDistanceRatio: .5,
|
|
49
|
+
maxSuggestions: 3,
|
|
50
|
+
caseSensitive: false
|
|
51
|
+
};
|
|
52
|
+
/**
|
|
53
|
+
* Finds similar strings from a list of candidates.
|
|
54
|
+
*
|
|
55
|
+
* This function uses Levenshtein distance to find strings that are similar
|
|
56
|
+
* to the input string. Results are sorted by similarity (most similar first).
|
|
57
|
+
*
|
|
58
|
+
* @param input The input string to find matches for
|
|
59
|
+
* @param candidates List of candidate strings to compare against
|
|
60
|
+
* @param options Configuration options
|
|
61
|
+
* @returns Array of similar strings, sorted by similarity (most similar first)
|
|
62
|
+
*
|
|
63
|
+
* @example
|
|
64
|
+
* ```typescript
|
|
65
|
+
* const candidates = ["--verbose", "--version", "--verify", "--help"];
|
|
66
|
+
* findSimilar("--verbos", candidates);
|
|
67
|
+
* // returns ["--verbose"]
|
|
68
|
+
*
|
|
69
|
+
* findSimilar("--ver", candidates, { maxDistance: 5 });
|
|
70
|
+
* // returns ["--verify", "--version", "--verbose"]
|
|
71
|
+
*
|
|
72
|
+
* findSimilar("--xyz", candidates);
|
|
73
|
+
* // returns [] (no similar matches)
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
76
|
+
function findSimilar(input, candidates, options = {}) {
|
|
77
|
+
const maxDistance = options.maxDistance ?? DEFAULT_FIND_SIMILAR_OPTIONS.maxDistance;
|
|
78
|
+
const maxDistanceRatio = options.maxDistanceRatio ?? DEFAULT_FIND_SIMILAR_OPTIONS.maxDistanceRatio;
|
|
79
|
+
const maxSuggestions = options.maxSuggestions ?? DEFAULT_FIND_SIMILAR_OPTIONS.maxSuggestions;
|
|
80
|
+
const caseSensitive = options.caseSensitive ?? DEFAULT_FIND_SIMILAR_OPTIONS.caseSensitive;
|
|
81
|
+
if (input.length === 0) return [];
|
|
82
|
+
const normalizedInput = caseSensitive ? input : input.toLowerCase();
|
|
83
|
+
const matches = [];
|
|
84
|
+
for (const candidate of candidates) {
|
|
85
|
+
const normalizedCandidate = caseSensitive ? candidate : candidate.toLowerCase();
|
|
86
|
+
const distance = levenshteinDistance(normalizedInput, normalizedCandidate);
|
|
87
|
+
if (distance === 0) return [candidate];
|
|
88
|
+
const distanceRatio = distance / input.length;
|
|
89
|
+
if (distance <= maxDistance && distanceRatio <= maxDistanceRatio) matches.push({
|
|
90
|
+
candidate,
|
|
91
|
+
distance
|
|
92
|
+
});
|
|
93
|
+
}
|
|
94
|
+
matches.sort((a, b) => {
|
|
95
|
+
if (a.distance !== b.distance) return a.distance - b.distance;
|
|
96
|
+
const lengthDiffA = Math.abs(a.candidate.length - input.length);
|
|
97
|
+
const lengthDiffB = Math.abs(b.candidate.length - input.length);
|
|
98
|
+
if (lengthDiffA !== lengthDiffB) return lengthDiffA - lengthDiffB;
|
|
99
|
+
return a.candidate.localeCompare(b.candidate);
|
|
100
|
+
});
|
|
101
|
+
return matches.slice(0, maxSuggestions).map((m) => m.candidate);
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Creates a suggestion message for a mismatched option/command.
|
|
105
|
+
*
|
|
106
|
+
* This function formats suggestions in a user-friendly way:
|
|
107
|
+
* - No suggestions: returns empty message
|
|
108
|
+
* - One suggestion: "Did you mean `option`?"
|
|
109
|
+
* - Multiple suggestions: "Did you mean one of these?\n option1\n option2"
|
|
110
|
+
*
|
|
111
|
+
* @param suggestions List of similar valid options/commands
|
|
112
|
+
* @returns A Message array with suggestion text
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* ```typescript
|
|
116
|
+
* createSuggestionMessage(["--verbose", "--version"]);
|
|
117
|
+
* // returns message parts for:
|
|
118
|
+
* // "Did you mean one of these?
|
|
119
|
+
* // --verbose
|
|
120
|
+
* // --version"
|
|
121
|
+
*
|
|
122
|
+
* createSuggestionMessage(["--verbose"]);
|
|
123
|
+
* // returns message parts for:
|
|
124
|
+
* // "Did you mean `--verbose`?"
|
|
125
|
+
*
|
|
126
|
+
* createSuggestionMessage([]);
|
|
127
|
+
* // returns []
|
|
128
|
+
* ```
|
|
129
|
+
*/
|
|
130
|
+
function createSuggestionMessage(suggestions) {
|
|
131
|
+
if (suggestions.length === 0) return [];
|
|
132
|
+
if (suggestions.length === 1) return message`Did you mean ${optionName(suggestions[0])}?`;
|
|
133
|
+
const messageParts = [text("Did you mean one of these?")];
|
|
134
|
+
for (const suggestion of suggestions) {
|
|
135
|
+
messageParts.push(text("\n "));
|
|
136
|
+
messageParts.push(optionName(suggestion));
|
|
137
|
+
}
|
|
138
|
+
return messageParts;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Creates an error message with suggestions for similar options or commands.
|
|
142
|
+
*
|
|
143
|
+
* This is a convenience function that combines the functionality of
|
|
144
|
+
* `findSimilar()` and `createSuggestionMessage()` to generate user-friendly
|
|
145
|
+
* error messages with "Did you mean?" suggestions.
|
|
146
|
+
*
|
|
147
|
+
* @param baseError The base error message to display
|
|
148
|
+
* @param invalidInput The invalid option or command name that the user typed
|
|
149
|
+
* @param usage The usage information to extract available options/commands from
|
|
150
|
+
* @param type What type of names to suggest ("option", "command", or "both")
|
|
151
|
+
* @param customFormatter Optional custom function to format suggestions instead
|
|
152
|
+
* of using the default "Did you mean?" formatting
|
|
153
|
+
* @returns A message combining the base error with suggestions, or just the
|
|
154
|
+
* base error if no similar names are found
|
|
155
|
+
*
|
|
156
|
+
* @example
|
|
157
|
+
* ```typescript
|
|
158
|
+
* const baseError = message`No matched option for ${optionName("--verbos")}.`;
|
|
159
|
+
* const error = createErrorWithSuggestions(
|
|
160
|
+
* baseError,
|
|
161
|
+
* "--verbos",
|
|
162
|
+
* context.usage,
|
|
163
|
+
* "option"
|
|
164
|
+
* );
|
|
165
|
+
* // Returns: "No matched option for `--verbos`.\nDid you mean `--verbose`?"
|
|
166
|
+
* ```
|
|
167
|
+
*
|
|
168
|
+
* @since 0.7.0
|
|
169
|
+
*/
|
|
170
|
+
function createErrorWithSuggestions(baseError, invalidInput, usage, type = "both", customFormatter) {
|
|
171
|
+
const candidates = /* @__PURE__ */ new Set();
|
|
172
|
+
if (type === "option" || type === "both") for (const name of extractOptionNames(usage)) candidates.add(name);
|
|
173
|
+
if (type === "command" || type === "both") for (const name of extractCommandNames(usage)) candidates.add(name);
|
|
174
|
+
const suggestions = findSimilar(invalidInput, candidates, DEFAULT_FIND_SIMILAR_OPTIONS);
|
|
175
|
+
const suggestionMsg = customFormatter ? customFormatter(suggestions) : createSuggestionMessage(suggestions);
|
|
176
|
+
return suggestionMsg.length > 0 ? [
|
|
177
|
+
...baseError,
|
|
178
|
+
text("\n\n"),
|
|
179
|
+
...suggestionMsg
|
|
180
|
+
] : baseError;
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
//#endregion
|
|
184
|
+
export { DEFAULT_FIND_SIMILAR_OPTIONS, createErrorWithSuggestions, findSimilar };
|
package/dist/usage.cjs
CHANGED
|
@@ -23,6 +23,7 @@
|
|
|
23
23
|
function extractOptionNames(usage) {
|
|
24
24
|
const names = /* @__PURE__ */ new Set();
|
|
25
25
|
function traverseUsage(terms) {
|
|
26
|
+
if (!terms || !Array.isArray(terms)) return;
|
|
26
27
|
for (const term of terms) if (term.type === "option") for (const name of term.names) names.add(name);
|
|
27
28
|
else if (term.type === "optional" || term.type === "multiple") traverseUsage(term.terms);
|
|
28
29
|
else if (term.type === "exclusive") for (const exclusiveUsage of term.terms) traverseUsage(exclusiveUsage);
|
|
@@ -31,6 +32,37 @@ function extractOptionNames(usage) {
|
|
|
31
32
|
return names;
|
|
32
33
|
}
|
|
33
34
|
/**
|
|
35
|
+
* Extracts all command names from a Usage array.
|
|
36
|
+
*
|
|
37
|
+
* This function recursively traverses the usage structure and collects
|
|
38
|
+
* all command names, similar to {@link extractOptionNames}.
|
|
39
|
+
*
|
|
40
|
+
* @param usage The usage structure to extract command names from
|
|
41
|
+
* @returns A Set of all command names found in the usage structure
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* ```typescript
|
|
45
|
+
* const usage: Usage = [
|
|
46
|
+
* { type: "command", name: "build" },
|
|
47
|
+
* { type: "command", name: "test" },
|
|
48
|
+
* ];
|
|
49
|
+
* const names = extractCommandNames(usage);
|
|
50
|
+
* // names = Set(["build", "test"])
|
|
51
|
+
* ```
|
|
52
|
+
* @since 0.7.0
|
|
53
|
+
*/
|
|
54
|
+
function extractCommandNames(usage) {
|
|
55
|
+
const names = /* @__PURE__ */ new Set();
|
|
56
|
+
function traverseUsage(terms) {
|
|
57
|
+
if (!terms || !Array.isArray(terms)) return;
|
|
58
|
+
for (const term of terms) if (term.type === "command") names.add(term.name);
|
|
59
|
+
else if (term.type === "optional" || term.type === "multiple") traverseUsage(term.terms);
|
|
60
|
+
else if (term.type === "exclusive") for (const exclusiveUsage of term.terms) traverseUsage(exclusiveUsage);
|
|
61
|
+
}
|
|
62
|
+
traverseUsage(usage);
|
|
63
|
+
return names;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
34
66
|
* Formats a usage description into a human-readable string representation
|
|
35
67
|
* suitable for command-line help text.
|
|
36
68
|
*
|
|
@@ -267,6 +299,7 @@ function* formatUsageTermInternal(term, options) {
|
|
|
267
299
|
}
|
|
268
300
|
|
|
269
301
|
//#endregion
|
|
302
|
+
exports.extractCommandNames = extractCommandNames;
|
|
270
303
|
exports.extractOptionNames = extractOptionNames;
|
|
271
304
|
exports.formatUsage = formatUsage;
|
|
272
305
|
exports.formatUsageTerm = formatUsageTerm;
|
package/dist/usage.d.cts
CHANGED
|
@@ -137,6 +137,27 @@ type Usage = readonly UsageTerm[];
|
|
|
137
137
|
* ```
|
|
138
138
|
*/
|
|
139
139
|
declare function extractOptionNames(usage: Usage): Set<string>;
|
|
140
|
+
/**
|
|
141
|
+
* Extracts all command names from a Usage array.
|
|
142
|
+
*
|
|
143
|
+
* This function recursively traverses the usage structure and collects
|
|
144
|
+
* all command names, similar to {@link extractOptionNames}.
|
|
145
|
+
*
|
|
146
|
+
* @param usage The usage structure to extract command names from
|
|
147
|
+
* @returns A Set of all command names found in the usage structure
|
|
148
|
+
*
|
|
149
|
+
* @example
|
|
150
|
+
* ```typescript
|
|
151
|
+
* const usage: Usage = [
|
|
152
|
+
* { type: "command", name: "build" },
|
|
153
|
+
* { type: "command", name: "test" },
|
|
154
|
+
* ];
|
|
155
|
+
* const names = extractCommandNames(usage);
|
|
156
|
+
* // names = Set(["build", "test"])
|
|
157
|
+
* ```
|
|
158
|
+
* @since 0.7.0
|
|
159
|
+
*/
|
|
160
|
+
declare function extractCommandNames(usage: Usage): Set<string>;
|
|
140
161
|
/**
|
|
141
162
|
* Options for formatting usage descriptions.
|
|
142
163
|
*/
|
|
@@ -235,4 +256,4 @@ interface UsageTermFormatOptions extends UsageFormatOptions {
|
|
|
235
256
|
*/
|
|
236
257
|
declare function formatUsageTerm(term: UsageTerm, options?: UsageTermFormatOptions): string;
|
|
237
258
|
//#endregion
|
|
238
|
-
export { OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage };
|
|
259
|
+
export { OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, extractCommandNames, extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage };
|
package/dist/usage.d.ts
CHANGED
|
@@ -137,6 +137,27 @@ type Usage = readonly UsageTerm[];
|
|
|
137
137
|
* ```
|
|
138
138
|
*/
|
|
139
139
|
declare function extractOptionNames(usage: Usage): Set<string>;
|
|
140
|
+
/**
|
|
141
|
+
* Extracts all command names from a Usage array.
|
|
142
|
+
*
|
|
143
|
+
* This function recursively traverses the usage structure and collects
|
|
144
|
+
* all command names, similar to {@link extractOptionNames}.
|
|
145
|
+
*
|
|
146
|
+
* @param usage The usage structure to extract command names from
|
|
147
|
+
* @returns A Set of all command names found in the usage structure
|
|
148
|
+
*
|
|
149
|
+
* @example
|
|
150
|
+
* ```typescript
|
|
151
|
+
* const usage: Usage = [
|
|
152
|
+
* { type: "command", name: "build" },
|
|
153
|
+
* { type: "command", name: "test" },
|
|
154
|
+
* ];
|
|
155
|
+
* const names = extractCommandNames(usage);
|
|
156
|
+
* // names = Set(["build", "test"])
|
|
157
|
+
* ```
|
|
158
|
+
* @since 0.7.0
|
|
159
|
+
*/
|
|
160
|
+
declare function extractCommandNames(usage: Usage): Set<string>;
|
|
140
161
|
/**
|
|
141
162
|
* Options for formatting usage descriptions.
|
|
142
163
|
*/
|
|
@@ -235,4 +256,4 @@ interface UsageTermFormatOptions extends UsageFormatOptions {
|
|
|
235
256
|
*/
|
|
236
257
|
declare function formatUsageTerm(term: UsageTerm, options?: UsageTermFormatOptions): string;
|
|
237
258
|
//#endregion
|
|
238
|
-
export { OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage };
|
|
259
|
+
export { OptionName, Usage, UsageFormatOptions, UsageTerm, UsageTermFormatOptions, extractCommandNames, extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage };
|
package/dist/usage.js
CHANGED
|
@@ -22,6 +22,7 @@
|
|
|
22
22
|
function extractOptionNames(usage) {
|
|
23
23
|
const names = /* @__PURE__ */ new Set();
|
|
24
24
|
function traverseUsage(terms) {
|
|
25
|
+
if (!terms || !Array.isArray(terms)) return;
|
|
25
26
|
for (const term of terms) if (term.type === "option") for (const name of term.names) names.add(name);
|
|
26
27
|
else if (term.type === "optional" || term.type === "multiple") traverseUsage(term.terms);
|
|
27
28
|
else if (term.type === "exclusive") for (const exclusiveUsage of term.terms) traverseUsage(exclusiveUsage);
|
|
@@ -30,6 +31,37 @@ function extractOptionNames(usage) {
|
|
|
30
31
|
return names;
|
|
31
32
|
}
|
|
32
33
|
/**
|
|
34
|
+
* Extracts all command names from a Usage array.
|
|
35
|
+
*
|
|
36
|
+
* This function recursively traverses the usage structure and collects
|
|
37
|
+
* all command names, similar to {@link extractOptionNames}.
|
|
38
|
+
*
|
|
39
|
+
* @param usage The usage structure to extract command names from
|
|
40
|
+
* @returns A Set of all command names found in the usage structure
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```typescript
|
|
44
|
+
* const usage: Usage = [
|
|
45
|
+
* { type: "command", name: "build" },
|
|
46
|
+
* { type: "command", name: "test" },
|
|
47
|
+
* ];
|
|
48
|
+
* const names = extractCommandNames(usage);
|
|
49
|
+
* // names = Set(["build", "test"])
|
|
50
|
+
* ```
|
|
51
|
+
* @since 0.7.0
|
|
52
|
+
*/
|
|
53
|
+
function extractCommandNames(usage) {
|
|
54
|
+
const names = /* @__PURE__ */ new Set();
|
|
55
|
+
function traverseUsage(terms) {
|
|
56
|
+
if (!terms || !Array.isArray(terms)) return;
|
|
57
|
+
for (const term of terms) if (term.type === "command") names.add(term.name);
|
|
58
|
+
else if (term.type === "optional" || term.type === "multiple") traverseUsage(term.terms);
|
|
59
|
+
else if (term.type === "exclusive") for (const exclusiveUsage of term.terms) traverseUsage(exclusiveUsage);
|
|
60
|
+
}
|
|
61
|
+
traverseUsage(usage);
|
|
62
|
+
return names;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
33
65
|
* Formats a usage description into a human-readable string representation
|
|
34
66
|
* suitable for command-line help text.
|
|
35
67
|
*
|
|
@@ -266,4 +298,4 @@ function* formatUsageTermInternal(term, options) {
|
|
|
266
298
|
}
|
|
267
299
|
|
|
268
300
|
//#endregion
|
|
269
|
-
export { extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage };
|
|
301
|
+
export { extractCommandNames, extractOptionNames, formatUsage, formatUsageTerm, normalizeUsage };
|