massarg 2.0.0-pre.3 → 2.0.0-pre.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/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
- maxRowLength: z.ZodOptional<z.ZodNumber>;
6
- namePrefix: z.ZodOptional<z.ZodString>;
7
- aliasPrefix: z.ZodOptional<z.ZodString>;
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
- maxRowLength?: number | undefined;
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,13 @@ 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
- maxRowLength: z.ZodOptional<z.ZodNumber>;
79
- namePrefix: z.ZodOptional<z.ZodString>;
80
84
  aliasPrefix: z.ZodOptional<z.ZodString>;
85
+ lineLength: z.ZodOptional<z.ZodNumber>;
81
86
  compact: z.ZodOptional<z.ZodBoolean>;
82
87
  nameStyle: z.ZodOptional<z.ZodObject<{
83
88
  bold: z.ZodOptional<z.ZodBoolean>;
@@ -111,10 +116,13 @@ export declare const GenerateTableOptionConfig: z.ZodObject<{
111
116
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
112
117
  reset?: boolean | undefined;
113
118
  }>>;
119
+ namePrefix: z.ZodOptional<z.ZodString>;
120
+ negatePrefix: z.ZodOptional<z.ZodString>;
121
+ negateAliasPrefix: z.ZodOptional<z.ZodString>;
122
+ displayNegations: z.ZodOptional<z.ZodBoolean>;
114
123
  }, "strip", z.ZodTypeAny, {
115
- maxRowLength?: number | undefined;
116
- namePrefix?: string | undefined;
117
124
  aliasPrefix?: string | undefined;
125
+ lineLength?: number | undefined;
118
126
  compact?: boolean | undefined;
119
127
  nameStyle?: {
120
128
  bold?: boolean | undefined;
@@ -128,10 +136,13 @@ export declare const GenerateTableOptionConfig: z.ZodObject<{
128
136
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
129
137
  reset?: boolean | undefined;
130
138
  } | undefined;
131
- }, {
132
- maxRowLength?: number | undefined;
133
139
  namePrefix?: string | undefined;
140
+ negatePrefix?: string | undefined;
141
+ negateAliasPrefix?: string | undefined;
142
+ displayNegations?: boolean | undefined;
143
+ }, {
134
144
  aliasPrefix?: string | undefined;
145
+ lineLength?: number | undefined;
135
146
  compact?: boolean | undefined;
136
147
  nameStyle?: {
137
148
  bold?: boolean | undefined;
@@ -145,6 +156,10 @@ export declare const GenerateTableOptionConfig: z.ZodObject<{
145
156
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
146
157
  reset?: boolean | undefined;
147
158
  } | undefined;
159
+ namePrefix?: string | undefined;
160
+ negatePrefix?: string | undefined;
161
+ negateAliasPrefix?: string | undefined;
162
+ displayNegations?: boolean | undefined;
148
163
  }>;
149
164
  export type GenerateTableOptionConfig = z.infer<typeof GenerateTableOptionConfig>;
150
165
  export declare const HelpConfig: z.ZodObject<{
@@ -160,12 +175,15 @@ export declare const HelpConfig: z.ZodObject<{
160
175
  * Set this to `true` to automatically add a `--help` option to this command's options.
161
176
  */
162
177
  bindOption: z.ZodOptional<z.ZodBoolean>;
178
+ /** Whether to align all tables to the column widths, or have each table be independent. Default is `true` */
179
+ useGlobalTableColumns: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
163
180
  /** Options for generating the table of commands */
164
181
  commandOptions: z.ZodOptional<z.ZodObject<Omit<{
165
- maxRowLength: z.ZodOptional<z.ZodNumber>;
166
- namePrefix: z.ZodOptional<z.ZodString>;
167
- aliasPrefix: z.ZodOptional<z.ZodString>;
182
+ /** Length of each row in the table */
183
+ lineLength: z.ZodOptional<z.ZodNumber>;
184
+ /** When `false`, each row is separated by a blank line */
168
185
  compact: z.ZodOptional<z.ZodBoolean>;
186
+ /** Style of the command/option name */
169
187
  nameStyle: z.ZodOptional<z.ZodObject<{
170
188
  bold: z.ZodOptional<z.ZodBoolean>;
171
189
  underline: z.ZodOptional<z.ZodBoolean>;
@@ -182,6 +200,7 @@ export declare const HelpConfig: z.ZodObject<{
182
200
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
183
201
  reset?: boolean | undefined;
184
202
  }>>;
203
+ /** Style of the command/option description */
185
204
  descriptionStyle: z.ZodOptional<z.ZodObject<{
186
205
  bold: z.ZodOptional<z.ZodBoolean>;
187
206
  underline: z.ZodOptional<z.ZodBoolean>;
@@ -198,8 +217,11 @@ export declare const HelpConfig: z.ZodObject<{
198
217
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
199
218
  reset?: boolean | undefined;
200
219
  }>>;
201
- }, "maxRowLength">, "strip", z.ZodTypeAny, {
202
- namePrefix?: string | undefined;
220
+ /** Prefix for the command/option name (default is the command's prefix) */
221
+ namePrefix: z.ZodOptional<z.ZodString>;
222
+ /** Prefix for the command/option aliases (default is the command's prefix) */
223
+ aliasPrefix: z.ZodOptional<z.ZodString>;
224
+ }, "lineLength">, "strip", z.ZodTypeAny, {
203
225
  aliasPrefix?: string | undefined;
204
226
  compact?: boolean | undefined;
205
227
  nameStyle?: {
@@ -214,8 +236,8 @@ export declare const HelpConfig: z.ZodObject<{
214
236
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
215
237
  reset?: boolean | undefined;
216
238
  } | undefined;
217
- }, {
218
239
  namePrefix?: string | undefined;
240
+ }, {
219
241
  aliasPrefix?: string | undefined;
220
242
  compact?: boolean | undefined;
221
243
  nameStyle?: {
@@ -230,12 +252,12 @@ export declare const HelpConfig: z.ZodObject<{
230
252
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
231
253
  reset?: boolean | undefined;
232
254
  } | undefined;
255
+ namePrefix?: string | undefined;
233
256
  }>>;
234
257
  /** Options for generating the table of options */
235
258
  optionOptions: z.ZodOptional<z.ZodObject<Omit<{
236
- maxRowLength: z.ZodOptional<z.ZodNumber>;
237
- namePrefix: z.ZodOptional<z.ZodString>;
238
259
  aliasPrefix: z.ZodOptional<z.ZodString>;
260
+ lineLength: z.ZodOptional<z.ZodNumber>;
239
261
  compact: z.ZodOptional<z.ZodBoolean>;
240
262
  nameStyle: z.ZodOptional<z.ZodObject<{
241
263
  bold: z.ZodOptional<z.ZodBoolean>;
@@ -269,9 +291,13 @@ export declare const HelpConfig: z.ZodObject<{
269
291
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
270
292
  reset?: boolean | undefined;
271
293
  }>>;
272
- }, "maxRowLength">, "strip", z.ZodTypeAny, {
273
- namePrefix?: string | undefined;
294
+ namePrefix: z.ZodOptional<z.ZodString>;
295
+ negatePrefix: z.ZodOptional<z.ZodString>;
296
+ negateAliasPrefix: z.ZodOptional<z.ZodString>;
297
+ displayNegations: z.ZodOptional<z.ZodBoolean>;
298
+ }, "lineLength">, "strip", z.ZodTypeAny, {
274
299
  aliasPrefix?: string | undefined;
300
+ negateAliasPrefix?: string | undefined;
275
301
  compact?: boolean | undefined;
276
302
  nameStyle?: {
277
303
  bold?: boolean | undefined;
@@ -285,9 +311,12 @@ export declare const HelpConfig: z.ZodObject<{
285
311
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
286
312
  reset?: boolean | undefined;
287
313
  } | undefined;
288
- }, {
289
314
  namePrefix?: string | undefined;
315
+ negatePrefix?: string | undefined;
316
+ displayNegations?: boolean | undefined;
317
+ }, {
290
318
  aliasPrefix?: string | undefined;
319
+ negateAliasPrefix?: string | undefined;
291
320
  compact?: boolean | undefined;
292
321
  nameStyle?: {
293
322
  bold?: boolean | undefined;
@@ -301,6 +330,9 @@ export declare const HelpConfig: z.ZodObject<{
301
330
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
302
331
  reset?: boolean | undefined;
303
332
  } | undefined;
333
+ namePrefix?: string | undefined;
334
+ negatePrefix?: string | undefined;
335
+ displayNegations?: boolean | undefined;
304
336
  }>>;
305
337
  /** Style of the help title */
306
338
  titleStyle: z.ZodOptional<z.ZodObject<{
@@ -355,20 +387,127 @@ export declare const HelpConfig: z.ZodObject<{
355
387
  }>>;
356
388
  /** Style of the help usage */
357
389
  usageStyle: z.ZodOptional<z.ZodObject<{
358
- bold: z.ZodOptional<z.ZodBoolean>;
359
- underline: z.ZodOptional<z.ZodBoolean>;
360
- 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")[]]>>;
361
- reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
390
+ /** Style of the help usage title - appears before the usage text (custom or auto) */
391
+ prefix: z.ZodOptional<z.ZodObject<{
392
+ bold: z.ZodOptional<z.ZodBoolean>;
393
+ underline: z.ZodOptional<z.ZodBoolean>;
394
+ 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")[]]>>;
395
+ reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
396
+ }, "strip", z.ZodTypeAny, {
397
+ bold?: boolean | undefined;
398
+ underline?: boolean | undefined;
399
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
400
+ reset?: boolean | undefined;
401
+ }, {
402
+ bold?: boolean | undefined;
403
+ underline?: boolean | undefined;
404
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
405
+ reset?: boolean | undefined;
406
+ }>>;
407
+ /**
408
+ * For custom usage text, this is the primary style used (right after the `prefix` style).
409
+ * For automated usage text, this style is used for the command/binary name
410
+ */
411
+ main: z.ZodOptional<z.ZodObject<{
412
+ bold: z.ZodOptional<z.ZodBoolean>;
413
+ underline: z.ZodOptional<z.ZodBoolean>;
414
+ 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")[]]>>;
415
+ reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
416
+ }, "strip", z.ZodTypeAny, {
417
+ bold?: boolean | undefined;
418
+ underline?: boolean | undefined;
419
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
420
+ reset?: boolean | undefined;
421
+ }, {
422
+ bold?: boolean | undefined;
423
+ underline?: boolean | undefined;
424
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
425
+ reset?: boolean | undefined;
426
+ }>>;
427
+ /** Style of the help usage commands (if any) */
428
+ command: z.ZodOptional<z.ZodObject<{
429
+ bold: z.ZodOptional<z.ZodBoolean>;
430
+ underline: z.ZodOptional<z.ZodBoolean>;
431
+ 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")[]]>>;
432
+ reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
433
+ }, "strip", z.ZodTypeAny, {
434
+ bold?: boolean | undefined;
435
+ underline?: boolean | undefined;
436
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
437
+ reset?: boolean | undefined;
438
+ }, {
439
+ bold?: boolean | undefined;
440
+ underline?: boolean | undefined;
441
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
442
+ reset?: boolean | undefined;
443
+ }>>;
444
+ /** Style of the help usage options (if any) */
445
+ options: z.ZodOptional<z.ZodObject<{
446
+ bold: z.ZodOptional<z.ZodBoolean>;
447
+ underline: z.ZodOptional<z.ZodBoolean>;
448
+ 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")[]]>>;
449
+ reset: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
450
+ }, "strip", z.ZodTypeAny, {
451
+ bold?: boolean | undefined;
452
+ underline?: boolean | undefined;
453
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
454
+ reset?: boolean | undefined;
455
+ }, {
456
+ bold?: boolean | undefined;
457
+ underline?: boolean | undefined;
458
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
459
+ reset?: boolean | undefined;
460
+ }>>;
362
461
  }, "strip", z.ZodTypeAny, {
363
- bold?: boolean | undefined;
364
- underline?: boolean | undefined;
365
- color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
366
- reset?: boolean | undefined;
462
+ prefix?: {
463
+ bold?: boolean | undefined;
464
+ underline?: boolean | undefined;
465
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
466
+ reset?: boolean | undefined;
467
+ } | undefined;
468
+ main?: {
469
+ bold?: boolean | undefined;
470
+ underline?: boolean | undefined;
471
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
472
+ reset?: boolean | undefined;
473
+ } | undefined;
474
+ command?: {
475
+ bold?: boolean | undefined;
476
+ underline?: boolean | undefined;
477
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
478
+ reset?: boolean | undefined;
479
+ } | undefined;
480
+ options?: {
481
+ bold?: boolean | undefined;
482
+ underline?: boolean | undefined;
483
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
484
+ reset?: boolean | undefined;
485
+ } | undefined;
367
486
  }, {
368
- bold?: boolean | undefined;
369
- underline?: boolean | undefined;
370
- color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
371
- reset?: boolean | undefined;
487
+ prefix?: {
488
+ bold?: boolean | undefined;
489
+ underline?: boolean | undefined;
490
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
491
+ reset?: boolean | undefined;
492
+ } | undefined;
493
+ main?: {
494
+ bold?: boolean | undefined;
495
+ underline?: boolean | undefined;
496
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
497
+ reset?: boolean | undefined;
498
+ } | undefined;
499
+ command?: {
500
+ bold?: boolean | undefined;
501
+ underline?: boolean | undefined;
502
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
503
+ reset?: boolean | undefined;
504
+ } | undefined;
505
+ options?: {
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
+ } | undefined;
372
511
  }>>;
373
512
  /** Style of the help header */
374
513
  headerStyle: z.ZodOptional<z.ZodObject<{
@@ -405,7 +544,7 @@ export declare const HelpConfig: z.ZodObject<{
405
544
  reset?: boolean | undefined;
406
545
  }>>;
407
546
  /** Maximum length of a row in the help output */
408
- maxRowLength: z.ZodOptional<z.ZodNumber>;
547
+ lineLength: z.ZodOptional<z.ZodNumber>;
409
548
  /** Options for examples section */
410
549
  exampleOptions: z.ZodOptional<z.ZodObject<{
411
550
  /** Style of the example description */
@@ -515,8 +654,8 @@ export declare const HelpConfig: z.ZodObject<{
515
654
  }, "strip", z.ZodTypeAny, {
516
655
  bindCommand?: boolean | undefined;
517
656
  bindOption?: boolean | undefined;
657
+ useGlobalTableColumns?: boolean | undefined;
518
658
  commandOptions?: {
519
- namePrefix?: string | undefined;
520
659
  aliasPrefix?: string | undefined;
521
660
  compact?: boolean | undefined;
522
661
  nameStyle?: {
@@ -531,10 +670,11 @@ export declare const HelpConfig: z.ZodObject<{
531
670
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
532
671
  reset?: boolean | undefined;
533
672
  } | undefined;
673
+ namePrefix?: string | undefined;
534
674
  } | undefined;
535
675
  optionOptions?: {
536
- namePrefix?: string | undefined;
537
676
  aliasPrefix?: string | undefined;
677
+ negateAliasPrefix?: string | undefined;
538
678
  compact?: boolean | undefined;
539
679
  nameStyle?: {
540
680
  bold?: boolean | undefined;
@@ -548,6 +688,9 @@ export declare const HelpConfig: z.ZodObject<{
548
688
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
549
689
  reset?: boolean | undefined;
550
690
  } | undefined;
691
+ namePrefix?: string | undefined;
692
+ negatePrefix?: string | undefined;
693
+ displayNegations?: boolean | undefined;
551
694
  } | undefined;
552
695
  titleStyle?: {
553
696
  bold?: boolean | undefined;
@@ -568,10 +711,30 @@ export declare const HelpConfig: z.ZodObject<{
568
711
  reset?: boolean | undefined;
569
712
  } | undefined;
570
713
  usageStyle?: {
571
- bold?: boolean | undefined;
572
- underline?: boolean | undefined;
573
- color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
574
- reset?: boolean | undefined;
714
+ prefix?: {
715
+ bold?: boolean | undefined;
716
+ underline?: boolean | undefined;
717
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
718
+ reset?: boolean | undefined;
719
+ } | undefined;
720
+ main?: {
721
+ bold?: boolean | undefined;
722
+ underline?: boolean | undefined;
723
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
724
+ reset?: boolean | undefined;
725
+ } | undefined;
726
+ command?: {
727
+ bold?: boolean | undefined;
728
+ underline?: boolean | undefined;
729
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
730
+ reset?: boolean | undefined;
731
+ } | undefined;
732
+ options?: {
733
+ bold?: boolean | undefined;
734
+ underline?: boolean | undefined;
735
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
736
+ reset?: boolean | undefined;
737
+ } | undefined;
575
738
  } | undefined;
576
739
  headerStyle?: {
577
740
  bold?: boolean | undefined;
@@ -585,7 +748,7 @@ export declare const HelpConfig: z.ZodObject<{
585
748
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
586
749
  reset?: boolean | undefined;
587
750
  } | undefined;
588
- maxRowLength?: number | undefined;
751
+ lineLength?: number | undefined;
589
752
  exampleOptions?: {
590
753
  descriptionStyle?: {
591
754
  bold?: boolean | undefined;
@@ -614,8 +777,8 @@ export declare const HelpConfig: z.ZodObject<{
614
777
  }, {
615
778
  bindCommand?: boolean | undefined;
616
779
  bindOption?: boolean | undefined;
780
+ useGlobalTableColumns?: boolean | undefined;
617
781
  commandOptions?: {
618
- namePrefix?: string | undefined;
619
782
  aliasPrefix?: string | undefined;
620
783
  compact?: boolean | undefined;
621
784
  nameStyle?: {
@@ -630,10 +793,11 @@ export declare const HelpConfig: z.ZodObject<{
630
793
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
631
794
  reset?: boolean | undefined;
632
795
  } | undefined;
796
+ namePrefix?: string | undefined;
633
797
  } | undefined;
634
798
  optionOptions?: {
635
- namePrefix?: string | undefined;
636
799
  aliasPrefix?: string | undefined;
800
+ negateAliasPrefix?: string | undefined;
637
801
  compact?: boolean | undefined;
638
802
  nameStyle?: {
639
803
  bold?: boolean | undefined;
@@ -647,6 +811,9 @@ export declare const HelpConfig: z.ZodObject<{
647
811
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
648
812
  reset?: boolean | undefined;
649
813
  } | undefined;
814
+ namePrefix?: string | undefined;
815
+ negatePrefix?: string | undefined;
816
+ displayNegations?: boolean | undefined;
650
817
  } | undefined;
651
818
  titleStyle?: {
652
819
  bold?: boolean | undefined;
@@ -667,10 +834,30 @@ export declare const HelpConfig: z.ZodObject<{
667
834
  reset?: boolean | undefined;
668
835
  } | undefined;
669
836
  usageStyle?: {
670
- bold?: boolean | undefined;
671
- underline?: boolean | undefined;
672
- color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
673
- reset?: boolean | undefined;
837
+ prefix?: {
838
+ bold?: boolean | undefined;
839
+ underline?: boolean | undefined;
840
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
841
+ reset?: boolean | undefined;
842
+ } | undefined;
843
+ main?: {
844
+ bold?: boolean | undefined;
845
+ underline?: boolean | undefined;
846
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
847
+ reset?: boolean | undefined;
848
+ } | undefined;
849
+ command?: {
850
+ bold?: boolean | undefined;
851
+ underline?: boolean | undefined;
852
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
853
+ reset?: boolean | undefined;
854
+ } | undefined;
855
+ options?: {
856
+ bold?: boolean | undefined;
857
+ underline?: boolean | undefined;
858
+ color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
859
+ reset?: boolean | undefined;
860
+ } | undefined;
674
861
  } | undefined;
675
862
  headerStyle?: {
676
863
  bold?: boolean | undefined;
@@ -684,7 +871,7 @@ export declare const HelpConfig: z.ZodObject<{
684
871
  color?: "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite" | undefined;
685
872
  reset?: boolean | undefined;
686
873
  } | undefined;
687
- maxRowLength?: number | undefined;
874
+ lineLength?: number | undefined;
688
875
  exampleOptions?: {
689
876
  descriptionStyle?: {
690
877
  bold?: boolean | undefined;
@@ -718,6 +905,7 @@ export type HelpItem = {
718
905
  aliases: string[];
719
906
  description: string;
720
907
  hidden?: boolean;
908
+ negatable?: boolean;
721
909
  };
722
910
  export declare class HelpGenerator {
723
911
  entry: MassargCommand<any>;
package/help.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AAEnB,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAqB,MAAM,SAAS,CAAA;AAEzD,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAOrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA6B,CAAA;AACnE,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF,eAAO,MAAM,UAAU;IACrB;;;;OAIG;;IAEH;;;;OAIG;;IAGH,mDAAmD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEnD,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAElD,8BAA8B;;;;;;;;;;;;;;;;;IAE9B,oCAAoC;;;;;;;;;;;;;;;;;IAEpC,qEAAqE;;;;;;;;;;;;;;;;;IAErE,8BAA8B;;;;;;;;;;;;;;;;;IAE9B,+BAA+B;;;;;;;;;;;;;;;;;IAE/B,+BAA+B;;;;;;;;;;;;;;;;;IAE/B,iDAAiD;;IAEjD,mCAAmC;;QAG/B,uCAAuC;;;;;;;;;;;;;;;;;QAEvC,iCAAiC;;;;;;;;;;;;;;;;;QAEjC,kCAAkC;;;;;;;;;;;;;;;;;QAElC,kDAAkD;;QAElD,mDAAmD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAIvD,4DAA4D;;IAE5D,6DAA6D;;IAE7D,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE7D,CAAA;AAEF,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAA;AAEnD,eAAO,MAAM,iBAAiB,EAAE,YAAY,CAAC,UAAU,CAyDtD,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,qBAAa,aAAa;IACxB,KAAK,EAAE,cAAc,CAAC,GAAG,CAAC,CAAA;IAC1B,MAAM,EAAE,YAAY,CAAC,UAAU,CAAC,CAAA;gBAEpB,KAAK,EAAE,cAAc,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,UAAU;IAe3D,QAAQ,IAAI,MAAM;IAoFlB,SAAS,IAAI,IAAI;CAGlB"}
1
+ {"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AAEnB,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAgC,MAAM,SAAS,CAAA;AAQpE,eAAO,MAAM,0BAA0B;IACrC,sCAAsC;;IAEtC,0DAA0D;;IAE1D,uCAAuC;;;;;;;;;;;;;;;;;IAEvC,8CAA8C;;;;;;;;;;;;;;;;;IAE9C,2EAA2E;;IAE3E,8EAA8E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE9E,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASrC,CAAA;AACD,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF,eAAO,MAAM,UAAU;IACrB;;;;OAIG;;IAEH;;;;OAIG;;IAGH,6GAA6G;;IAG7G,mDAAmD;;QA5CnD,sCAAsC;;QAEtC,0DAA0D;;QAE1D,uCAAuC;;;;;;;;;;;;;;;;;QAEvC,8CAA8C;;;;;;;;;;;;;;;;;QAE9C,2EAA2E;;QAE3E,8EAA8E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAoC9E,kDAAkD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAElD,8BAA8B;;;;;;;;;;;;;;;;;IAE9B,oCAAoC;;;;;;;;;;;;;;;;;IAEpC,qEAAqE;;;;;;;;;;;;;;;;;IAErE,8BAA8B;;QAG1B,qFAAqF;;;;;;;;;;;;;;;;;QAErF;;;WAGG;;;;;;;;;;;;;;;;;QAEH,gDAAgD;;;;;;;;;;;;;;;;;QAEhD,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAInD,+BAA+B;;;;;;;;;;;;;;;;;IAE/B,+BAA+B;;;;;;;;;;;;;;;;;IAE/B,iDAAiD;;IAEjD,mCAAmC;;QAG/B,uCAAuC;;;;;;;;;;;;;;;;;QAEvC,iCAAiC;;;;;;;;;;;;;;;;;QAEjC,kCAAkC;;;;;;;;;;;;;;;;;QAElC,kDAAkD;;QAElD,mDAAmD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAIvD,4DAA4D;;IAE5D,6DAA6D;;IAE7D,6DAA6D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE7D,CAAA;AAEF,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAA;AAEnD,eAAO,MAAM,iBAAiB,EAAE,YAAY,CAAC,UAAU,CAsEtD,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,qBAAa,aAAa;IACxB,KAAK,EAAE,cAAc,CAAC,GAAG,CAAC,CAAA;IAC1B,MAAM,EAAE,YAAY,CAAC,UAAU,CAAC,CAAA;gBAEpB,KAAK,EAAE,cAAc,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,UAAU;IAK3D,QAAQ,IAAI,MAAM;IAmGlB,SAAS,IAAI,IAAI;CAGlB"}