Repository navigation
Expand file tree
/
Copy pathfish.go
More file actions
221 lines (193 loc) · 4.9 KB
/
Copy pathfish.go
File metadata and controls
221 lines (193 loc) · 4.9 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
package cli
import (
"bytes"
"fmt"
"io"
"strings"
"text/template"
)
// ToFishCompletion creates a fish completion string for the `*Command`
// The function errors if either parsing or writing of the string fails.
func (cmd *Command) ToFishCompletion() (string, error) {
var w bytes.Buffer
if err := cmd.writeFishCompletionTemplate(&w); err != nil {
return "", err
}
return w.String(), nil
}
type fishCommandCompletionTemplate struct {
Command *Command
Completions []string
AllCommands []string
}
func (cmd *Command) writeFishCompletionTemplate(w io.Writer) error {
const name = "cli"
t, err := template.New(name).Parse(FishCompletionTemplate)
if err != nil {
return err
}
// Add global flags
completions := prepareFishFlags(cmd.Name, cmd)
if cmd.ShellComplete != nil {
var completion strings.Builder
fmt.Fprintf(&completion,
"complete -c %s -n '%s' -xa '(%s %s 2>/dev/null)'",
cmd.Name,
fishFlagHelper(cmd.Name, cmd),
cmd.Name,
completionFlag,
)
completions = append(completions, completion.String())
}
// Add commands and their flags
completions = append(
completions,
prepareFishCommands(cmd.Name, cmd)...,
)
toplevelCommandNames := []string{}
for _, child := range cmd.Commands {
toplevelCommandNames = append(toplevelCommandNames, child.Names()...)
}
return t.ExecuteTemplate(w, name, &fishCommandCompletionTemplate{
Command: cmd,
Completions: completions,
AllCommands: toplevelCommandNames,
})
}
func prepareFishCommands(binary string, parent *Command) []string {
commands := parent.Commands
completions := []string{}
for _, command := range commands {
if !command.Hidden {
var completion strings.Builder
fmt.Fprintf(&completion,
"complete -x -c %s -n '%s' -a '%s'",
binary,
fishSubcommandHelper(binary, parent, commands),
command.Name,
)
if command.Usage != "" {
fmt.Fprintf(&completion,
" -d '%s'",
escapeSingleQuotes(command.Usage))
}
completions = append(completions, completion.String())
}
if command.ShellComplete != nil {
var completion strings.Builder
var path []string
lineage := command.Lineage()
for i := len(lineage) - 2; i >= 0; i-- {
path = append(path, lineage[i].Name)
}
fmt.Fprintf(&completion,
"complete -c %s -n '%s' -xa '(%s %s %s 2>/dev/null)'",
binary,
fishFlagHelper(binary, command),
binary,
strings.Join(path, " "),
completionFlag,
)
completions = append(completions, completion.String())
}
completions = append(
completions,
prepareFishFlags(binary, command)...,
)
// recursively iterate subcommands
completions = append(
completions,
prepareFishCommands(binary, command)...,
)
}
return completions
}
func prepareFishFlags(binary string, owner *Command) []string {
flags := owner.VisibleFlags()
completions := []string{}
for _, f := range flags {
completion := &strings.Builder{}
fmt.Fprintf(completion,
"complete -c %s -n '%s'",
binary,
fishFlagHelper(binary, owner),
)
fishAddFileFlag(f, completion)
for idx, opt := range f.Names() {
if idx == 0 {
fmt.Fprintf(completion,
" -l %s", strings.TrimSpace(opt),
)
} else {
fmt.Fprintf(completion,
" -s %s", strings.TrimSpace(opt),
)
}
}
if flag, ok := f.(DocGenerationFlag); ok {
if flag.TakesValue() {
completion.WriteString(" -r")
}
if flag.GetUsage() != "" {
fmt.Fprintf(completion,
" -d '%s'",
escapeSingleQuotes(flag.GetUsage()))
}
}
completions = append(completions, completion.String())
}
return completions
}
func fishAddFileFlag(flag Flag, completion *strings.Builder) {
switch f := flag.(type) {
case *StringFlag:
if f.TakesFile {
return
}
case *StringSliceFlag:
if f.TakesFile {
return
}
}
completion.WriteString(" -f")
}
func fishSubcommandHelper(binary string, command *Command, siblings []*Command) string {
fishHelper := fmt.Sprintf("__fish_%s_no_subcommand", binary)
if len(command.Lineage()) > 1 {
var siblingNames []string
for _, sibling := range siblings {
siblingNames = append(siblingNames, sibling.Names()...)
}
ancestry := commandAncestry(command)
fishHelper = fmt.Sprintf(
"%s; and not __fish_seen_subcommand_from %s",
ancestry,
strings.Join(siblingNames, " "),
)
}
return fishHelper
}
func fishFlagHelper(binary string, command *Command) string {
fishHelper := fmt.Sprintf("__fish_%s_no_subcommand", binary)
if len(command.Lineage()) > 1 {
fishHelper = commandAncestry(command)
}
return fishHelper
}
func commandAncestry(command *Command) string {
var ancestry []string
ancestors := command.Lineage()
for i := len(ancestors) - 2; i >= 0; i-- {
ancestry = append(
ancestry,
fmt.Sprintf(
"__fish_seen_subcommand_from %s",
strings.Join(ancestors[i].Names(), " "),
),
)
}
return strings.Join(ancestry, "; and ")
}
func escapeSingleQuotes(input string) string {
return strings.ReplaceAll(input, `'`, `\'`)
}