@gunshi/definition 1.0.0-rc.4 → 1.0.0-rc.5
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 +0 -6
- package/lib/index.d.ts +8 -11
- package/package.json +3 -8
package/README.md
CHANGED
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
[![Version][npm-version-src]][npm-version-href]
|
|
4
4
|
[![InstallSize][install-size-src]][install-size-src]
|
|
5
|
-
[![JSR][jsr-src]][jsr-href]
|
|
6
5
|
|
|
7
6
|
> utilities for gunshi command definition
|
|
8
7
|
|
|
@@ -32,9 +31,6 @@ pnpm add @gunshi/definition
|
|
|
32
31
|
## yarn
|
|
33
32
|
yarn add @gunshi/definition
|
|
34
33
|
|
|
35
|
-
## deno
|
|
36
|
-
deno add jsr:@gunshi/definition
|
|
37
|
-
|
|
38
34
|
## bun
|
|
39
35
|
bun add @gunshi/definition
|
|
40
36
|
```
|
|
@@ -84,6 +80,4 @@ About details, See the below official docs sections:
|
|
|
84
80
|
|
|
85
81
|
[npm-version-src]: https://img.shields.io/npm/v/@gunshi/definition?style=flat
|
|
86
82
|
[npm-version-href]: https://npmjs.com/package/@gunshi/definition@alpha
|
|
87
|
-
[jsr-src]: https://jsr.io/badges/@gunshi/definition
|
|
88
|
-
[jsr-href]: https://jsr.io/@gunshi/definition
|
|
89
83
|
[install-size-src]: https://pkg-size.dev/badge/install/23122
|
package/lib/index.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
//#region ../../node_modules/.pnpm/args-tokens@1.0.
|
|
2
|
-
//#region src/parser.d.ts
|
|
1
|
+
//#region ../../node_modules/.pnpm/args-tokens@1.0.2/node_modules/args-tokens/lib/parser-DvPxBZG9.d.ts
|
|
3
2
|
/**
|
|
4
3
|
* Entry point of argument parser.
|
|
5
4
|
*
|
|
@@ -56,8 +55,7 @@ interface ArgToken {
|
|
|
56
55
|
inlineValue?: boolean | undefined;
|
|
57
56
|
}
|
|
58
57
|
//#endregion
|
|
59
|
-
//#region ../../node_modules/.pnpm/args-tokens@1.0.
|
|
60
|
-
//#region src/resolver.d.ts
|
|
58
|
+
//#region ../../node_modules/.pnpm/args-tokens@1.0.2/node_modules/args-tokens/lib/resolver.d.ts
|
|
61
59
|
/**
|
|
62
60
|
* An argument schema definition for command-line argument parsing.
|
|
63
61
|
*
|
|
@@ -419,9 +417,9 @@ interface ArgSchema {
|
|
|
419
417
|
*/
|
|
420
418
|
toKebab?: true;
|
|
421
419
|
/**
|
|
422
|
-
* Names of other
|
|
420
|
+
* Names of other arguments that conflict with this argument.
|
|
423
421
|
*
|
|
424
|
-
* When this
|
|
422
|
+
* When this argument is used together with any of the conflicting arguments, the error is an
|
|
425
423
|
* `ArgResolveError` with type 'conflict' and the code `err:arg:conflict`
|
|
426
424
|
* ({@link ArgsValidationErrorKeys}.conflict). Its `values` has the `displayName` and `name` of
|
|
427
425
|
* the argument whose `conflicts` names the other one, and the `conflictDisplayName` and
|
|
@@ -431,9 +429,8 @@ interface ArgSchema {
|
|
|
431
429
|
*
|
|
432
430
|
* A positional argument can be on either side, such as `[file]` and `--stdin`. It conflicts when
|
|
433
431
|
* it is given, and it is shown by its name, such as `'file'` (in kebab-case with `toKebab`), as
|
|
434
|
-
* in its other errors. The message
|
|
435
|
-
* `
|
|
436
|
-
* `Optional argument '--stdin' conflicts with 'file'`.
|
|
432
|
+
* in its other errors. The message names the argument given as `name` first:
|
|
433
|
+
* `'file' conflicts with '--stdin'` or `'--stdin' conflicts with 'file'`.
|
|
437
434
|
*
|
|
438
435
|
* Conflicts only need to be defined on one side - if option A defines a conflict
|
|
439
436
|
* with option B, the conflict is automatically detected when both are used,
|
|
@@ -472,7 +469,7 @@ interface ArgSchema {
|
|
|
472
469
|
* }
|
|
473
470
|
* }
|
|
474
471
|
* // Usage: --summer --autumn reports an error
|
|
475
|
-
* // Error: "
|
|
472
|
+
* // Error: "'--summer' conflicts with '--autumn'"
|
|
476
473
|
* ```
|
|
477
474
|
*
|
|
478
475
|
* @example
|
|
@@ -512,7 +509,7 @@ interface ArgSchema {
|
|
|
512
509
|
* toKebab: true // Accessible as --autumn-season
|
|
513
510
|
* }
|
|
514
511
|
* }
|
|
515
|
-
* // Error: "
|
|
512
|
+
* // Error: "'--summer-season' conflicts with '--autumn-season'"
|
|
516
513
|
* ```
|
|
517
514
|
*/
|
|
518
515
|
conflicts?: string | string[];
|
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": "1.0.0-rc.
|
|
4
|
+
"version": "1.0.0-rc.5",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "kazuya kawaguchi",
|
|
7
7
|
"email": "kawakazu80@gmail.com"
|
|
@@ -52,16 +52,11 @@
|
|
|
52
52
|
}
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
|
-
"
|
|
56
|
-
"gunshi": "1.0.0-rc.4",
|
|
57
|
-
"jsr": "^0.14.3",
|
|
58
|
-
"jsr-exports-lint": "^0.4.2",
|
|
55
|
+
"gunshi": "1.0.0-rc.5",
|
|
59
56
|
"publint": "^0.3.20",
|
|
60
57
|
"tsdown": "0.22.14"
|
|
61
58
|
},
|
|
62
59
|
"scripts": {
|
|
63
|
-
"build": "tsdown"
|
|
64
|
-
"lint:jsr": "jsr publish --dry-run --allow-dirty",
|
|
65
|
-
"typecheck:deno": "deno check --import-map=../../importmap.json ./src"
|
|
60
|
+
"build": "tsdown"
|
|
66
61
|
}
|
|
67
62
|
}
|