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
|
package main
import (
"errors"
"flag"
"fmt"
"github.com/Fuwn/kivia/internal/analyze"
"github.com/Fuwn/kivia/internal/collect"
"github.com/Fuwn/kivia/internal/report"
"os"
"slices"
"strings"
)
type options struct {
Path string
OmitContext bool
MinimumEvaluationLength int
Format string
FailOnViolation bool
Ignore []string
}
func parseOptions(arguments []string) (options, error) {
flagSet := flag.NewFlagSet("kivia", flag.ContinueOnError)
flagSet.SetOutput(os.Stderr)
var parsed options
var ignoreValues stringSliceFlag
flagSet.StringVar(&parsed.Path, "path", "./...", "Path to analyze (directory, file, or ./...).")
flagSet.BoolVar(&parsed.OmitContext, "omit-context", false, "Hide usage context in output.")
flagSet.IntVar(&parsed.MinimumEvaluationLength, "min-eval-length", 1, "Minimum identifier length in runes to evaluate.")
flagSet.StringVar(&parsed.Format, "format", "text", "Output format: text or JSON.")
flagSet.BoolVar(&parsed.FailOnViolation, "fail-on-violation", false, "Exit with code 1 when violations are found.")
flagSet.Var(&ignoreValues, "ignore", "Ignore violations by matcher. Repeat this flag as needed. Prefixes: name=, kind=, file=, reason=, func=.")
if err := flagSet.Parse(arguments); err != nil {
return options{}, err
}
if parsed.MinimumEvaluationLength < 1 {
return options{}, errors.New("The --min-eval-length value must be at least 1.")
}
parsed.Ignore = slices.Clone(ignoreValues)
return parsed, nil
}
func run(parsed options) error {
identifiers, err := collect.FromPath(parsed.Path)
if err != nil {
return err
}
result, err := analyze.Run(identifiers, analyze.Options{
MinEvaluationLength: parsed.MinimumEvaluationLength,
})
if err != nil {
return err
}
result = applyIgnoreFilters(result, parsed.Ignore)
if err := report.Render(os.Stdout, result, parsed.Format, !parsed.OmitContext); err != nil {
return err
}
if parsed.FailOnViolation && len(result.Violations) > 0 {
return exitCodeError(1)
}
return nil
}
func main() {
parsed, err := parseOptions(os.Args[1:])
if err != nil {
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
os.Exit(2)
}
if err := run(parsed); err != nil {
var codeError exitCodeError
if errors.As(err, &codeError) {
os.Exit(int(codeError))
}
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
os.Exit(1)
}
}
type exitCodeError int
func (errorCode exitCodeError) Error() string {
return fmt.Sprintf("Process exited with code %d.", int(errorCode))
}
type stringSliceFlag []string
func (values *stringSliceFlag) String() string {
if values == nil {
return ""
}
return strings.Join(*values, ",")
}
func (values *stringSliceFlag) Set(value string) error {
trimmed := strings.TrimSpace(value)
if trimmed == "" {
return errors.New("Ignore matcher cannot be empty.")
}
*values = append(*values, trimmed)
return nil
}
func applyIgnoreFilters(result analyze.Result, ignoreMatchers []string) analyze.Result {
if len(ignoreMatchers) == 0 || len(result.Violations) == 0 {
return result
}
filteredViolations := make([]analyze.Violation, 0, len(result.Violations))
for _, violation := range result.Violations {
if shouldIgnoreViolation(violation, ignoreMatchers) {
continue
}
filteredViolations = append(filteredViolations, violation)
}
result.Violations = filteredViolations
return result
}
func shouldIgnoreViolation(violation analyze.Violation, ignoreMatchers []string) bool {
for _, matcher := range ignoreMatchers {
if matchesViolation(matcher, violation) {
return true
}
}
return false
}
func matchesViolation(matcher string, violation analyze.Violation) bool {
normalizedMatcher := strings.ToLower(strings.TrimSpace(matcher))
if normalizedMatcher == "" {
return false
}
identifier := violation.Identifier
if strings.HasPrefix(normalizedMatcher, "name=") {
return strings.Contains(strings.ToLower(identifier.Name), strings.TrimPrefix(normalizedMatcher, "name="))
}
if strings.HasPrefix(normalizedMatcher, "kind=") {
return strings.Contains(strings.ToLower(identifier.Kind), strings.TrimPrefix(normalizedMatcher, "kind="))
}
if strings.HasPrefix(normalizedMatcher, "file=") {
return strings.Contains(strings.ToLower(identifier.File), strings.TrimPrefix(normalizedMatcher, "file="))
}
if strings.HasPrefix(normalizedMatcher, "reason=") {
return strings.Contains(strings.ToLower(violation.Reason), strings.TrimPrefix(normalizedMatcher, "reason="))
}
if strings.HasPrefix(normalizedMatcher, "func=") {
return strings.Contains(strings.ToLower(identifier.Context.EnclosingFunction), strings.TrimPrefix(normalizedMatcher, "func="))
}
composite := strings.ToLower(strings.Join([]string{
identifier.Name,
identifier.Kind,
identifier.File,
violation.Reason,
identifier.Context.EnclosingFunction,
}, " "))
return strings.Contains(composite, normalizedMatcher)
}
|