-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
help_test.go
252 lines (235 loc) · 4.57 KB
/
help_test.go
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
package help_test
import (
"fmt"
Z "github.com/rwxrob/bonzai/z"
"github.com/rwxrob/help"
"github.com/rwxrob/term"
)
func ExampleCmd_name() {
term.AttrOff()
x := &Z.Cmd{
Name: "foo",
}
help.ForTerminal(x, "name")
// Output:
// foo
}
func ExampleCmd_summary() {
term.AttrOff()
x := &Z.Cmd{
Summary: `foo all the things`,
}
help.ForTerminal(x, "summary")
// Output:
// foo all the things
}
func ExampleCmd_other() {
term.AttrOff()
x := &Z.Cmd{
Other: []Z.Section{{"foo", `some foo text`}},
}
help.ForTerminal(x, "foo")
// Output:
// some foo text
}
func ExampleCmd_all_Error_No_Call_No_Commands() {
term.AttrOff()
x := &Z.Cmd{
Name: `foo`,
Version: "v0.1.0",
}
help.ForTerminal(x, "all")
// Output:
// NAME
// foo
//
// SYNOPSIS
// {ERROR: neither Call nor Commands defined}
}
func ExampleCmd_all_Error_Params_No_Call() {
term.AttrOff()
x := &Z.Cmd{
Name: `foo`,
Params: []string{"p1", "p2"},
}
help.ForTerminal(x, "all")
// Output:
// NAME
// foo
//
// SYNOPSIS
// {ERROR: Params without Call: p1, p2}
}
func ExampleCmd_all_Call_No_Params() {
term.AttrOff()
x := &Z.Cmd{
Name: `foo`,
Call: func(_ *Z.Cmd, _ ...string) error { return nil },
}
help.ForTerminal(x, "all")
// Output:
// NAME
// foo
//
// SYNOPSIS
// foo
}
func ExampleCmd_all_Call_With_Optional_Params() {
term.AttrOff()
x := &Z.Cmd{
Name: `foo`,
Params: []string{"p1", "p2"},
Call: func(_ *Z.Cmd, _ ...string) error { return nil },
}
help.ForTerminal(x, "all")
// Output:
// NAME
// foo
//
// SYNOPSIS
// foo (p1|p2)?
}
func ExampleCmd_all_Call_With_Optional_Params_and_Commands() {
term.AttrOff()
x := &Z.Cmd{
Name: `cmd`,
Params: []string{"p1", "p2"},
Commands: []*Z.Cmd{
&Z.Cmd{
Name: "foo",
Aliases: []string{"f"},
Summary: "foo the things",
},
&Z.Cmd{
Name: "bar",
Summary: "bar the things",
},
&Z.Cmd{
Name: "nosum",
},
},
Call: func(_ *Z.Cmd, _ ...string) error { return nil },
}
help.ForTerminal(x, "all")
// Output:
// NAME
// cmd
//
// SYNOPSIS
// cmd (COMMAND|(p1|p2)?)
//
// COMMANDS
// f|foo - foo the things
// bar - bar the things
// nosum
}
func ExampleCmd_all_Legal_Copyright_Only() {
term.AttrOff()
x := &Z.Cmd{
Name: `cmd`,
Copyright: "Copyright @2022 Rob",
Call: func(_ *Z.Cmd, _ ...string) error { return nil },
}
help.ForTerminal(x, "all")
// Output:
// NAME
// cmd
//
// SYNOPSIS
// cmd
//
// LEGAL
// cmd Copyright @2022 Rob
}
func ExampleCmd_all_Legal_Copyright_and_Version() {
term.AttrOff()
x := &Z.Cmd{
Name: `cmd`,
Copyright: "Copyright @2022 Rob",
Version: "v0.0.1",
Call: func(_ *Z.Cmd, _ ...string) error { return nil },
}
help.ForTerminal(x, "all")
// Output:
// NAME
// cmd
//
// SYNOPSIS
// cmd
//
// LEGAL
// cmd (v0.0.1) Copyright @2022 Rob
}
func ExampleCmd_all_Legal_Copyright_and_Version_and_License() {
term.AttrOff()
x := &Z.Cmd{
Name: `cmd`,
Copyright: "Copyright @2022 Rob",
Version: "v0.0.1",
License: "Apache 2.0",
Call: func(_ *Z.Cmd, _ ...string) error { return nil },
}
help.ForTerminal(x, "all")
// Output:
// NAME
// cmd
//
// SYNOPSIS
// cmd
//
// LEGAL
// cmd (v0.0.1) Copyright @2022 Rob
// License Apache 2.0
}
func ExampleCmd_all_Other() {
term.AttrOff()
x := &Z.Cmd{
Name: `cmd`,
Call: func(_ *Z.Cmd, _ ...string) error { return nil },
Other: []Z.Section{
{"FOO", "A whole section dedicated to foo."},
{"bar", "WTF is a bar anyway"},
},
}
help.ForTerminal(x, "all")
// Output:
// NAME
// cmd
//
// SYNOPSIS
// cmd
//
// FOO
// A whole section dedicated to foo.
//
// BAR
// WTF is a bar anyway
}
func ExampleS() {
text1 := "here is the summary\n"
text2 := "here is the summary\r"
text3 := "here is the summary"
text4 := "here is the summary\nanother line"
fmt.Println(help.S(text1))
fmt.Println(help.S(text2))
fmt.Println(help.S(text3))
fmt.Println(help.S(text4))
// Output:
// here is the summary
// here is the summary
// here is the summary
// here is the summary
}
func ExampleD() {
text1 := "here is the summary\n\nFirst line of D"
text2 := "here is the summary\r\n\r\nFirst line of D"
text3 := "here is the summary\n\nFirst line of D\nSecond line of D"
fmt.Print(help.D(text1))
fmt.Print(help.D(text2))
fmt.Print(help.D(text3))
// Output:
// First line of D
// First line of D
// First line of D
// Second line of D
}