-
-
Notifications
You must be signed in to change notification settings - Fork 10
/
flags.go
150 lines (127 loc) · 4.5 KB
/
flags.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
// SPDX-License-Identifier: Apache-2.0
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package utils
// Globals
var GlobalFlags CommandFlags
type CommandFlags struct {
// Not flags, but "main" package var copies
Project string
Binary string
Version string
WorkingDir string
ExecDir string
// Configurations
ConfigSchemaFile string
ConfigCustomValidationFile string
ConfigLicensePolicyFile string
// persistent flags (common to all commands)
PersistentFlags PersistentCommandFlags
// Command-specific flags
ComponentFlags ComponentCommandFlags
CustomValidationOptions CustomValidationFlags
DiffFlags DiffCommandFlags
LicenseFlags LicenseCommandFlags
PatchFlags PatchCommandFlags
ResourceFlags ResourceCommandFlags
SchemaFlags SchemaCommandFlags
StatsFlags StatsCommandFlags
TrimFlags TrimCommandFlags
ValidateFlags ValidateCommandFlags
VulnerabilityFlags VulnerabilityCommandFlags
// Misc flags
LogOutputIndentCallstack bool // Log indent
}
// NOTE: These flags are shared by both the list and policy subcommands
type PersistentCommandFlags struct {
Quiet bool // suppresses all non-essential (informational) output from a command. Overrides any other log-level commands.
Trace bool // trace logging
Debug bool // debug logging
InputFile string
OutputFile string // TODO: TODO: Note: not used by `validate` command, which emits a warning if supplied
OutputFormat string // e.g., "txt", "csv"", "md" (markdown) (normalized to lowercase)
OutputIndent uint8
OutputNormalize bool
}
func (persistentFlags PersistentCommandFlags) GetOutputIndentInt() int {
return int(persistentFlags.OutputIndent)
}
// Common flags for all "list" (report) commands (e.g., license list, vulnerability list, etc.)
type ReportCommandFlags struct {
Summary bool
ListLineWrap bool // NOTE: SHOULD ONLY be used for "text" output; currently only used by "license policy" command.
}
type LicenseCommandFlags struct {
ReportCommandFlags
}
type ValidateCommandFlags struct {
SchemaVariant string
ForcedJsonSchemaFile string
CustomValidation bool // Uses custom validation flags if "true"; defaults to config. "custom.json"
// validation error result (output) processing
MaxNumErrors int
MaxErrorDescriptionLength int
ColorizeErrorOutput bool
ShowErrorValue bool
}
type VulnerabilityCommandFlags struct {
ReportCommandFlags
}
type DiffCommandFlags struct {
Colorize bool
RevisedFile string
}
type ResourceCommandFlags struct {
ReportCommandFlags // NOTE: currently unused; as # columns grows, please implement
ResourceType string
}
type ComponentCommandFlags struct {
ReportCommandFlags
Types []string
}
func NewResourceCommandFlags(resourceType string) ResourceCommandFlags {
return ResourceCommandFlags{
ResourceType: resourceType,
}
}
type SchemaCommandFlags struct {
ReportCommandFlags // NOTE: currently unused; as # columns grows, please implement
}
// TODO: unused/unimplemented
type StatsCommandFlags struct {
}
// TODO: write a "parse" method for the struct (i.e., from "raw" to slice)
type TrimCommandFlags struct {
RawKeys string
RawPaths string
Keys []string
FromPaths []string
}
type PatchCommandFlags struct {
PatchFile string
OutputFormat string // NOTE: needed to overcome Cobra limitation when diff. commands have diff. default values
}
type CustomValidationFlags struct {
Composition bool
License bool
Properties bool
}
// format and output the MyFlags struct as a string using Go's Stringer interface
func (flags *CommandFlags) String() string {
buffer, _ := EncodeAnyToDefaultIndentedJSONStr(flags)
return buffer.String()
}