-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathra_usage_test.go
More file actions
2087 lines (1648 loc) · 58.1 KB
/
Copy pathra_usage_test.go
File metadata and controls
2087 lines (1648 loc) · 58.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package ra
import (
"regexp"
"strings"
"testing"
"github.com/amterp/color"
"github.com/stretchr/testify/assert"
)
func init() {
color.NoColor = true
}
// withColorsEnabled is a helper for tests that need to test color output
func withColorsEnabled(testFunc func()) {
oldNoColor := color.NoColor
color.NoColor = false
defer func() {
color.NoColor = oldNoColor
}()
testFunc()
}
func Test_Usage_DefaultHeaders(t *testing.T) {
cmd := NewCmd("myapp")
cmd.SetDescription("Test default headers")
_, err := NewString("input").SetUsage("Input file").Register(cmd)
assert.NoError(t, err)
subCmd := NewCmd("subcmd")
subCmd.SetDescription("A subcommand")
_, err = cmd.RegisterCmd(subCmd)
assert.NoError(t, err)
_, err = NewString("global").SetUsage("Global flag").Register(cmd, WithGlobal(true))
assert.NoError(t, err)
usage := cmd.GenerateUsage(false)
assert.Contains(t, usage, "Usage:")
assert.Contains(t, usage, "Commands:")
assert.Contains(t, usage, "Arguments:")
assert.Contains(t, usage, "Global options:")
}
func Test_Usage_CustomHeaders(t *testing.T) {
cmd := NewCmd("myapp")
cmd.SetDescription("Test custom headers")
headers := UsageHeaders{
Usage: "How to use:",
Commands: "Available commands:",
Arguments: "Parameters:",
GlobalOptions: "Global flags:",
}
cmd.SetUsageHeaders(headers)
_, err := NewString("input").SetUsage("Input file").Register(cmd)
assert.NoError(t, err)
subCmd := NewCmd("subcmd")
subCmd.SetDescription("A subcommand")
_, err = cmd.RegisterCmd(subCmd)
assert.NoError(t, err)
_, err = NewString("global").SetUsage("Global flag").Register(cmd, WithGlobal(true))
assert.NoError(t, err)
usage := cmd.GenerateUsage(false)
assert.Contains(t, usage, "How to use:")
assert.Contains(t, usage, "Available commands:")
assert.Contains(t, usage, "Parameters:")
assert.Contains(t, usage, "Global flags:")
// Verify old headers are not present
assert.NotContains(t, usage, "Usage:")
assert.NotContains(t, usage, "Commands:")
assert.NotContains(t, usage, "Arguments:")
assert.NotContains(t, usage, "Global options:")
}
func Test_Usage_ColoredHeaders(t *testing.T) {
withColorsEnabled(func() {
cmd := NewCmd("myapp")
cmd.SetDescription("Test colored headers")
_, err := NewString("input").SetUsage("Input file").Register(cmd)
assert.NoError(t, err)
subCmd := NewCmd("subcmd")
subCmd.SetDescription("A subcommand")
_, err = cmd.RegisterCmd(subCmd)
assert.NoError(t, err)
_, err = NewString("global").SetUsage("Global flag").Register(cmd, WithGlobal(true))
assert.NoError(t, err)
usage := cmd.GenerateUsage(false)
// Check for ANSI color codes in headers (green bold = \033[32;1m)
assert.Contains(t, usage, "\033[32;1mUsage:\033[0;22m")
assert.Contains(t, usage, "\033[32;1mCommands:\033[0;22m")
assert.Contains(t, usage, "\033[32;1mArguments:\033[0;22m")
assert.Contains(t, usage, "\033[32;1mGlobal options:\033[0;22m")
})
}
func Test_Usage_CustomColoredHeaders(t *testing.T) {
withColorsEnabled(func() {
cmd := NewCmd("myapp")
cmd.SetDescription("Test custom colored headers")
headers := UsageHeaders{
Usage: "How to use:",
Commands: "Available commands:",
Arguments: "Parameters:",
GlobalOptions: "Global flags:",
}
cmd.SetUsageHeaders(headers)
_, err := NewString("input").SetUsage("Input file").Register(cmd)
assert.NoError(t, err)
subCmd := NewCmd("subcmd")
subCmd.SetDescription("A subcommand")
_, err = cmd.RegisterCmd(subCmd)
assert.NoError(t, err)
_, err = NewString("global").SetUsage("Global flag").Register(cmd, WithGlobal(true))
assert.NoError(t, err)
usage := cmd.GenerateUsage(false)
// Check for ANSI color codes with custom headers
assert.Contains(t, usage, "\033[32;1mHow to use:\033[0;22m")
assert.Contains(t, usage, "\033[32;1mAvailable commands:\033[0;22m")
assert.Contains(t, usage, "\033[32;1mParameters:\033[0;22m")
assert.Contains(t, usage, "\033[32;1mGlobal flags:\033[0;22m")
})
}
func Test_Usage_ColoredSynopsis(t *testing.T) {
withColorsEnabled(func() {
cmd := NewCmd("myapp")
cmd.SetDescription("Test colored synopsis")
_, err := NewString("input").SetUsage("Input file").Register(cmd)
assert.NoError(t, err)
_, err = NewString("output").SetUsage("Output file").SetOptional(true).Register(cmd)
assert.NoError(t, err)
usage := cmd.GenerateUsage(false)
t.Logf("Test_Usage_ColoredSynopsis output:\n%s", usage)
// Check for bold command name and cyan argument types
assert.Contains(t, usage, "\033[1mmyapp\033[22m") // Bold command name
assert.Contains(t, usage, "\033[36m<input>\033[0m") // Cyan required arg
assert.Contains(t, usage, "\033[36m[output]\033[0m") // Cyan optional arg - NOW appears thanks to fix!
assert.Contains(t, usage, "\033[36m[OPTIONS]\033[0m") // Cyan options
})
}
func Test_Usage_OptionalPositionalArgsShouldAppear(t *testing.T) {
withColorsEnabled(func() {
cmd := NewCmd("myapp")
// Required positional arg
_, err := NewString("required").SetUsage("Required input").Register(cmd)
assert.NoError(t, err)
// Optional positional arg - this should appear in synopsis!
_, err = NewString("optional").SetUsage("Optional input").SetOptional(true).Register(cmd)
assert.NoError(t, err)
usage := cmd.GenerateUsage(false)
t.Logf("Current usage output:\n%s", usage)
// Both required and optional positional args should appear in synopsis
assert.Contains(t, usage, "<required>", "required positional arg should appear with <brackets>")
assert.Contains(t, usage, "[optional]", "optional positional arg should appear with [brackets]")
})
}
func Test_Usage_DocumentationExample(t *testing.T) {
cmd := NewCmd("mycommand")
cmd.SetDescription("Example for documentation")
// Required positional arg
_, err := NewString("required-arg").SetUsage("A required argument").Register(cmd)
assert.NoError(t, err)
// Optional positional arg
_, err = NewString("optional-arg").SetUsage("An optional argument").SetOptional(true).Register(cmd)
assert.NoError(t, err)
// Another optional positional arg
_, err = NewString("other-optional").SetUsage("Another optional argument").SetOptional(true).Register(cmd)
assert.NoError(t, err)
usage := cmd.GenerateUsage(false)
t.Logf("Documentation example output:\n%s", usage)
// Verify the synopsis shows all positional args
assert.Contains(t, usage, "mycommand <required-arg> [optional-arg] [other-optional] [OPTIONS]")
}
func Test_Usage_ExamplesmdPattern(t *testing.T) {
// Test based on EXAMPLES.md pattern: mycmd aaa --arg2 bbb -c ddd -f
cmd := NewCmd("mycmd")
cmd.SetDescription("Example matching EXAMPLES.md dual nature")
// arg1: can be positional or --arg1
_, err := NewString("arg1").SetUsage("First argument").Register(cmd)
assert.NoError(t, err)
// arg2: can be positional or --arg2
_, err = NewString("arg2").SetUsage("Second argument").Register(cmd)
assert.NoError(t, err)
// arg3: can be positional or --arg3/-c
_, err = NewString("arg3").SetShort("c").SetUsage("Third argument").Register(cmd)
assert.NoError(t, err)
// arg4: bool flag, not positional
_, err = NewBool("arg4").SetShort("f").SetUsage("Fourth argument (bool)").Register(cmd)
assert.NoError(t, err)
usage := cmd.GenerateUsage(false)
t.Logf("EXAMPLES.md pattern usage output:\n%s", usage)
}
func Test_Usage_SimpleCommand(t *testing.T) {
cmd := NewCmd("myapp")
cmd.SetDescription("A simple application for testing")
flag1, err := NewString("config").
SetShort("c").
SetUsage("Configuration file path.").
SetDefault("/etc/myapp.conf").
Register(cmd)
assert.NoError(t, err)
flag2, err := NewBool("verbose").
SetShort("v").
SetUsage("Enable verbose output.").
Register(cmd)
assert.NoError(t, err)
flag3, err := NewInt("timeout").
SetUsage("Request timeout in seconds.").
SetMin(1, true).
SetMax(300, true).
SetDefault(30).
Register(cmd)
assert.NoError(t, err)
_ = flag1
_ = flag2
_ = flag3
usage := cmd.GenerateUsage(false)
expected := `A simple application for testing
Usage:
myapp [config] [timeout] [OPTIONS]
Arguments:
-c, --config str Configuration file path. (default /etc/myapp.conf)
--timeout int Request timeout in seconds. Range: [1, 300] (default 30)
-v, --verbose Enable verbose output.
`
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(usage))
}
func Test_Usage_WithPositionalArgs(t *testing.T) {
cmd := NewCmd("processor")
cmd.SetDescription("Process input files")
// Positional arguments
input, err := NewString("input-file").
SetUsage("Path to input file").
SetPositionalOnly(true).
Register(cmd)
assert.NoError(t, err)
output, err := NewString("output-dir").
SetUsage("Output directory").
SetPositionalOnly(true).
SetOptional(true).
Register(cmd)
assert.NoError(t, err)
// Named options
format, err := NewString("format").
SetShort("f").
SetUsage("Output format").
SetEnumConstraint([]string{"json", "yaml", "xml"}).
SetDefault("json").
Register(cmd)
assert.NoError(t, err)
concurrent, err := NewInt("jobs").
SetShort("j").
SetUsage("Number of concurrent jobs").
SetMin(1, true).
SetMax(16, false).
Register(cmd)
assert.NoError(t, err)
_ = input
_ = output
_ = format
_ = concurrent
usage := cmd.GenerateUsage(false)
expected := `Process input files
Usage:
processor <input-file> [output-dir] [format] <jobs> [OPTIONS]
Arguments:
input-file str Path to input file
output-dir str (optional) Output directory
-f, --format str Output format. Valid values: [json, yaml, xml] (default json)
-j, --jobs int Number of concurrent jobs. Range: [1, 16)
`
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(usage))
}
func Test_Usage_WithSubcommands(t *testing.T) {
cmd := NewCmd("git-like")
cmd.SetDescription("A git-like version control system")
// Global options
verbose, err := NewBool("verbose").
SetShort("v").
SetUsage("Enable verbose output").
Register(cmd)
assert.NoError(t, err)
config, err := NewString("config").
SetUsage("Path to config file").
SetDefault("~/.gitlike/config").
Register(cmd)
assert.NoError(t, err)
// Add subcommand
addCmd := NewCmd("add")
addCmd.SetDescription("Add files to the staging area")
addAll, err := NewBool("all").
SetShort("A").
SetUsage("Add all modified files").
Register(addCmd)
assert.NoError(t, err)
addFiles, err := NewStringSlice("files").
SetUsage("Files to add").
SetPositionalOnly(true).
SetVariadic(true).
Register(addCmd)
assert.NoError(t, err)
// Commit subcommand
commitCmd := NewCmd("commit")
commitCmd.SetDescription("Record changes to the repository")
message, err := NewString("message").
SetShort("m").
SetUsage("Commit message").
SetRegexConstraint(regexp.MustCompile(`^.{1,72}$`)).
Register(commitCmd)
assert.NoError(t, err)
amend, err := NewBool("amend").
SetUsage("Amend the previous commit").
SetExcludes([]string{"message"}).
Register(commitCmd)
assert.NoError(t, err)
_, err = cmd.RegisterCmd(addCmd)
assert.NoError(t, err)
_, err = cmd.RegisterCmd(commitCmd)
assert.NoError(t, err)
_ = verbose
_ = config
_ = addAll
_ = addFiles
_ = message
_ = amend
usage := cmd.GenerateUsage(false)
expected := `A git-like version control system
Usage:
git-like [subcommand] [config] [OPTIONS]
Commands:
add Add files to the staging area
commit Record changes to the repository
Arguments:
--config str Path to config file. (default ~/.gitlike/config)
-v, --verbose Enable verbose output
`
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(usage))
}
func Test_Usage_SubcommandWithArgs(t *testing.T) {
cmd := NewCmd("git-like")
addCmd := NewCmd("add")
addCmd.SetDescription("Add files to the staging area")
// Add subcommand options
all, err := NewBool("all").
SetShort("A").
SetUsage("Add all modified files").
SetExcludes([]string{"force"}).
Register(addCmd)
assert.NoError(t, err)
force, err := NewBool("force").
SetShort("f").
SetUsage("Force add ignored files").
Register(addCmd)
assert.NoError(t, err)
files, err := NewStringSlice("files").
SetUsage("Files to add").
SetPositionalOnly(true).
SetVariadic(true).
SetOptional(true).
Register(addCmd)
assert.NoError(t, err)
_, err = cmd.RegisterCmd(addCmd)
assert.NoError(t, err)
_ = all
_ = force
_ = files
usage := addCmd.GenerateUsage(false)
expected := `Add files to the staging area
Usage:
add [files...] [OPTIONS]
Arguments:
files [strs...] Files to add
-A, --all Add all modified files. Excludes: force
-f, --force Force add ignored files
`
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(usage))
}
func Test_Usage_ComplexConstraints(t *testing.T) {
cmd := NewCmd("complex")
cmd.SetDescription("Command with various constraint types")
// Range constraints
port, err := NewInt("port").
SetShort("p").
SetUsage("Server port").
SetMin(1024, true).
SetMax(65535, true).
SetDefault(8080).
Register(cmd)
assert.NoError(t, err)
rate, err := NewFloat64("rate").
SetUsage("Processing rate").
SetMin(0.0, false).
SetMax(100.0, true).
Register(cmd)
assert.NoError(t, err)
unbounded, err := NewInt("retries").
SetUsage("Number of retries").
SetMin(0, true).
Register(cmd)
assert.NoError(t, err)
// Enum constraint
format, err := NewString("format").
SetUsage("Output format").
SetEnumConstraint([]string{"json", "yaml", "xml", "csv"}).
SetDefault("json").
Register(cmd)
assert.NoError(t, err)
// Regex constraint
name, err := NewString("name").
SetUsage("Resource name").
SetRegexConstraint(regexp.MustCompile(`^[a-zA-Z][a-zA-Z0-9_-]*$`)).
Register(cmd)
assert.NoError(t, err)
// Slice with custom separator
tags, err := NewStringSlice("tags").
SetUsage("Resource tags").
SetSeparator("|").
SetRequires([]string{"name"}).
Register(cmd)
assert.NoError(t, err)
// Multiple relationships
debug, err := NewBool("debug").
SetUsage("Enable debug mode").
SetExcludes([]string{"quiet", "silent"}).
Register(cmd)
assert.NoError(t, err)
quiet, err := NewBool("quiet").
SetShort("q").
SetUsage("Suppress output").
SetExcludes([]string{"debug", "verbose"}).
Register(cmd)
assert.NoError(t, err)
_ = port
_ = rate
_ = unbounded
_ = format
_ = name
_ = tags
_ = debug
_ = quiet
usage := cmd.GenerateUsage(false)
expected := `Command with various constraint types
Usage:
complex [port] <rate> <retries> [format] <name> <tags> [OPTIONS]
Arguments:
-p, --port int Server port. Range: [1024, 65535] (default 8080)
--rate float Processing rate. Range: (0, 100]
--retries int Number of retries. Range: [0, )
--format str Output format. Valid values: [json, yaml, xml, csv] (default json)
--name str Resource name. Regex: ^[a-zA-Z][a-zA-Z0-9_-]*$
--tags strs Resource tags. Separator: "|". Requires: name
--debug Enable debug mode. Excludes: quiet, silent
-q, --quiet Suppress output. Excludes: debug, verbose
`
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(usage))
}
func Test_Usage_MixedPositionalAndOptions(t *testing.T) {
cmd := NewCmd("deploy")
cmd.SetDescription("Deploy application to target environment")
// Required positional
app, err := NewString("app-name").
SetUsage("Application name").
SetPositionalOnly(true).
Register(cmd)
assert.NoError(t, err)
// Optional positional
env, err := NewString("environment").
SetUsage("Target environment").
SetPositionalOnly(true).
SetOptional(true).
SetDefault("staging").
Register(cmd)
assert.NoError(t, err)
// Named options
force, err := NewBool("force").
SetShort("f").
SetUsage("Force deployment even if checks fail").
Register(cmd)
assert.NoError(t, err)
timeout, err := NewInt("timeout").
SetUsage("Deployment timeout").
SetMin(30, true).
SetDefault(300).
Register(cmd)
assert.NoError(t, err)
rollback, err := NewBool("no-rollback").
SetUsage("Disable automatic rollback on failure").
SetExcludes([]string{"force"}).
Register(cmd)
assert.NoError(t, err)
_ = app
_ = env
_ = force
_ = timeout
_ = rollback
usage := cmd.GenerateUsage(false)
expected := `Deploy application to target environment
Usage:
deploy <app-name> [environment] [timeout] [OPTIONS]
Arguments:
app-name str Application name
environment str (optional) Target environment. (default staging)
--timeout int Deployment timeout. Range: [30, ) (default 300)
-f, --force Force deployment even if checks fail
--no-rollback Disable automatic rollback on failure. Excludes: force
`
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(usage))
}
func Test_Usage_HiddenAndLongHelpFlags(t *testing.T) {
cmd := NewCmd("myapp")
cmd.SetDescription("Testing hidden flag behavior")
// Regular flag
regular, err := NewString("config").
SetUsage("Configuration file").
Register(cmd)
assert.NoError(t, err)
// Hidden flag - should never appear
hidden, err := NewString("secret").
SetUsage("Secret flag").
SetHidden(true).
Register(cmd)
assert.NoError(t, err)
// Hidden in short help - should only appear in long help
longOnly, err := NewString("debug-info").
SetUsage("Debug information").
SetHiddenInShortHelp(true).
Register(cmd)
assert.NoError(t, err)
_ = regular
_ = hidden
_ = longOnly
// Test short help (should exclude longOnly flag)
shortUsage := cmd.GenerateUsage(false)
expectedShort := `Testing hidden flag behavior
Usage:
myapp <config> [OPTIONS]
Arguments:
--config str Configuration file
`
assert.Equal(t, strings.TrimSpace(expectedShort), strings.TrimSpace(shortUsage))
// Test long help (should include longOnly flag)
longUsage := cmd.GenerateUsage(true)
expectedLong := `Testing hidden flag behavior
Usage:
myapp <config> <debug-info> [OPTIONS]
Arguments:
--config str Configuration file
--debug-info str Debug information
`
assert.Equal(t, strings.TrimSpace(expectedLong), strings.TrimSpace(longUsage))
}
func Test_Usage_HiddenCommands(t *testing.T) {
cmd := NewCmd("myapp")
cmd.SetDescription("Testing hidden command behavior")
cmd.RegisterCmd(NewCmd("build").SetDescription("Build the project"))
cmd.RegisterCmd(NewCmd("secret-cmd").SetDescription("Secret command").SetHidden(true))
cmd.RegisterCmd(NewCmd("debug-cmd").SetDescription("Debug command").SetHiddenInShortHelp(true))
// Short help excludes both the fully hidden and the hidden-in-short commands.
shortUsage := cmd.GenerateUsage(false)
expectedShort := `Testing hidden command behavior
Usage:
myapp [subcommand] [OPTIONS]
Commands:
build Build the project
`
assert.Equal(t, strings.TrimSpace(expectedShort), strings.TrimSpace(shortUsage))
// Long help includes the hidden-in-short command but still excludes the fully hidden one.
longUsage := cmd.GenerateUsage(true)
expectedLong := `Testing hidden command behavior
Usage:
myapp [subcommand] [OPTIONS]
Commands:
build Build the project
debug-cmd Debug command
`
assert.Equal(t, strings.TrimSpace(expectedLong), strings.TrimSpace(longUsage))
}
func Test_Usage_AllHiddenCommands(t *testing.T) {
cmd := NewCmd("myapp")
cmd.SetDescription("All hidden commands")
cmd.RegisterCmd(NewCmd("alpha").SetDescription("Alpha command").SetHidden(true))
cmd.RegisterCmd(NewCmd("beta").SetDescription("Beta command").SetHidden(true))
// With every subcommand hidden, neither the Commands section nor the
// [subcommand] synopsis placeholder should appear.
expected := `All hidden commands
Usage:
myapp [OPTIONS]
`
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(cmd.GenerateUsage(false)))
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(cmd.GenerateUsage(true)))
}
func Test_Usage_AllHiddenInShortHelpCommands(t *testing.T) {
cmd := NewCmd("myapp")
cmd.SetDescription("Commands hidden in short help")
cmd.RegisterCmd(NewCmd("alpha").SetDescription("Alpha command").SetHiddenInShortHelp(true))
cmd.RegisterCmd(NewCmd("beta").SetDescription("Beta command").SetHiddenInShortHelp(true))
// Short help: every command is hidden at this level, so the Commands section
// and the [subcommand] placeholder both drop out.
expectedShort := `Commands hidden in short help
Usage:
myapp [OPTIONS]
`
assert.Equal(t, strings.TrimSpace(expectedShort), strings.TrimSpace(cmd.GenerateUsage(false)))
// Long help: both commands reappear, along with the placeholder.
expectedLong := `Commands hidden in short help
Usage:
myapp [subcommand] [OPTIONS]
Commands:
alpha Alpha command
beta Beta command
`
assert.Equal(t, strings.TrimSpace(expectedLong), strings.TrimSpace(cmd.GenerateUsage(true)))
}
// A parent command's own required flags must appear in its synopsis consistently,
// whether or not the [subcommand] placeholder is present. Previously the synopsis
// took a reduced "subcommand branch" that dropped non-positional flags, so a
// required flag-only arg could appear in -h but vanish from --help (or vice versa)
// depending on subcommand visibility.
func Test_Usage_SubcommandSynopsisIncludesRequiredFlags(t *testing.T) {
cmd := NewCmd("myapp")
_, err := NewString("target").SetFlagOnly(true).SetUsage("Deploy target").Register(cmd)
assert.NoError(t, err)
cmd.RegisterCmd(NewCmd("sub").SetDescription("A subcommand").SetHiddenInShortHelp(true))
// Short help: subcommand is hidden at this level, so no placeholder - but the
// required flag must still appear.
assert.Equal(t, "myapp <target> [OPTIONS]", cmd.GenerateShortSynopsis())
// Long help: placeholder appears AND the required flag still appears.
assert.Equal(t, "myapp [subcommand] <target> [OPTIONS]", cmd.GenerateLongSynopsis())
}
func Test_Usage_GlobalFlagsInSubCommand(t *testing.T) {
cmd := NewCmd("parent")
cmd.SetDescription("Parent command with global flags")
// Global flags
verbose, err := NewBool("verbose").
SetShort("v").
SetUsage("Enable verbose output").
Register(cmd, WithGlobal(true))
assert.NoError(t, err)
debug, err := NewString("log-level").
SetUsage("Set log level").
SetDefault("info").
Register(cmd, WithGlobal(true))
assert.NoError(t, err)
// Create subcommand
subCmd := NewCmd("sub")
subCmd.SetDescription("Sub command inherits global flags")
// Subcommand-specific flag
input, err := NewString("input").
SetUsage("Input file").
Register(subCmd)
assert.NoError(t, err)
_, err = cmd.RegisterCmd(subCmd)
assert.NoError(t, err)
_ = verbose
_ = debug
_ = input
// Subcommand should show both its own flags and global flags
usage := subCmd.GenerateUsage(false)
expected := `Sub command inherits global flags
Usage:
sub <input> [OPTIONS]
Arguments:
--input str Input file
Global options:
-v, --verbose Enable verbose output
--log-level str Set log level. (default info)
`
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(usage))
}
func Test_Usage_FlagOrderingNonBoolFirst(t *testing.T) {
cmd := NewCmd("ordering")
cmd.SetDescription("Test flag ordering: non-bool first, then bool")
// Register in mixed order to test sorting
bool1, err := NewBool("verbose").
SetShort("v").
SetUsage("Enable verbose mode").
Register(cmd)
assert.NoError(t, err)
str1, err := NewString("config").
SetUsage("Config file path").
Register(cmd)
assert.NoError(t, err)
bool2, err := NewBool("force").
SetShort("f").
SetUsage("Force operation").
Register(cmd)
assert.NoError(t, err)
int1, err := NewInt("timeout").
SetUsage("Timeout value").
Register(cmd)
assert.NoError(t, err)
bool3, err := NewBool("quiet").
SetShort("q").
SetUsage("Quiet mode").
Register(cmd)
assert.NoError(t, err)
_ = bool1
_ = str1
_ = bool2
_ = int1
_ = bool3
usage := cmd.GenerateUsage(false)
expected := `Test flag ordering: non-bool first, then bool
Usage:
ordering <config> <timeout> [OPTIONS]
Arguments:
--config str Config file path
--timeout int Timeout value
-v, --verbose Enable verbose mode
-f, --force Force operation
-q, --quiet Quiet mode
`
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(usage))
}
func Test_Usage_VariadicSliceFormats(t *testing.T) {
cmd := NewCmd("slices")
cmd.SetDescription("Testing various slice configurations")
// Positional-only variadic slice (must come first)
files, err := NewStringSlice("files").
SetUsage("Input files").
SetPositionalOnly(true).
SetVariadic(true).
SetOptional(true).
Register(cmd)
assert.NoError(t, err)
// Required variadic slice
tags, err := NewStringSlice("tags").
SetUsage("Resource tags").
SetVariadic(true).
Register(cmd)
assert.NoError(t, err)
// Optional variadic slice
includes, err := NewStringSlice("include").
SetUsage("Include patterns").
SetVariadic(true).
SetOptional(true).
Register(cmd)
assert.NoError(t, err)
// Regular slice with separator
ports, err := NewIntSlice("ports").
SetUsage("Port numbers").
SetSeparator(",").
Register(cmd)
assert.NoError(t, err)
_ = tags
_ = includes
_ = ports
_ = files
usage := cmd.GenerateUsage(false)
expected := `Testing various slice configurations
Usage:
slices [files...] [OPTIONS]
Arguments:
files [strs...] Input files
--tags [strs...] Resource tags
--include [strs...] Include patterns
--ports ints Port numbers. Separator: ","
`
assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(usage))
}
func Test_Usage_ComplexRelationshipsAndConstraints(t *testing.T) {
cmd := NewCmd("complex")
cmd.SetDescription("Complex example with all constraint types")
// String with regex and enum (should show both constraints)
mode, err := NewString("mode").
SetUsage("Operation mode").
SetRegexConstraint(regexp.MustCompile(`^(dev|prod|test)$`)).
SetEnumConstraint([]string{"dev", "prod", "test"}).
Register(cmd)
assert.NoError(t, err)
// Float with exclusive bounds
rate, err := NewFloat64("rate").
SetUsage("Processing rate").
SetMin(0.0, false).
SetMax(1.0, false).
SetDefault(0.5).
Register(cmd)
assert.NoError(t, err)
// Multiple requires/excludes
verbose, err := NewBool("verbose").
SetShort("v").
SetUsage("Verbose output").
SetExcludes([]string{"quiet", "silent"}).
SetRequires([]string{"mode"}).
Register(cmd)
assert.NoError(t, err)
quiet, err := NewBool("quiet").
SetShort("q").
SetUsage("Quiet mode").
SetExcludes([]string{"verbose"}).
Register(cmd)
assert.NoError(t, err)
silent, err := NewBool("silent").
SetUsage("Silent mode").
SetExcludes([]string{"verbose"}).
Register(cmd)
assert.NoError(t, err)
// Slice with separator and requires
configs, err := NewStringSlice("config-files").
SetUsage("Configuration files").
SetSeparator(":").
SetRequires([]string{"mode"}).
SetOptional(true).