-
Notifications
You must be signed in to change notification settings - Fork 5
/
parameter_formatter.go
141 lines (121 loc) · 3.68 KB
/
parameter_formatter.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
package commandline
import (
"fmt"
"slices"
"strings"
"github.com/UiPath/uipathcli/parser"
)
type parameterFormatter struct {
parameter parser.Parameter
}
func (f parameterFormatter) Description() string {
return f.description(f.parameter)
}
func (f parameterFormatter) UsageExample() string {
return f.usageExample(f.parameter)
}
func (f parameterFormatter) description(parameter parser.Parameter) string {
builder := strings.Builder{}
builder.WriteString(f.humanReadableType(parameter.Type))
fields := f.descriptionFields(parameter)
if len(fields) > 0 {
builder.WriteString(" (")
builder.WriteString(f.commaSeparatedValues(fields))
builder.WriteString(")")
}
if parameter.Description != "" {
builder.WriteString("\n")
builder.WriteString(parameter.Description)
}
if len(parameter.AllowedValues) > 0 {
f.writeSeparator(&builder, "\n\n")
builder.WriteString("Allowed values:")
for _, value := range parameter.AllowedValues {
builder.WriteString(fmt.Sprintf("\n- %v", value))
}
}
example := f.usageExample(parameter)
if example != "" {
f.writeSeparator(&builder, "\n\n")
builder.WriteString("Example:\n")
builder.WriteString(" " + example)
}
return builder.String()
}
func (f parameterFormatter) descriptionFields(parameter parser.Parameter) []interface{} {
fields := []interface{}{}
if parameter.Required && parameter.DefaultValue == nil {
fields = append(fields, "required")
}
if parameter.DefaultValue != nil {
fields = append(fields, fmt.Sprintf("default: %v", parameter.DefaultValue))
}
return fields
}
func (f parameterFormatter) usageExample(parameter parser.Parameter) string {
parameters := f.collectUsageParameters(parameter, "")
slices.Sort(parameters)
builder := strings.Builder{}
for _, value := range parameters {
f.writeSeparator(&builder, "; ")
builder.WriteString(value)
}
return builder.String()
}
func (f parameterFormatter) collectUsageParameters(parameter parser.Parameter, prefix string) []string {
result := []string{}
for _, p := range parameter.Parameters {
if p.Type == parser.ParameterTypeObjectArray {
result = append(result, f.collectUsageParameters(p, prefix+p.FieldName+"[0].")...)
} else if p.Type == parser.ParameterTypeObject {
result = append(result, f.collectUsageParameters(p, prefix+p.FieldName+".")...)
} else {
field := prefix + p.FieldName
fieldType := f.humanReadableType(p.Type)
result = append(result, fmt.Sprintf("%s=%s", field, fieldType))
}
}
return result
}
func (f parameterFormatter) commaSeparatedValues(values []interface{}) string {
builder := strings.Builder{}
for _, value := range values {
f.writeSeparator(&builder, ", ")
builder.WriteString(fmt.Sprintf("%v", value))
}
return builder.String()
}
func (f parameterFormatter) writeSeparator(builder *strings.Builder, separator string) {
if builder.Len() > 0 {
builder.WriteString(separator)
}
}
func (f parameterFormatter) humanReadableType(_type string) string {
switch _type {
case parser.ParameterTypeString:
return "string"
case parser.ParameterTypeBinary:
return "binary"
case parser.ParameterTypeInteger:
return "integer"
case parser.ParameterTypeNumber:
return "float"
case parser.ParameterTypeBoolean:
return "boolean"
case parser.ParameterTypeStringArray:
return "string,string,..."
case parser.ParameterTypeIntegerArray:
return "integer,integer,..."
case parser.ParameterTypeNumberArray:
return "float,float,..."
case parser.ParameterTypeBooleanArray:
return "boolean,boolean,..."
case parser.ParameterTypeObjectArray:
return "object (multiple)"
default:
return "object"
}
}
func newParameterFormatter(parameter parser.Parameter) *parameterFormatter {
return ¶meterFormatter{parameter}
}