massarg 2.0.0-pre.1 → 2.0.0-pre.11
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 +42 -190
- package/command.d.ts +51 -22
- package/command.d.ts.map +1 -1
- package/command.js +169 -85
- package/command.js.map +1 -1
- package/error.d.ts +13 -11
- package/error.d.ts.map +1 -1
- package/error.js +1 -1
- package/error.js.map +1 -1
- package/example.js.map +1 -1
- package/help.d.ts +361 -63
- package/help.d.ts.map +1 -1
- package/help.js +159 -61
- package/help.js.map +1 -1
- package/index.d.ts +2 -0
- package/index.d.ts.map +1 -1
- package/index.js +2 -0
- package/index.js.map +1 -1
- package/massarg.d.ts +14 -2
- package/massarg.d.ts.map +1 -1
- package/massarg.js +12 -0
- package/massarg.js.map +1 -1
- package/option.d.ts +140 -44
- package/option.d.ts.map +1 -1
- package/option.js +101 -66
- package/option.js.map +1 -1
- package/package.json +12 -12
- package/style.d.ts +1 -0
- package/style.d.ts.map +1 -1
- package/style.js +7 -4
- package/style.js.map +1 -1
- package/utils.d.ts +7 -5
- package/utils.d.ts.map +1 -1
- package/utils.js +20 -9
- package/utils.js.map +1 -1
package/help.d.ts
CHANGED
|
@@ -2,10 +2,11 @@ import z from 'zod';
|
|
|
2
2
|
import { MassargCommand } from './command';
|
|
3
3
|
import { DeepRequired } from './utils';
|
|
4
4
|
export declare const GenerateTableCommandConfig: z.ZodObject<{
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
/** Length of each row in the table */
|
|
6
|
+
lineLength: z.ZodOptional<z.ZodNumber>;
|
|
7
|
+
/** When `false`, each row is separated by a blank line */
|
|
8
8
|
compact: z.ZodOptional<z.ZodBoolean>;
|
|
9
|
+
/** Style of the command/option name */
|
|
9
10
|
nameStyle: z.ZodOptional<z.ZodObject<{
|
|
10
11
|
bold: z.ZodOptional<z.ZodBoolean>;
|
|
11
12
|
underline: z.ZodOptional<z.ZodBoolean>;
|
|
@@ -22,6 +23,7 @@ export declare const GenerateTableCommandConfig: z.ZodObject<{
|
|
|
22
23
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
23
24
|
reset?: boolean | undefined;
|
|
24
25
|
}>>;
|
|
26
|
+
/** Style of the command/option description */
|
|
25
27
|
descriptionStyle: z.ZodOptional<z.ZodObject<{
|
|
26
28
|
bold: z.ZodOptional<z.ZodBoolean>;
|
|
27
29
|
underline: z.ZodOptional<z.ZodBoolean>;
|
|
@@ -38,10 +40,12 @@ export declare const GenerateTableCommandConfig: z.ZodObject<{
|
|
|
38
40
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
39
41
|
reset?: boolean | undefined;
|
|
40
42
|
}>>;
|
|
43
|
+
/** Prefix for the command/option name (default is the command's prefix) */
|
|
44
|
+
namePrefix: z.ZodOptional<z.ZodString>;
|
|
45
|
+
/** Prefix for the command/option aliases (default is the command's prefix) */
|
|
46
|
+
aliasPrefix: z.ZodOptional<z.ZodString>;
|
|
41
47
|
}, "strip", z.ZodTypeAny, {
|
|
42
|
-
|
|
43
|
-
namePrefix?: string | undefined;
|
|
44
|
-
aliasPrefix?: string | undefined;
|
|
48
|
+
lineLength?: number | undefined;
|
|
45
49
|
compact?: boolean | undefined;
|
|
46
50
|
nameStyle?: {
|
|
47
51
|
bold?: boolean | undefined;
|
|
@@ -55,10 +59,10 @@ export declare const GenerateTableCommandConfig: z.ZodObject<{
|
|
|
55
59
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
56
60
|
reset?: boolean | undefined;
|
|
57
61
|
} | undefined;
|
|
58
|
-
}, {
|
|
59
|
-
maxRowLength?: number | undefined;
|
|
60
62
|
namePrefix?: string | undefined;
|
|
61
63
|
aliasPrefix?: string | undefined;
|
|
64
|
+
}, {
|
|
65
|
+
lineLength?: number | undefined;
|
|
62
66
|
compact?: boolean | undefined;
|
|
63
67
|
nameStyle?: {
|
|
64
68
|
bold?: boolean | undefined;
|
|
@@ -72,12 +76,12 @@ export declare const GenerateTableCommandConfig: z.ZodObject<{
|
|
|
72
76
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
73
77
|
reset?: boolean | undefined;
|
|
74
78
|
} | undefined;
|
|
79
|
+
namePrefix?: string | undefined;
|
|
80
|
+
aliasPrefix?: string | undefined;
|
|
75
81
|
}>;
|
|
76
82
|
export type GenerateTableCommandConfig = z.infer<typeof GenerateTableCommandConfig>;
|
|
77
83
|
export declare const GenerateTableOptionConfig: z.ZodObject<{
|
|
78
|
-
|
|
79
|
-
namePrefix: z.ZodOptional<z.ZodString>;
|
|
80
|
-
aliasPrefix: z.ZodOptional<z.ZodString>;
|
|
84
|
+
lineLength: z.ZodOptional<z.ZodNumber>;
|
|
81
85
|
compact: z.ZodOptional<z.ZodBoolean>;
|
|
82
86
|
nameStyle: z.ZodOptional<z.ZodObject<{
|
|
83
87
|
bold: z.ZodOptional<z.ZodBoolean>;
|
|
@@ -111,10 +115,28 @@ export declare const GenerateTableOptionConfig: z.ZodObject<{
|
|
|
111
115
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
112
116
|
reset?: boolean | undefined;
|
|
113
117
|
}>>;
|
|
118
|
+
namePrefix: z.ZodOptional<z.ZodString>;
|
|
119
|
+
aliasPrefix: z.ZodOptional<z.ZodString>;
|
|
120
|
+
displayNegations: z.ZodOptional<z.ZodBoolean>;
|
|
121
|
+
displayDefaultValue: z.ZodOptional<z.ZodBoolean>;
|
|
122
|
+
defaultValueStyle: z.ZodOptional<z.ZodObject<{
|
|
123
|
+
bold: z.ZodOptional<z.ZodBoolean>;
|
|
124
|
+
underline: z.ZodOptional<z.ZodBoolean>;
|
|
125
|
+
color: z.ZodOptional<z.ZodEnum<["red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite", ...("red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite")[]]>>;
|
|
126
|
+
reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
127
|
+
}, "strip", z.ZodTypeAny, {
|
|
128
|
+
bold?: boolean | undefined;
|
|
129
|
+
underline?: boolean | undefined;
|
|
130
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
131
|
+
reset?: boolean | undefined;
|
|
132
|
+
}, {
|
|
133
|
+
bold?: boolean | undefined;
|
|
134
|
+
underline?: boolean | undefined;
|
|
135
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
136
|
+
reset?: boolean | undefined;
|
|
137
|
+
}>>;
|
|
114
138
|
}, "strip", z.ZodTypeAny, {
|
|
115
|
-
|
|
116
|
-
namePrefix?: string | undefined;
|
|
117
|
-
aliasPrefix?: string | undefined;
|
|
139
|
+
lineLength?: number | undefined;
|
|
118
140
|
compact?: boolean | undefined;
|
|
119
141
|
nameStyle?: {
|
|
120
142
|
bold?: boolean | undefined;
|
|
@@ -128,10 +150,18 @@ export declare const GenerateTableOptionConfig: z.ZodObject<{
|
|
|
128
150
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
129
151
|
reset?: boolean | undefined;
|
|
130
152
|
} | undefined;
|
|
131
|
-
}, {
|
|
132
|
-
maxRowLength?: number | undefined;
|
|
133
153
|
namePrefix?: string | undefined;
|
|
134
154
|
aliasPrefix?: string | undefined;
|
|
155
|
+
displayNegations?: boolean | undefined;
|
|
156
|
+
displayDefaultValue?: boolean | undefined;
|
|
157
|
+
defaultValueStyle?: {
|
|
158
|
+
bold?: boolean | undefined;
|
|
159
|
+
underline?: boolean | undefined;
|
|
160
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
161
|
+
reset?: boolean | undefined;
|
|
162
|
+
} | undefined;
|
|
163
|
+
}, {
|
|
164
|
+
lineLength?: number | undefined;
|
|
135
165
|
compact?: boolean | undefined;
|
|
136
166
|
nameStyle?: {
|
|
137
167
|
bold?: boolean | undefined;
|
|
@@ -145,6 +175,16 @@ export declare const GenerateTableOptionConfig: z.ZodObject<{
|
|
|
145
175
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
146
176
|
reset?: boolean | undefined;
|
|
147
177
|
} | undefined;
|
|
178
|
+
namePrefix?: string | undefined;
|
|
179
|
+
aliasPrefix?: string | undefined;
|
|
180
|
+
displayNegations?: boolean | undefined;
|
|
181
|
+
displayDefaultValue?: boolean | undefined;
|
|
182
|
+
defaultValueStyle?: {
|
|
183
|
+
bold?: boolean | undefined;
|
|
184
|
+
underline?: boolean | undefined;
|
|
185
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
186
|
+
reset?: boolean | undefined;
|
|
187
|
+
} | undefined;
|
|
148
188
|
}>;
|
|
149
189
|
export type GenerateTableOptionConfig = z.infer<typeof GenerateTableOptionConfig>;
|
|
150
190
|
export declare const HelpConfig: z.ZodObject<{
|
|
@@ -160,12 +200,15 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
160
200
|
* Set this to `true` to automatically add a `--help` option to this command's options.
|
|
161
201
|
*/
|
|
162
202
|
bindOption: z.ZodOptional<z.ZodBoolean>;
|
|
203
|
+
/** Whether to align all tables to the column widths, or have each table be independent. Default is `true` */
|
|
204
|
+
useGlobalTableColumns: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
163
205
|
/** Options for generating the table of commands */
|
|
164
206
|
commandOptions: z.ZodOptional<z.ZodObject<Omit<{
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
207
|
+
/** Length of each row in the table */
|
|
208
|
+
lineLength: z.ZodOptional<z.ZodNumber>;
|
|
209
|
+
/** When `false`, each row is separated by a blank line */
|
|
168
210
|
compact: z.ZodOptional<z.ZodBoolean>;
|
|
211
|
+
/** Style of the command/option name */
|
|
169
212
|
nameStyle: z.ZodOptional<z.ZodObject<{
|
|
170
213
|
bold: z.ZodOptional<z.ZodBoolean>;
|
|
171
214
|
underline: z.ZodOptional<z.ZodBoolean>;
|
|
@@ -182,6 +225,7 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
182
225
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
183
226
|
reset?: boolean | undefined;
|
|
184
227
|
}>>;
|
|
228
|
+
/** Style of the command/option description */
|
|
185
229
|
descriptionStyle: z.ZodOptional<z.ZodObject<{
|
|
186
230
|
bold: z.ZodOptional<z.ZodBoolean>;
|
|
187
231
|
underline: z.ZodOptional<z.ZodBoolean>;
|
|
@@ -198,9 +242,11 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
198
242
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
199
243
|
reset?: boolean | undefined;
|
|
200
244
|
}>>;
|
|
201
|
-
|
|
202
|
-
namePrefix
|
|
203
|
-
|
|
245
|
+
/** Prefix for the command/option name (default is the command's prefix) */
|
|
246
|
+
namePrefix: z.ZodOptional<z.ZodString>;
|
|
247
|
+
/** Prefix for the command/option aliases (default is the command's prefix) */
|
|
248
|
+
aliasPrefix: z.ZodOptional<z.ZodString>;
|
|
249
|
+
}, "lineLength" | "defaultValueStyle" | "dislayDefaultValue">, "strip", z.ZodTypeAny, {
|
|
204
250
|
compact?: boolean | undefined;
|
|
205
251
|
nameStyle?: {
|
|
206
252
|
bold?: boolean | undefined;
|
|
@@ -214,9 +260,9 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
214
260
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
215
261
|
reset?: boolean | undefined;
|
|
216
262
|
} | undefined;
|
|
217
|
-
}, {
|
|
218
263
|
namePrefix?: string | undefined;
|
|
219
264
|
aliasPrefix?: string | undefined;
|
|
265
|
+
}, {
|
|
220
266
|
compact?: boolean | undefined;
|
|
221
267
|
nameStyle?: {
|
|
222
268
|
bold?: boolean | undefined;
|
|
@@ -230,12 +276,12 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
230
276
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
231
277
|
reset?: boolean | undefined;
|
|
232
278
|
} | undefined;
|
|
279
|
+
namePrefix?: string | undefined;
|
|
280
|
+
aliasPrefix?: string | undefined;
|
|
233
281
|
}>>;
|
|
234
282
|
/** Options for generating the table of options */
|
|
235
283
|
optionOptions: z.ZodOptional<z.ZodObject<Omit<{
|
|
236
|
-
|
|
237
|
-
namePrefix: z.ZodOptional<z.ZodString>;
|
|
238
|
-
aliasPrefix: z.ZodOptional<z.ZodString>;
|
|
284
|
+
lineLength: z.ZodOptional<z.ZodNumber>;
|
|
239
285
|
compact: z.ZodOptional<z.ZodBoolean>;
|
|
240
286
|
nameStyle: z.ZodOptional<z.ZodObject<{
|
|
241
287
|
bold: z.ZodOptional<z.ZodBoolean>;
|
|
@@ -269,9 +315,27 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
269
315
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
270
316
|
reset?: boolean | undefined;
|
|
271
317
|
}>>;
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
318
|
+
namePrefix: z.ZodOptional<z.ZodString>;
|
|
319
|
+
aliasPrefix: z.ZodOptional<z.ZodString>;
|
|
320
|
+
displayNegations: z.ZodOptional<z.ZodBoolean>;
|
|
321
|
+
displayDefaultValue: z.ZodOptional<z.ZodBoolean>;
|
|
322
|
+
defaultValueStyle: z.ZodOptional<z.ZodObject<{
|
|
323
|
+
bold: z.ZodOptional<z.ZodBoolean>;
|
|
324
|
+
underline: z.ZodOptional<z.ZodBoolean>;
|
|
325
|
+
color: z.ZodOptional<z.ZodEnum<["red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite", ...("red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite")[]]>>;
|
|
326
|
+
reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
327
|
+
}, "strip", z.ZodTypeAny, {
|
|
328
|
+
bold?: boolean | undefined;
|
|
329
|
+
underline?: boolean | undefined;
|
|
330
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
331
|
+
reset?: boolean | undefined;
|
|
332
|
+
}, {
|
|
333
|
+
bold?: boolean | undefined;
|
|
334
|
+
underline?: boolean | undefined;
|
|
335
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
336
|
+
reset?: boolean | undefined;
|
|
337
|
+
}>>;
|
|
338
|
+
}, "lineLength">, "strip", z.ZodTypeAny, {
|
|
275
339
|
compact?: boolean | undefined;
|
|
276
340
|
nameStyle?: {
|
|
277
341
|
bold?: boolean | undefined;
|
|
@@ -285,9 +349,17 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
285
349
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
286
350
|
reset?: boolean | undefined;
|
|
287
351
|
} | undefined;
|
|
288
|
-
}, {
|
|
289
352
|
namePrefix?: string | undefined;
|
|
290
353
|
aliasPrefix?: string | undefined;
|
|
354
|
+
displayNegations?: boolean | undefined;
|
|
355
|
+
displayDefaultValue?: boolean | undefined;
|
|
356
|
+
defaultValueStyle?: {
|
|
357
|
+
bold?: boolean | undefined;
|
|
358
|
+
underline?: boolean | undefined;
|
|
359
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
360
|
+
reset?: boolean | undefined;
|
|
361
|
+
} | undefined;
|
|
362
|
+
}, {
|
|
291
363
|
compact?: boolean | undefined;
|
|
292
364
|
nameStyle?: {
|
|
293
365
|
bold?: boolean | undefined;
|
|
@@ -301,6 +373,16 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
301
373
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
302
374
|
reset?: boolean | undefined;
|
|
303
375
|
} | undefined;
|
|
376
|
+
namePrefix?: string | undefined;
|
|
377
|
+
aliasPrefix?: string | undefined;
|
|
378
|
+
displayNegations?: boolean | undefined;
|
|
379
|
+
displayDefaultValue?: boolean | undefined;
|
|
380
|
+
defaultValueStyle?: {
|
|
381
|
+
bold?: boolean | undefined;
|
|
382
|
+
underline?: boolean | undefined;
|
|
383
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
384
|
+
reset?: boolean | undefined;
|
|
385
|
+
} | undefined;
|
|
304
386
|
}>>;
|
|
305
387
|
/** Style of the help title */
|
|
306
388
|
titleStyle: z.ZodOptional<z.ZodObject<{
|
|
@@ -355,20 +437,127 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
355
437
|
}>>;
|
|
356
438
|
/** Style of the help usage */
|
|
357
439
|
usageStyle: z.ZodOptional<z.ZodObject<{
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
440
|
+
/** Style of the help usage title - appears before the usage text (custom or auto) */
|
|
441
|
+
prefix: z.ZodOptional<z.ZodObject<{
|
|
442
|
+
bold: z.ZodOptional<z.ZodBoolean>;
|
|
443
|
+
underline: z.ZodOptional<z.ZodBoolean>;
|
|
444
|
+
color: z.ZodOptional<z.ZodEnum<["red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite", ...("red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite")[]]>>;
|
|
445
|
+
reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
446
|
+
}, "strip", z.ZodTypeAny, {
|
|
447
|
+
bold?: boolean | undefined;
|
|
448
|
+
underline?: boolean | undefined;
|
|
449
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
450
|
+
reset?: boolean | undefined;
|
|
451
|
+
}, {
|
|
452
|
+
bold?: boolean | undefined;
|
|
453
|
+
underline?: boolean | undefined;
|
|
454
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
455
|
+
reset?: boolean | undefined;
|
|
456
|
+
}>>;
|
|
457
|
+
/**
|
|
458
|
+
* For custom usage text, this is the primary style used (right after the `prefix` style).
|
|
459
|
+
* For automated usage text, this style is used for the command/binary name
|
|
460
|
+
*/
|
|
461
|
+
main: z.ZodOptional<z.ZodObject<{
|
|
462
|
+
bold: z.ZodOptional<z.ZodBoolean>;
|
|
463
|
+
underline: z.ZodOptional<z.ZodBoolean>;
|
|
464
|
+
color: z.ZodOptional<z.ZodEnum<["red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite", ...("red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite")[]]>>;
|
|
465
|
+
reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
466
|
+
}, "strip", z.ZodTypeAny, {
|
|
467
|
+
bold?: boolean | undefined;
|
|
468
|
+
underline?: boolean | undefined;
|
|
469
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
470
|
+
reset?: boolean | undefined;
|
|
471
|
+
}, {
|
|
472
|
+
bold?: boolean | undefined;
|
|
473
|
+
underline?: boolean | undefined;
|
|
474
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
475
|
+
reset?: boolean | undefined;
|
|
476
|
+
}>>;
|
|
477
|
+
/** Style of the help usage commands (if any) */
|
|
478
|
+
command: z.ZodOptional<z.ZodObject<{
|
|
479
|
+
bold: z.ZodOptional<z.ZodBoolean>;
|
|
480
|
+
underline: z.ZodOptional<z.ZodBoolean>;
|
|
481
|
+
color: z.ZodOptional<z.ZodEnum<["red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite", ...("red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite")[]]>>;
|
|
482
|
+
reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
483
|
+
}, "strip", z.ZodTypeAny, {
|
|
484
|
+
bold?: boolean | undefined;
|
|
485
|
+
underline?: boolean | undefined;
|
|
486
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
487
|
+
reset?: boolean | undefined;
|
|
488
|
+
}, {
|
|
489
|
+
bold?: boolean | undefined;
|
|
490
|
+
underline?: boolean | undefined;
|
|
491
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
492
|
+
reset?: boolean | undefined;
|
|
493
|
+
}>>;
|
|
494
|
+
/** Style of the help usage options (if any) */
|
|
495
|
+
options: z.ZodOptional<z.ZodObject<{
|
|
496
|
+
bold: z.ZodOptional<z.ZodBoolean>;
|
|
497
|
+
underline: z.ZodOptional<z.ZodBoolean>;
|
|
498
|
+
color: z.ZodOptional<z.ZodEnum<["red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite", ...("red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite")[]]>>;
|
|
499
|
+
reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
500
|
+
}, "strip", z.ZodTypeAny, {
|
|
501
|
+
bold?: boolean | undefined;
|
|
502
|
+
underline?: boolean | undefined;
|
|
503
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
504
|
+
reset?: boolean | undefined;
|
|
505
|
+
}, {
|
|
506
|
+
bold?: boolean | undefined;
|
|
507
|
+
underline?: boolean | undefined;
|
|
508
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
509
|
+
reset?: boolean | undefined;
|
|
510
|
+
}>>;
|
|
362
511
|
}, "strip", z.ZodTypeAny, {
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
512
|
+
prefix?: {
|
|
513
|
+
bold?: boolean | undefined;
|
|
514
|
+
underline?: boolean | undefined;
|
|
515
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
516
|
+
reset?: boolean | undefined;
|
|
517
|
+
} | undefined;
|
|
518
|
+
main?: {
|
|
519
|
+
bold?: boolean | undefined;
|
|
520
|
+
underline?: boolean | undefined;
|
|
521
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
522
|
+
reset?: boolean | undefined;
|
|
523
|
+
} | undefined;
|
|
524
|
+
command?: {
|
|
525
|
+
bold?: boolean | undefined;
|
|
526
|
+
underline?: boolean | undefined;
|
|
527
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
528
|
+
reset?: boolean | undefined;
|
|
529
|
+
} | undefined;
|
|
530
|
+
options?: {
|
|
531
|
+
bold?: boolean | undefined;
|
|
532
|
+
underline?: boolean | undefined;
|
|
533
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
534
|
+
reset?: boolean | undefined;
|
|
535
|
+
} | undefined;
|
|
367
536
|
}, {
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
537
|
+
prefix?: {
|
|
538
|
+
bold?: boolean | undefined;
|
|
539
|
+
underline?: boolean | undefined;
|
|
540
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
541
|
+
reset?: boolean | undefined;
|
|
542
|
+
} | undefined;
|
|
543
|
+
main?: {
|
|
544
|
+
bold?: boolean | undefined;
|
|
545
|
+
underline?: boolean | undefined;
|
|
546
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
547
|
+
reset?: boolean | undefined;
|
|
548
|
+
} | undefined;
|
|
549
|
+
command?: {
|
|
550
|
+
bold?: boolean | undefined;
|
|
551
|
+
underline?: boolean | undefined;
|
|
552
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
553
|
+
reset?: boolean | undefined;
|
|
554
|
+
} | undefined;
|
|
555
|
+
options?: {
|
|
556
|
+
bold?: boolean | undefined;
|
|
557
|
+
underline?: boolean | undefined;
|
|
558
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
559
|
+
reset?: boolean | undefined;
|
|
560
|
+
} | undefined;
|
|
372
561
|
}>>;
|
|
373
562
|
/** Style of the help header */
|
|
374
563
|
headerStyle: z.ZodOptional<z.ZodObject<{
|
|
@@ -405,7 +594,7 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
405
594
|
reset?: boolean | undefined;
|
|
406
595
|
}>>;
|
|
407
596
|
/** Maximum length of a row in the help output */
|
|
408
|
-
|
|
597
|
+
lineLength: z.ZodOptional<z.ZodNumber>;
|
|
409
598
|
/** Options for examples section */
|
|
410
599
|
exampleOptions: z.ZodOptional<z.ZodObject<{
|
|
411
600
|
/** Style of the example description */
|
|
@@ -459,10 +648,29 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
459
648
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
460
649
|
reset?: boolean | undefined;
|
|
461
650
|
}>>;
|
|
462
|
-
/** Prefix for the example input */
|
|
651
|
+
/** Prefix for the example input (default: `$`) */
|
|
463
652
|
inputPrefix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
|
|
464
|
-
/** Prefix for the example output */
|
|
653
|
+
/** Prefix for the example output (default: `>`) */
|
|
465
654
|
outputPrefix: z.ZodOptional<z.ZodDefault<z.ZodString>>;
|
|
655
|
+
/** Style of the example input/output prefixes */
|
|
656
|
+
prefixStyle: z.ZodOptional<z.ZodObject<{
|
|
657
|
+
bold: z.ZodOptional<z.ZodBoolean>;
|
|
658
|
+
underline: z.ZodOptional<z.ZodBoolean>;
|
|
659
|
+
color: z.ZodOptional<z.ZodEnum<["red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite", ...("red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite")[]]>>;
|
|
660
|
+
reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
661
|
+
}, "strip", z.ZodTypeAny, {
|
|
662
|
+
bold?: boolean | undefined;
|
|
663
|
+
underline?: boolean | undefined;
|
|
664
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
665
|
+
reset?: boolean | undefined;
|
|
666
|
+
}, {
|
|
667
|
+
bold?: boolean | undefined;
|
|
668
|
+
underline?: boolean | undefined;
|
|
669
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
670
|
+
reset?: boolean | undefined;
|
|
671
|
+
}>>;
|
|
672
|
+
/** Whether to compact the examples section */
|
|
673
|
+
compact: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
466
674
|
}, "strip", z.ZodTypeAny, {
|
|
467
675
|
descriptionStyle?: {
|
|
468
676
|
bold?: boolean | undefined;
|
|
@@ -484,6 +692,13 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
484
692
|
} | undefined;
|
|
485
693
|
inputPrefix?: string | undefined;
|
|
486
694
|
outputPrefix?: string | undefined;
|
|
695
|
+
prefixStyle?: {
|
|
696
|
+
bold?: boolean | undefined;
|
|
697
|
+
underline?: boolean | undefined;
|
|
698
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
699
|
+
reset?: boolean | undefined;
|
|
700
|
+
} | undefined;
|
|
701
|
+
compact?: boolean | undefined;
|
|
487
702
|
}, {
|
|
488
703
|
descriptionStyle?: {
|
|
489
704
|
bold?: boolean | undefined;
|
|
@@ -505,6 +720,13 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
505
720
|
} | undefined;
|
|
506
721
|
inputPrefix?: string | undefined;
|
|
507
722
|
outputPrefix?: string | undefined;
|
|
723
|
+
prefixStyle?: {
|
|
724
|
+
bold?: boolean | undefined;
|
|
725
|
+
underline?: boolean | undefined;
|
|
726
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
727
|
+
reset?: boolean | undefined;
|
|
728
|
+
} | undefined;
|
|
729
|
+
compact?: boolean | undefined;
|
|
508
730
|
}>>;
|
|
509
731
|
/** Text to display at the very top, describing CLI usage */
|
|
510
732
|
usageText: z.ZodOptional<z.ZodString>;
|
|
@@ -515,9 +737,8 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
515
737
|
}, "strip", z.ZodTypeAny, {
|
|
516
738
|
bindCommand?: boolean | undefined;
|
|
517
739
|
bindOption?: boolean | undefined;
|
|
740
|
+
useGlobalTableColumns?: boolean | undefined;
|
|
518
741
|
commandOptions?: {
|
|
519
|
-
namePrefix?: string | undefined;
|
|
520
|
-
aliasPrefix?: string | undefined;
|
|
521
742
|
compact?: boolean | undefined;
|
|
522
743
|
nameStyle?: {
|
|
523
744
|
bold?: boolean | undefined;
|
|
@@ -531,10 +752,10 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
531
752
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
532
753
|
reset?: boolean | undefined;
|
|
533
754
|
} | undefined;
|
|
534
|
-
} | undefined;
|
|
535
|
-
optionOptions?: {
|
|
536
755
|
namePrefix?: string | undefined;
|
|
537
756
|
aliasPrefix?: string | undefined;
|
|
757
|
+
} | undefined;
|
|
758
|
+
optionOptions?: {
|
|
538
759
|
compact?: boolean | undefined;
|
|
539
760
|
nameStyle?: {
|
|
540
761
|
bold?: boolean | undefined;
|
|
@@ -548,6 +769,16 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
548
769
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
549
770
|
reset?: boolean | undefined;
|
|
550
771
|
} | undefined;
|
|
772
|
+
namePrefix?: string | undefined;
|
|
773
|
+
aliasPrefix?: string | undefined;
|
|
774
|
+
displayNegations?: boolean | undefined;
|
|
775
|
+
displayDefaultValue?: boolean | undefined;
|
|
776
|
+
defaultValueStyle?: {
|
|
777
|
+
bold?: boolean | undefined;
|
|
778
|
+
underline?: boolean | undefined;
|
|
779
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
780
|
+
reset?: boolean | undefined;
|
|
781
|
+
} | undefined;
|
|
551
782
|
} | undefined;
|
|
552
783
|
titleStyle?: {
|
|
553
784
|
bold?: boolean | undefined;
|
|
@@ -568,10 +799,30 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
568
799
|
reset?: boolean | undefined;
|
|
569
800
|
} | undefined;
|
|
570
801
|
usageStyle?: {
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
802
|
+
prefix?: {
|
|
803
|
+
bold?: boolean | undefined;
|
|
804
|
+
underline?: boolean | undefined;
|
|
805
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
806
|
+
reset?: boolean | undefined;
|
|
807
|
+
} | undefined;
|
|
808
|
+
main?: {
|
|
809
|
+
bold?: boolean | undefined;
|
|
810
|
+
underline?: boolean | undefined;
|
|
811
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
812
|
+
reset?: boolean | undefined;
|
|
813
|
+
} | undefined;
|
|
814
|
+
command?: {
|
|
815
|
+
bold?: boolean | undefined;
|
|
816
|
+
underline?: boolean | undefined;
|
|
817
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
818
|
+
reset?: boolean | undefined;
|
|
819
|
+
} | undefined;
|
|
820
|
+
options?: {
|
|
821
|
+
bold?: boolean | undefined;
|
|
822
|
+
underline?: boolean | undefined;
|
|
823
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
824
|
+
reset?: boolean | undefined;
|
|
825
|
+
} | undefined;
|
|
575
826
|
} | undefined;
|
|
576
827
|
headerStyle?: {
|
|
577
828
|
bold?: boolean | undefined;
|
|
@@ -585,7 +836,7 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
585
836
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
586
837
|
reset?: boolean | undefined;
|
|
587
838
|
} | undefined;
|
|
588
|
-
|
|
839
|
+
lineLength?: number | undefined;
|
|
589
840
|
exampleOptions?: {
|
|
590
841
|
descriptionStyle?: {
|
|
591
842
|
bold?: boolean | undefined;
|
|
@@ -607,6 +858,13 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
607
858
|
} | undefined;
|
|
608
859
|
inputPrefix?: string | undefined;
|
|
609
860
|
outputPrefix?: string | undefined;
|
|
861
|
+
prefixStyle?: {
|
|
862
|
+
bold?: boolean | undefined;
|
|
863
|
+
underline?: boolean | undefined;
|
|
864
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
865
|
+
reset?: boolean | undefined;
|
|
866
|
+
} | undefined;
|
|
867
|
+
compact?: boolean | undefined;
|
|
610
868
|
} | undefined;
|
|
611
869
|
usageText?: string | undefined;
|
|
612
870
|
headerText?: string | undefined;
|
|
@@ -614,9 +872,8 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
614
872
|
}, {
|
|
615
873
|
bindCommand?: boolean | undefined;
|
|
616
874
|
bindOption?: boolean | undefined;
|
|
875
|
+
useGlobalTableColumns?: boolean | undefined;
|
|
617
876
|
commandOptions?: {
|
|
618
|
-
namePrefix?: string | undefined;
|
|
619
|
-
aliasPrefix?: string | undefined;
|
|
620
877
|
compact?: boolean | undefined;
|
|
621
878
|
nameStyle?: {
|
|
622
879
|
bold?: boolean | undefined;
|
|
@@ -630,10 +887,10 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
630
887
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
631
888
|
reset?: boolean | undefined;
|
|
632
889
|
} | undefined;
|
|
633
|
-
} | undefined;
|
|
634
|
-
optionOptions?: {
|
|
635
890
|
namePrefix?: string | undefined;
|
|
636
891
|
aliasPrefix?: string | undefined;
|
|
892
|
+
} | undefined;
|
|
893
|
+
optionOptions?: {
|
|
637
894
|
compact?: boolean | undefined;
|
|
638
895
|
nameStyle?: {
|
|
639
896
|
bold?: boolean | undefined;
|
|
@@ -647,6 +904,16 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
647
904
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
648
905
|
reset?: boolean | undefined;
|
|
649
906
|
} | undefined;
|
|
907
|
+
namePrefix?: string | undefined;
|
|
908
|
+
aliasPrefix?: string | undefined;
|
|
909
|
+
displayNegations?: boolean | undefined;
|
|
910
|
+
displayDefaultValue?: boolean | undefined;
|
|
911
|
+
defaultValueStyle?: {
|
|
912
|
+
bold?: boolean | undefined;
|
|
913
|
+
underline?: boolean | undefined;
|
|
914
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
915
|
+
reset?: boolean | undefined;
|
|
916
|
+
} | undefined;
|
|
650
917
|
} | undefined;
|
|
651
918
|
titleStyle?: {
|
|
652
919
|
bold?: boolean | undefined;
|
|
@@ -667,10 +934,30 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
667
934
|
reset?: boolean | undefined;
|
|
668
935
|
} | undefined;
|
|
669
936
|
usageStyle?: {
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
937
|
+
prefix?: {
|
|
938
|
+
bold?: boolean | undefined;
|
|
939
|
+
underline?: boolean | undefined;
|
|
940
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
941
|
+
reset?: boolean | undefined;
|
|
942
|
+
} | undefined;
|
|
943
|
+
main?: {
|
|
944
|
+
bold?: boolean | undefined;
|
|
945
|
+
underline?: boolean | undefined;
|
|
946
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
947
|
+
reset?: boolean | undefined;
|
|
948
|
+
} | undefined;
|
|
949
|
+
command?: {
|
|
950
|
+
bold?: boolean | undefined;
|
|
951
|
+
underline?: boolean | undefined;
|
|
952
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
953
|
+
reset?: boolean | undefined;
|
|
954
|
+
} | undefined;
|
|
955
|
+
options?: {
|
|
956
|
+
bold?: boolean | undefined;
|
|
957
|
+
underline?: boolean | undefined;
|
|
958
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
959
|
+
reset?: boolean | undefined;
|
|
960
|
+
} | undefined;
|
|
674
961
|
} | undefined;
|
|
675
962
|
headerStyle?: {
|
|
676
963
|
bold?: boolean | undefined;
|
|
@@ -684,7 +971,7 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
684
971
|
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
685
972
|
reset?: boolean | undefined;
|
|
686
973
|
} | undefined;
|
|
687
|
-
|
|
974
|
+
lineLength?: number | undefined;
|
|
688
975
|
exampleOptions?: {
|
|
689
976
|
descriptionStyle?: {
|
|
690
977
|
bold?: boolean | undefined;
|
|
@@ -706,6 +993,13 @@ export declare const HelpConfig: z.ZodObject<{
|
|
|
706
993
|
} | undefined;
|
|
707
994
|
inputPrefix?: string | undefined;
|
|
708
995
|
outputPrefix?: string | undefined;
|
|
996
|
+
prefixStyle?: {
|
|
997
|
+
bold?: boolean | undefined;
|
|
998
|
+
underline?: boolean | undefined;
|
|
999
|
+
color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
|
|
1000
|
+
reset?: boolean | undefined;
|
|
1001
|
+
} | undefined;
|
|
1002
|
+
compact?: boolean | undefined;
|
|
709
1003
|
} | undefined;
|
|
710
1004
|
usageText?: string | undefined;
|
|
711
1005
|
headerText?: string | undefined;
|
|
@@ -715,9 +1009,13 @@ export type HelpConfig = z.infer<typeof HelpConfig>;
|
|
|
715
1009
|
export declare const defaultHelpConfig: DeepRequired<HelpConfig>;
|
|
716
1010
|
export type HelpItem = {
|
|
717
1011
|
name: string;
|
|
1012
|
+
negationName?: string;
|
|
718
1013
|
aliases: string[];
|
|
1014
|
+
negationAliases?: string[];
|
|
719
1015
|
description: string;
|
|
720
1016
|
hidden?: boolean;
|
|
1017
|
+
negatable?: boolean;
|
|
1018
|
+
defaultValue?: any;
|
|
721
1019
|
};
|
|
722
1020
|
export declare class HelpGenerator {
|
|
723
1021
|
entry: MassargCommand<any>;
|