@gunshi/definition 0.37.2 → 0.37.3
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/lib/index.d.ts +2 -41
- package/package.json +2 -2
package/lib/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
//#region ../../node_modules/.pnpm/args-tokens@0.
|
|
1
|
+
//#region ../../node_modules/.pnpm/args-tokens@0.29.0/node_modules/args-tokens/lib/parser-DT7Ztcch.d.ts
|
|
2
2
|
//#region src/parser.d.ts
|
|
3
3
|
/**
|
|
4
4
|
* Entry point of argument parser.
|
|
@@ -55,7 +55,7 @@ interface ArgToken {
|
|
|
55
55
|
* Parser Options.
|
|
56
56
|
*/
|
|
57
57
|
//#endregion
|
|
58
|
-
//#region ../../node_modules/.pnpm/args-tokens@0.
|
|
58
|
+
//#region ../../node_modules/.pnpm/args-tokens@0.29.0/node_modules/args-tokens/lib/resolver.d.ts
|
|
59
59
|
//#region src/resolver.d.ts
|
|
60
60
|
/**
|
|
61
61
|
* An argument schema definition for command-line argument parsing.
|
|
@@ -508,13 +508,6 @@ interface ArgSchema {
|
|
|
508
508
|
*/
|
|
509
509
|
parse?: (value: string) => any;
|
|
510
510
|
}
|
|
511
|
-
/**
|
|
512
|
-
* Machine-readable error codes for {@link ArgsValidationError}.
|
|
513
|
-
*
|
|
514
|
-
* Each code identifies a validation failure category and is also suitable as an
|
|
515
|
-
* i18n resource key for localized rendering.
|
|
516
|
-
*/
|
|
517
|
-
|
|
518
511
|
/**
|
|
519
512
|
* An object that contains {@link ArgSchema | argument schema}.
|
|
520
513
|
*
|
|
@@ -582,38 +575,6 @@ type IsRequiredPositionalArg<A extends ArgSchema> = A['type'] extends 'positiona
|
|
|
582
575
|
* @typeParam A - {@link Args | Arguments}, which is an object that defines the command line arguments.
|
|
583
576
|
*/
|
|
584
577
|
type ArgExplicitlyProvided<A extends Args> = { [K in keyof A]: boolean };
|
|
585
|
-
/**
|
|
586
|
-
* Resolve command line arguments.
|
|
587
|
-
*
|
|
588
|
-
* @typeParam A - {@link Args | Arguments}, which is an object that defines the command line arguments.
|
|
589
|
-
*
|
|
590
|
-
* @param args - An arguments that contains {@link ArgSchema | arguments schema}.
|
|
591
|
-
* @param tokens - An array of {@link ArgToken | tokens}.
|
|
592
|
-
* @param resolveArgs - An arguments that contains {@link ResolveArgs | resolve arguments}.
|
|
593
|
-
* @returns An object that contains the values of the arguments, positional arguments, rest arguments, {@link AggregateError | validation errors}, and explicit provision status.
|
|
594
|
-
*
|
|
595
|
-
* @example
|
|
596
|
-
* ```typescript
|
|
597
|
-
* // passed tokens: --port 3000
|
|
598
|
-
*
|
|
599
|
-
* const { values, explicit } = resolveArgs({
|
|
600
|
-
* port: {
|
|
601
|
-
* type: 'number',
|
|
602
|
-
* default: 8080
|
|
603
|
-
* },
|
|
604
|
-
* host: {
|
|
605
|
-
* type: 'string',
|
|
606
|
-
* default: 'localhost'
|
|
607
|
-
* }
|
|
608
|
-
* }, parsedTokens)
|
|
609
|
-
*
|
|
610
|
-
* values.port // 3000
|
|
611
|
-
* values.host // 'localhost'
|
|
612
|
-
*
|
|
613
|
-
* explicit.port // true (explicitly provided)
|
|
614
|
-
* explicit.host // false (not provided, fallback to default)
|
|
615
|
-
* ```
|
|
616
|
-
*/
|
|
617
578
|
//#endregion
|
|
618
579
|
//#region ../gunshi/src/plugin/context.d.ts
|
|
619
580
|
/**
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gunshi/definition",
|
|
3
3
|
"description": "utilities for gunshi command definition",
|
|
4
|
-
"version": "0.37.
|
|
4
|
+
"version": "0.37.3",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "kazuya kawaguchi",
|
|
7
7
|
"email": "kawakazu80@gmail.com"
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
"jsr-exports-lint": "^0.4.2",
|
|
58
58
|
"publint": "^0.3.20",
|
|
59
59
|
"tsdown": "0.21.0",
|
|
60
|
-
"gunshi": "0.37.
|
|
60
|
+
"gunshi": "0.37.3"
|
|
61
61
|
},
|
|
62
62
|
"scripts": {
|
|
63
63
|
"build": "tsdown",
|