-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexecute.go
More file actions
994 lines (877 loc) · 24.7 KB
/
execute.go
File metadata and controls
994 lines (877 loc) · 24.7 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
package cli
import (
"context"
"fmt"
"strings"
"github.com/bjaus/bind"
)
// resolvedCommand holds the result of walking the command tree.
type resolvedCommand struct {
chain []Commander
chainArgs [][]string // per-command flag args, aligned with chain
branchArgs [][]string // per-command positional args for branching commands
positional []string
usedFallback bool // true if Fallbacker was invoked during resolution
}
// flagIndex maps flag names (--name, -n) to whether they are boolean.
type flagIndex struct {
known map[string]bool // flag name -> isBool
}
func buildFlagIndex(cmd Commander) flagIndex {
flags := ScanFlags(cmd)
idx := flagIndex{known: make(map[string]bool, len(flags)*2)}
for i := range flags {
f := &flags[i]
boolLike := f.IsBool || f.IsCounter
idx.known["--"+f.Name] = boolLike
if f.Short != "" {
idx.known["-"+f.Short] = boolLike
}
if f.Negate {
idx.known["--no-"+f.Name] = true
}
for _, alt := range f.Alt {
idx.known["--"+alt] = boolLike
}
}
return idx
}
func (fi flagIndex) has(name string) bool {
_, ok := fi.known[name]
return ok
}
func (fi flagIndex) isBool(name string) bool {
return fi.known[name]
}
// resolveCommand walks the command tree using flags-anywhere logic.
func resolveCommand(root Commander, args []string, opts *options) (*resolvedCommand, error) {
chain := []Commander{root}
chainArgs := [][]string{nil}
branchArgs := make([][]string, 1) // positional args for branching commands
remaining := args
usedFallback := false
for {
idx := len(chain) - 1
current := chain[idx]
subs, err := allSubcommands(current)
if err != nil {
return nil, err
}
if len(subs) == 0 {
break
}
fi := buildFlagIndex(current)
if opts.shortOptionHandling {
remaining = expandShortOptions(remaining, fi)
}
// For branching commands (has both arg fields and subcommands),
// consume required positional args before looking for subcommands.
// Optional args are captured separately to avoid consuming subcommand names.
if isBranchingCommand(current) {
cmdFlags, requiredArgs, rest := scanBranchingLevel(remaining, fi, current)
chainArgs[idx] = cmdFlags
remaining = rest
// Look for subcommand in remaining args. Any non-flag args before
// the subcommand are potential optional args for the branching command.
sub, err := findSubcommandInArgs(remaining, subs, opts.prefixMatching, opts.caseInsensitive)
if err != nil {
return nil, err
}
if sub == nil {
// No subcommand found. All remaining positional args belong to
// this command (required args already captured, rest are optional).
branchArgs[idx] = append(requiredArgs, filterNonFlags(rest)...)
// Check for Fallbacker interface.
if d, ok := current.(Fallbacker); ok {
chain = append(chain, d.Fallback())
chainArgs = append(chainArgs, nil)
branchArgs = append(branchArgs, nil)
usedFallback = true
continue
}
break
}
// Subcommand found. Combine required args with any args before the
// subcommand match (these are optional args for the branching command).
branchArgs[idx] = append(requiredArgs, sub.before...)
chain = append(chain, sub.sub)
chainArgs = append(chainArgs, nil)
branchArgs = append(branchArgs, nil)
remaining = sub.remaining
continue
}
cmdFlags, next, found, err := scanLevel(remaining, fi, subs, opts.prefixMatching, opts.caseInsensitive)
if err != nil {
return nil, err
}
chainArgs[idx] = cmdFlags
if found == nil {
// Check for Fallbacker interface.
if d, ok := current.(Fallbacker); ok {
chain = append(chain, d.Fallback())
chainArgs = append(chainArgs, nil)
branchArgs = append(branchArgs, nil)
usedFallback = true
if next != nil {
remaining = next
}
continue
}
if next != nil {
remaining = next
}
break
}
chain = append(chain, found.sub)
chainArgs = append(chainArgs, nil)
branchArgs = append(branchArgs, nil)
remaining = found.remaining
}
// Separate remaining into leaf flags and positional args.
leafIdx := len(chain) - 1
fi := buildFlagIndex(chain[leafIdx])
if opts.shortOptionHandling {
remaining = expandShortOptions(remaining, fi)
}
leafFlags, positional := separateLeafArgs(remaining, fi)
chainArgs[leafIdx] = append(chainArgs[leafIdx], leafFlags...)
return &resolvedCommand{
chain: chain,
chainArgs: chainArgs,
branchArgs: branchArgs,
positional: positional,
usedFallback: usedFallback,
}, nil
}
type subMatch struct {
sub Commander
before []string // non-flag args before the subcommand (for optional args)
remaining []string // args after the subcommand
}
// scanLevel scans args at the current command level, consuming known flags
// and looking for a subcommand match. Returns consumed flags, unconsumed
// non-flag args, a subMatch if a subcommand was found, and any error.
func scanLevel(args []string, fi flagIndex, subs []Commander, prefixMatch, caseInsensitive bool) ([]string, []string, *subMatch, error) {
var cmdFlags, next []string
for i := 0; i < len(args); i++ {
arg := args[i]
if arg == "--" {
// Preserve "--" in output so it flows to separateLeafArgs,
// which will strip it and treat everything after as positional.
next = append(next, args[i:]...)
return cmdFlags, next, nil, nil
}
if strings.HasPrefix(arg, "-") {
if consumed, ok := tryConsumeFlag(args, i, fi); ok {
cmdFlags = append(cmdFlags, args[i:i+consumed]...)
i += consumed - 1
continue
}
}
if !strings.HasPrefix(arg, "-") {
sub, err := findSubcommand(subs, arg, prefixMatch, caseInsensitive)
if err != nil {
return nil, nil, nil, err
}
if sub != nil {
return cmdFlags, nil, &subMatch{sub: sub, remaining: args[i+1:]}, nil
}
}
next = append(next, arg)
}
return cmdFlags, next, nil, nil
}
// tryConsumeFlag checks if args[i] is a known flag and returns how many
// args it consumes (1 for bool/equals, 2 for value flags). Returns 0, false
// if the flag is not known.
func tryConsumeFlag(args []string, i int, fi flagIndex) (int, bool) {
arg := args[i]
// Handle --flag=value.
if eqIdx := strings.Index(arg, "="); eqIdx > 0 {
name := arg[:eqIdx]
if fi.has(name) {
return 1, true
}
return 0, false
}
if !fi.has(arg) {
return 0, false
}
if fi.isBool(arg) {
return 1, true
}
if i+1 < len(args) {
return 2, true
}
return 1, true
}
// separateLeafArgs splits remaining args into flags belonging to the leaf
// command and positional args.
func separateLeafArgs(args []string, fi flagIndex) ([]string, []string) {
var flags, positional []string
pastDashes := false
for i := 0; i < len(args); i++ {
arg := args[i]
if arg == "--" {
pastDashes = true
continue
}
if pastDashes {
positional = append(positional, arg)
continue
}
if strings.HasPrefix(arg, "-") {
if consumed, ok := tryConsumeFlag(args, i, fi); ok {
flags = append(flags, args[i:i+consumed]...)
i += consumed - 1
continue
}
positional = append(positional, arg)
continue
}
positional = append(positional, arg)
}
return flags, positional
}
func findSubcommand(subs []Commander, name string, prefixMatch, caseInsensitive bool) (Commander, error) {
eq := func(a, b string) bool {
if caseInsensitive {
return strings.EqualFold(a, b)
}
return a == b
}
hasPrefix := func(s, prefix string) bool {
if caseInsensitive {
return len(s) >= len(prefix) && strings.EqualFold(s[:len(prefix)], prefix)
}
return strings.HasPrefix(s, prefix)
}
// Exact match first.
for _, s := range subs {
info := resolveInfo(s)
if eq(info.name, name) {
return s, nil
}
for _, alias := range info.aliases {
if eq(alias, name) {
return s, nil
}
}
}
var match Commander
if !prefixMatch {
return match, nil
}
// Unique prefix match.
var matches []string
for _, s := range subs {
info := resolveInfo(s)
if hasPrefix(info.name, name) {
if match != nil {
matches = append(matches, info.name)
} else {
matches = []string{info.name}
}
match = s
}
for _, alias := range info.aliases {
if hasPrefix(alias, name) {
if match != nil && match != s {
matches = append(matches, alias)
} else if match == nil {
matches = []string{alias}
}
match = s
}
}
}
if len(matches) > 1 {
return nil, fmt.Errorf("%w: %q matches %s", ErrAmbiguousCommand, name, strings.Join(matches, ", "))
}
return match, nil
}
// scanBranchingLevel scans args for a branching command, returning flags,
// positional args for the branch, and remaining args. This consumes positional
// args before we look for subcommands.
func scanBranchingLevel(args []string, fi flagIndex, cmd Commander) ([]string, []string, []string) {
numBranchArgs := countBranchArgs(cmd)
var flags, positional, rest []string
for i := 0; i < len(args); i++ {
arg := args[i]
if arg == "--" {
rest = append(rest, args[i+1:]...)
return flags, positional, rest
}
// Try to consume known flag.
if strings.HasPrefix(arg, "-") {
if consumed, ok := tryConsumeFlag(args, i, fi); ok {
flags = append(flags, args[i:i+consumed]...)
i += consumed - 1
continue
}
}
// Non-flag: is it a branch arg or rest?
if len(positional) < numBranchArgs {
positional = append(positional, arg)
} else {
rest = append(rest, arg)
}
}
return flags, positional, rest
}
// countBranchArgs returns the number of required positional args a command
// expects. Only required args are consumed during routing; optional args are
// handled after subcommand matching to avoid consuming subcommand names.
func countBranchArgs(cmd Commander) int {
defs, err := ScanArgs(cmd)
if err != nil {
return 0
}
count := 0
for i := range defs {
if defs[i].IsSlice {
continue // slice args consume remaining, not counted
}
if !defs[i].Required {
continue // optional args handled after subcommand matching
}
count++
}
return count
}
// findSubcommandInArgs finds the first subcommand match in args.
// Returns the matched subcommand, any non-flag args that appeared before it
// (potential optional args for the parent), remaining args after it, and any error.
func findSubcommandInArgs(args []string, subs []Commander, prefixMatch, caseInsensitive bool) (*subMatch, error) {
var result *subMatch
before := make([]string, 0, len(args))
for i, arg := range args {
if strings.HasPrefix(arg, "-") {
continue
}
sub, err := findSubcommand(subs, arg, prefixMatch, caseInsensitive)
if err != nil {
return nil, err
}
if sub != nil {
result = &subMatch{sub: sub, before: before, remaining: args[i+1:]}
return result, nil
}
before = append(before, arg)
}
return result, nil
}
// filterNonFlags returns only the non-flag args from the input slice.
func filterNonFlags(args []string) []string {
var result []string
for _, arg := range args {
if !strings.HasPrefix(arg, "-") {
result = append(result, arg)
}
}
return result
}
// expandShortOptions expands combined short flags like -abc into -a -b -c.
// All flags except the last must be bool/counter (no-value). The last flag
// can take a value from the next argument.
func expandShortOptions(args []string, fi flagIndex) []string {
var expanded []string
for i := 0; i < len(args); i++ {
arg := args[i]
if arg == "--" {
expanded = append(expanded, args[i:]...)
break
}
// Candidate: starts with single -, not --, more than 2 chars, no =
if len(arg) > 2 && arg[0] == '-' && arg[1] != '-' && !strings.Contains(arg, "=") {
allKnown := true
allBoolExceptLast := true
for j := 1; j < len(arg); j++ {
shortFlag := "-" + string(arg[j])
if !fi.has(shortFlag) {
allKnown = false
break
}
if j < len(arg)-1 && !fi.isBool(shortFlag) {
allBoolExceptLast = false
break
}
}
if allKnown && allBoolExceptLast {
for j := 1; j < len(arg); j++ {
expanded = append(expanded, "-"+string(arg[j]))
}
continue
}
}
expanded = append(expanded, arg)
}
return expanded
}
func execute(ctx context.Context, root Commander, args []string, opts *options) error {
cmdName := resolveInfo(root).name
args = stripProgramName(args, cmdName)
if isCompletionRequest(args) {
RuntimeComplete(ctx, root, args[1:], opts.stdout)
return nil
}
resolved, err := resolveCommand(root, args, opts)
if err != nil {
return err
}
chain := resolved.chain
leaf := chain[len(chain)-1]
if handled, err := handleVersionOrHelp(resolved, chain, leaf, opts); handled {
return err
}
if err := checkSubcommandRequired(leaf); err != nil {
return err
}
ctx, err = runInitializerHooks(ctx, chain)
if err != nil {
return err
}
provided, err := parseFlagChain(resolved, chain, isPassthrough(leaf), opts)
if err != nil {
return err
}
if err := populateBranchArgs(resolved, chain, opts.envVarPrefix); err != nil {
return err
}
originalPositional := resolved.positional
if err := populateLeafArgs(leaf, resolved, opts.envVarPrefix); err != nil {
return err
}
if err := runDefaulterHooks(chain); err != nil {
return err
}
if err := runValidation(leaf, originalPositional); err != nil {
return err
}
ctx = storeArgs(ctx, chain)
ctx, err = injectDependencies(ctx, chain, resolved.positional, opts.bindOpts)
if err != nil {
return err
}
printDeprecationWarnings(chain, provided, opts)
ctx = context.WithValue(ctx, leafKey{}, leaf)
ctx, afterHooks, err := runBeforeHooks(ctx, chain)
if err != nil {
return err
}
runErr := buildRunFunc(leaf)(ctx)
afterErr := runAfterHooks(ctx, afterHooks)
return handleRunResult(runErr, afterErr, leaf, chain, opts)
}
func isCompletionRequest(args []string) bool {
return len(args) > 0 && args[0] == "__complete"
}
func handleVersionOrHelp(resolved *resolvedCommand, chain []Commander, leaf Commander, opts *options) (bool, error) {
if v := findVersioner(chain); v != nil && versionRequested(resolved) {
_, err := fmt.Fprintln(opts.stdout, v.Version())
return true, err
}
if helpRequested(resolved) {
return true, renderHelp(leaf, chain, opts)
}
return false, nil
}
func isPassthrough(leaf Commander) bool {
if pt, ok := leaf.(Passthrougher); ok {
return pt.Passthrough()
}
return false
}
func populateBranchArgs(resolved *resolvedCommand, chain []Commander, envPrefix string) error {
for i, cmd := range chain {
if i < len(resolved.branchArgs) && len(resolved.branchArgs[i]) > 0 {
if _, err := populateArgs(cmd, resolved.branchArgs[i], envPrefix); err != nil {
return err
}
}
}
return nil
}
func populateLeafArgs(leaf Commander, resolved *resolvedCommand, envPrefix string) error {
defs, err := ScanArgs(leaf)
if err != nil {
return err
}
if len(defs) > 0 {
remaining, err := populateArgs(leaf, resolved.positional, envPrefix)
if err != nil {
return err
}
resolved.positional = remaining
}
return nil
}
func injectDependencies(ctx context.Context, chain []Commander, positional []string, bindOpts []bind.Option) (context.Context, error) {
allBindOpts := append([]bind.Option{}, bindOpts...)
allBindOpts = append(allBindOpts, bind.Value(Args(positional)))
ctx = bind.With(ctx, allBindOpts...)
for _, cmd := range chain {
if err := bind.Inject(ctx, cmd); err != nil {
return ctx, err
}
}
return ctx, nil
}
func buildRunFunc(leaf Commander) RunFunc {
fn := RunFunc(leaf.Run)
if m, ok := leaf.(Middlewarer); ok {
fn = applyMiddleware(fn, m.Middleware())
}
return fn
}
func runInitializerHooks(ctx context.Context, chain []Commander) (context.Context, error) {
for _, cmd := range chain {
if init, ok := cmd.(Initializer); ok {
var err error
ctx, err = init.Init(ctx)
if err != nil {
return ctx, err
}
}
}
return ctx, nil
}
func runDefaulterHooks(chain []Commander) error {
for _, cmd := range chain {
if d, ok := cmd.(Defaulter); ok {
if err := d.Default(); err != nil {
return err
}
}
}
return nil
}
func runValidation(leaf Commander, positional []string) error {
if av, ok := leaf.(ArgsValidator); ok {
if err := av.ValidateArgs(positional); err != nil {
return err
}
}
if v, ok := leaf.(Validator); ok {
if err := v.Validate(); err != nil {
return err
}
}
return nil
}
func runBeforeHooks(ctx context.Context, chain []Commander) (context.Context, []Commander, error) {
var afterHooks []Commander
for _, cmd := range chain {
if b, ok := cmd.(Beforer); ok {
var err error
ctx, err = b.Before(ctx)
if err != nil {
_ = runAfterHooks(ctx, afterHooks) //nolint:errcheck // best-effort cleanup
return ctx, nil, err
}
}
if _, ok := cmd.(Afterer); ok {
afterHooks = append(afterHooks, cmd)
}
}
return ctx, afterHooks, nil
}
func handleRunResult(runErr, afterErr error, leaf Commander, chain []Commander, opts *options) error {
if runErr != nil {
if hs := getHelpSignal(runErr); hs != nil {
if hs.full {
_ = renderHelp(leaf, chain, opts) //nolint:errcheck // help render errors are non-fatal
} else {
_ = renderUsage(leaf, chain, opts) //nolint:errcheck // usage render errors are non-fatal
}
return runErr
}
return runErr
}
return afterErr
}
func helpRequested(resolved *resolvedCommand) bool {
// "help" as first positional arg triggers help if it wasn't matched
// as a subcommand (explicit help subcommand or Fallbacker takes priority).
if !resolved.usedFallback && len(resolved.positional) > 0 && resolved.positional[0] == "help" {
return true
}
for _, arg := range resolved.positional {
if arg == "--help" || arg == "-h" {
return true
}
}
for _, flagArgs := range resolved.chainArgs {
for _, arg := range flagArgs {
if arg == "--help" || arg == "-h" {
return true
}
}
}
return false
}
func versionRequested(resolved *resolvedCommand) bool {
for _, arg := range resolved.positional {
if arg == "--version" || arg == "-V" {
return true
}
}
return false
}
func findVersioner(chain []Commander) Versioner {
for _, cmd := range chain {
if v, ok := cmd.(Versioner); ok {
return v
}
}
return nil
}
func parseFlagChain(resolved *resolvedCommand, chain []Commander, leafPassthrough bool, opts *options) ([]map[string]bool, error) {
provided := make([]map[string]bool, len(chain))
for i, cmd := range chain {
parseOpts := opts
if leafPassthrough && i == len(chain)-1 {
copied := *opts
copied.ignoreUnknown = true
parseOpts = &copied
}
cmdArgs := resolved.chainArgs[i]
if len(cmdArgs) == 0 && !hasProcessableFields(cmd) {
continue
}
remaining, prov, parseErr := parseFlags(cmd, cmdArgs, parseOpts)
if parseErr != nil {
if opts.suggest {
if suggestion := suggestFlag(cmd, parseErr); suggestion != "" {
return nil, fmt.Errorf("%w\n\n%s", parseErr, suggestion)
}
}
return nil, parseErr
}
provided[i] = prov
if i == len(chain)-1 {
resolved.positional = append(remaining, resolved.positional...)
}
}
inheritFlags(chain, provided)
// Prompt for missing required flags on the leaf command.
leafIdx := len(chain) - 1
prov, err := promptForFlags(chain[leafIdx], provided[leafIdx], opts)
if err != nil {
return nil, err
}
provided[leafIdx] = prov
for i, cmd := range chain {
if err := ValidateFlags(cmd, provided[i]); err != nil {
return nil, err
}
if err := validateFlagGroups(cmd, provided[i]); err != nil {
return nil, err
}
}
return provided, nil
}
func parseFlags(cmd Commander, args []string, opts *options) ([]string, map[string]bool, error) {
if opts.shortOptionHandling {
fi := buildFlagIndex(cmd)
args = expandShortOptions(args, fi)
}
if p, ok := cmd.(FlagParser); ok {
remaining, err := p.ParseFlags(cmd, args)
return remaining, nil, err
}
if opts.flagParser != nil {
remaining, err := opts.flagParser.ParseFlags(cmd, args)
return remaining, nil, err
}
return defaultParseFlags(cmd, args, opts)
}
func runAfterHooks(ctx context.Context, hooks []Commander) error {
var firstErr error
for i := len(hooks) - 1; i >= 0; i-- {
if a, ok := hooks[i].(Afterer); ok {
if err := a.After(ctx); err != nil && firstErr == nil {
firstErr = err
}
}
}
return firstErr
}
// renderUsage prints a brief usage line to stdout.
func renderUsage(cmd Commander, chain []Commander, opts *options) error {
path := buildCommandPath(chain)
usage := buildUsageLine(cmd, path)
_, err := fmt.Fprintln(opts.stdout, usage)
return err
}
// buildCommandPath returns the full command path (e.g., "myapp cluster list").
func buildCommandPath(chain []Commander) string {
parts := make([]string, 0, len(chain))
for _, cmd := range chain {
parts = append(parts, resolveInfo(cmd).name)
}
return strings.Join(parts, " ")
}
// buildUsageLine constructs a usage line like "Usage: myapp serve [flags] <port>".
func buildUsageLine(cmd Commander, path string) string {
var usage strings.Builder
usage.WriteString("Usage: ")
usage.WriteString(path)
// Add [flags] if the command has any flags.
flags := ScanFlags(cmd)
hasVisibleFlags := false
for i := range flags {
if !flags[i].Hidden {
hasVisibleFlags = true
break
}
}
if hasVisibleFlags {
usage.WriteString(" [flags]")
}
// Add positional args.
args, err := ScanArgs(cmd)
if err != nil {
return usage.String()
}
for i := range args {
switch {
case args[i].Required:
usage.WriteString(" <")
usage.WriteString(args[i].Name)
usage.WriteString(">")
case args[i].IsSlice:
usage.WriteString(" [")
usage.WriteString(args[i].Name)
usage.WriteString("...]")
default:
usage.WriteString(" [")
usage.WriteString(args[i].Name)
usage.WriteString("]")
}
}
// Add [command] if it has subcommands.
if subs, err := allSubcommands(cmd); err == nil && len(subs) > 0 {
hasVisible := false
for _, sub := range subs {
if h, ok := sub.(Hider); !ok || !h.Hidden() {
hasVisible = true
break
}
}
if hasVisible {
usage.WriteString(" [command]")
}
}
return usage.String()
}
func renderHelp(cmd Commander, chain []Commander, opts *options) error {
if h, ok := cmd.(Helper); ok {
_, err := fmt.Fprint(opts.stdout, h.Help())
return err
}
renderer := opts.helpRenderer
if r, ok := cmd.(HelpRenderer); ok {
renderer = r
}
flags := ScanFlags(cmd)
globalFlags := collectGlobalFlags(chain, flags)
// Apply env var prefix for help display.
applyEnvVarPrefix := func(defs []FlagDef) {
if opts.envVarPrefix == "" {
return
}
for i := range defs {
if defs[i].Env == "" {
continue
}
parts := strings.Split(defs[i].Env, ",")
for j := range parts {
parts[j] = opts.envVarPrefix + strings.TrimSpace(parts[j])
}
defs[i].Env = strings.Join(parts, ", ")
}
}
applyEnvVarPrefix(flags)
applyEnvVarPrefix(globalFlags)
if opts.sortedHelp {
sortFlags(flags)
sortFlags(globalFlags)
}
args, err := ScanArgs(cmd)
if err != nil {
return err
}
var text string
if renderer != nil {
text = renderer.RenderHelp(cmd, chain, flags, args, globalFlags)
} else {
text = defaultRenderHelp(cmd, chain, flags, globalFlags, opts.sortedHelp)
}
_, err = fmt.Fprint(opts.stdout, text)
return err
}
// collectGlobalFlags gathers visible flags from parent commands in the chain,
// deduplicating against the leaf command's flags.
func collectGlobalFlags(chain []Commander, leafFlags []FlagDef) []FlagDef {
if len(chain) <= 1 {
return nil
}
seen := make(map[string]bool, len(leafFlags))
for i := range leafFlags {
seen[leafFlags[i].Name] = true
}
var global []FlagDef
for _, parent := range chain[:len(chain)-1] {
parentFlags := ScanFlags(parent)
for i := range parentFlags {
f := &parentFlags[i]
if f.Hidden || seen[f.Name] {
continue
}
seen[f.Name] = true
global = append(global, *f)
}
}
return global
}
func printDeprecationWarnings(chain []Commander, provided []map[string]bool, opts *options) {
for i, cmd := range chain {
if provided[i] != nil {
defs := ScanFlags(cmd)
for j := range defs {
fd := &defs[j]
if fd.Deprecated != "" && provided[i][fd.Name] {
fmt.Fprintf(opts.stderr, "Warning: flag --%s is deprecated: %s\n", fd.Name, fd.Deprecated) //nolint:errcheck // best-effort warning
}
}
}
if d, ok := cmd.(Deprecator); ok {
if msg := d.Deprecated(); msg != "" {
fmt.Fprintf(opts.stderr, "Warning: %q is deprecated: %s\n", resolveInfo(cmd).name, msg) //nolint:errcheck // best-effort warning
}
}
}
}
func suggestFlag(cmd Commander, parseErr error) string {
if s, ok := cmd.(Suggester); ok {
return s.Suggest(parseErr.Error())
}
return suggestFromError(cmd, parseErr)
}
// checkSubcommandRequired returns an error if cmd requires a subcommand but
// none was provided. This is checked after command resolution completes.
func checkSubcommandRequired(cmd Commander) error {
sr, ok := cmd.(SubcommandRequired)
if !ok || !sr.SubcommandRequired() {
return nil
}
subs, err := allSubcommands(cmd)
if err != nil {
return err
}
if len(subs) == 0 {
return nil // no subcommands defined, nothing to require
}
return fmt.Errorf("%w: %s", ErrMissingSubcommand, resolveInfo(cmd).name)
}