@gunshi/plugin 0.34.0 → 0.35.0

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.
Files changed (2) hide show
  1. package/lib/index.d.ts +22 -3
  2. package/package.json +2 -2
package/lib/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- //#region ../../node_modules/.pnpm/args-tokens@0.26.1/node_modules/args-tokens/lib/parser-DT7Ztcch.d.ts
1
+ //#region ../../node_modules/.pnpm/args-tokens@0.27.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,13 +55,13 @@ interface ArgToken {
55
55
  * Parser Options.
56
56
  */
57
57
  //#endregion
58
- //#region ../../node_modules/.pnpm/args-tokens@0.26.1/node_modules/args-tokens/lib/resolver.d.ts
58
+ //#region ../../node_modules/.pnpm/args-tokens@0.27.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.
62
62
  *
63
63
  * This schema is similar to the schema of Node.js `util.parseArgs` but with extended features:
64
- * - Additional `required` and `description` properties
64
+ * - Additional `required`, `description`, and `hidden` properties
65
65
  * - Extended `type` support: 'string', 'boolean', 'number', 'enum', 'positional', 'custom'
66
66
  * - Simplified `default` property (single type, not union types)
67
67
  *
@@ -166,6 +166,25 @@ interface ArgSchema {
166
166
  * ```
167
167
  */
168
168
  description?: string;
169
+ /**
170
+ * Hide the argument from generated help or usage output.
171
+ *
172
+ * This is metadata for renderers. It does not affect parsing, validation,
173
+ * required checks, defaults, conflicts, or resolved values.
174
+ *
175
+ * @example
176
+ * Hidden compatibility option:
177
+ * ```ts
178
+ * {
179
+ * legacy: {
180
+ * type: 'string',
181
+ * hidden: true,
182
+ * description: 'Deprecated compatibility option'
183
+ * }
184
+ * }
185
+ * ```
186
+ */
187
+ hidden?: boolean;
169
188
  /**
170
189
  * Marks the argument as required.
171
190
  *
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@gunshi/plugin",
3
3
  "description": "plugin development kit for gunshi",
4
- "version": "0.34.0",
4
+ "version": "0.35.0",
5
5
  "author": {
6
6
  "name": "kazuya kawaguchi",
7
7
  "email": "kawakazu80@gmail.com"
@@ -56,7 +56,7 @@
56
56
  "jsr-exports-lint": "^0.4.2",
57
57
  "publint": "^0.3.20",
58
58
  "tsdown": "0.21.0",
59
- "gunshi": "0.34.0"
59
+ "gunshi": "0.35.0"
60
60
  },
61
61
  "scripts": {
62
62
  "build": "tsdown",