-
Notifications
You must be signed in to change notification settings - Fork 0
/
usageBuilder.go
85 lines (69 loc) · 2.32 KB
/
usageBuilder.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
package fluit
import (
"fmt"
)
// Arguments's padding length
// Argument are formated to be surrounded by padding:
//
// [padding][Argument][padding]
var ArgumentPaddingLength int = 2
// Default argument length
const DefaultArgumentRowLength int = 20
type Option struct {
// Text displayed on argument row.
// These following list are valid:
// "-l"
// "--version"
// "-s, --size"
// "-w, --width=COLS"
Argument string
// Text displayed on description row
Description string
}
type Usages struct {
UsageGroup []Option
// SetArgumentColumnLength() sets a constant width to argument collumn that is not
// relative to the largest args length.
//
// This is useful --if-you-have-a-longer-than-usual-flag. And don't want
// it to affect the argument collumn size.
//
// By default, if the argument len is larger than the specified
// l, it will have its own line.
ArgumentRowLength int
}
// AddUsage() adds usage to *u.
func (u *Usages) AddOption(argument, description string) {
u.UsageGroup = append(u.UsageGroup, Option{argument, description})
}
// PrintUsages() prints all the added usages to console.
func (u *Usages) PrintUsages() {
argumentRowLength := DefaultArgumentRowLength
if u.ArgumentRowLength > 0 {
argumentRowLength = u.ArgumentRowLength
}
for _, usage := range u.UsageGroup {
fmt.Print(SprintUsage(argumentRowLength, usage.Argument, usage.Description))
}
}
// SprintUsage() build a usage and return it as string. If the length of
// argument is larger than maxArgumentLength, argument will have its own line.
// Intended for testing only.
//
// For building usages en mass. You should use type and method Usages instead.
func SprintUsage(maxArgumentLength int, argument, description string) string {
bp := DefaultBreakpoint
if UserBreakpoint > 0 {
bp = UserBreakpoint
}
if maxArgumentLength < 10 || maxArgumentLength >= bp {
maxArgumentLength = 0
}
argumentRowLength := maxArgumentLength + (ArgumentPaddingLength * 2)
formatedDescription := Wrap(argumentRowLength, description)
if len(argument) > maxArgumentLength {
return Wrap(ArgumentPaddingLength, argument) + "\n" + formatedDescription + "\n"
}
formatedArgument := fmt.Sprintf("%*s%-*s", ArgumentPaddingLength, "", maxArgumentLength+ArgumentPaddingLength, argument)
return formatedArgument + formatedDescription[argumentRowLength:] + "\n"
}