-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathmain.go
391 lines (345 loc) · 9.48 KB
/
main.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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
package main
import (
"bufio"
"encoding/json"
"fmt"
"os"
"path/filepath"
"regexp"
"runtime"
"strings"
"sync"
"github.com/apex/log"
"github.com/apex/log/handlers/cli"
"github.com/cloudflare/ahocorasick"
"github.com/fatih/color"
"github.com/remeh/sizedwaitgroup"
kingpin "gopkg.in/alecthomas/kingpin.v2"
)
// a matcher contains the regex for comment tags we are looking for
type matcher struct {
Regex string
Label string
Tag string
}
// Result holds data for all matches found in a file
type Result struct {
Filename string `json:"filename"`
Matches []match `json:"matches"`
}
// a match contains data for each comment tag found in a file
type match struct {
LineNumber int `json:"lineNumber"`
Tag string `json:"tag"`
Label string `json:"label"`
Author string `json:"author"`
Message string `json:"message"`
}
var (
version string
skipHidden *bool
jsonOutput *bool
includeVendor *bool
ignoreDirs *[]string
ignoreExts *[]string
lineLengthLimit *int
outputMux sync.Mutex
matchers []matcher
tagMatcher *ahocorasick.Matcher
)
func main() {
app := kingpin.New("fixme", "Searches for comment tags in code")
filePath := app.Arg("file", "the file or directory to scan (default=current directory)").String()
jsonOutput = app.Flag("json", "output in JSON (default=false)").Short('j').Default("false").PlaceHolder("false").Bool()
skipHidden = app.Flag("skip-hidden", "skip hidden folders (default=true)").Default("true").PlaceHolder("true").Bool()
includeVendor = app.Flag("include-vendor", "include vendor directory (default=false)").Default("false").PlaceHolder("false").Bool()
ignoreDirs = app.Flag("ignore-dir", "pattern of directories to ignore").Short('i').Default("vendor").Strings()
ignoreExts = app.Flag("ignore-exts", "pattern of file extensions to ignore").PlaceHolder(".txt").Strings()
lineLengthLimit = app.Flag("line-length-limit", "number of max characters in a line").Default("1000").Int()
logLvl := app.Flag("log-level", "log level (debug|info|error)").Short('l').Default("error").Enum("debug", "info", "error")
app.Version(version).VersionFlag.Short('V')
app.HelpFlag.Short('h')
app.UsageTemplate(kingpin.SeparateOptionalFlagsUsageTemplate)
kingpin.MustParse(app.Parse(os.Args[1:]))
log.SetHandler(cli.New(os.Stdout))
log.SetLevelFromString(*logLvl)
// set up the regex values
matchers = initMatchers()
tagMatcher = ahocorasick.NewStringMatcher([]string{"NOTE", "OPTIMIZE", "TODO", "HACK", "XXX", "FIXME", "BUG"})
// if the user doesn't specify a directory assume the current directory
if *filePath == "" {
*filePath = "."
}
// since the vendor directory is ignored by default,
// ensure we remove the vendor directory from the list of ignored directories if the user wants it included
if *includeVendor {
for i, v := range *ignoreDirs {
if v == "vendor" {
*ignoreDirs = append((*ignoreDirs)[:i], (*ignoreDirs)[i+1:]...)
break
}
}
}
// get the files from the path the user specified
cleanPath, err := filepath.Abs(*filePath)
if err != nil {
log.WithError(err).Fatal("Error identifying files")
}
fileList := getFiles(cleanPath)
results := make([]Result, len(fileList))
wg := sizedwaitgroup.New(runtime.NumCPU())
for i, file := range fileList {
wg.Add()
go func(file string, i int) {
defer wg.Done()
// scan for comment tags within the file
result, err := processFile(file)
if err != nil {
log.WithError(err).Errorf("Error processing %s", file)
}
results[i] = result
}(file, i)
}
wg.Wait()
if *jsonOutput {
// acquire a lock to ensure our output is stable
outputMux.Lock()
defer outputMux.Unlock()
for _, result := range results {
if result.Matches == nil {
continue
}
if b, marshalErr := json.MarshalIndent(result, "", " "); marshalErr == nil {
fmt.Println(string(b))
}
}
} else {
for _, result := range results {
// print results from the file
printMatches(result)
}
}
}
func printMatches(result Result) {
// acquire a lock to ensure our output is stable
outputMux.Lock()
defer outputMux.Unlock()
numOfMatches := len(result.Matches)
if numOfMatches == 0 {
return
}
color.Set(color.FgHiWhite, color.Bold)
fmt.Printf("• %s ", result.Filename)
color.Unset()
color.Set(color.Faint)
if numOfMatches == 1 {
fmt.Printf("[%d message]:\n", numOfMatches)
} else {
fmt.Printf("[%d messages]:\n", numOfMatches)
}
color.Unset()
for _, m := range result.Matches {
color.Set(color.Faint)
fmt.Printf(" [Line %d]\t", m.LineNumber)
color.Unset()
switch m.Tag {
case "NOTE":
color.Set(color.Bold, color.FgHiGreen)
if len(m.Author) > 0 {
fmt.Printf(" %s from %s:", m.Label, m.Author)
} else {
fmt.Printf(" %s:", m.Label)
}
color.Unset()
color.Set(color.FgGreen)
fmt.Printf(" %s\n", m.Message)
color.Unset()
case "OPTIMIZE":
color.Set(color.Bold, color.FgHiBlue)
if len(m.Author) > 0 {
fmt.Printf(" %s from %s:", m.Label, m.Author)
} else {
fmt.Printf(" %s:", m.Label)
}
color.Unset()
color.Set(color.FgBlue)
fmt.Printf(" %s\n", m.Message)
color.Unset()
case "TODO":
color.Set(color.Bold, color.FgHiMagenta)
if len(m.Author) > 0 {
fmt.Printf(" %s from %s:", m.Label, m.Author)
} else {
fmt.Printf(" %s:", m.Label)
}
color.Unset()
color.Set(color.FgHiMagenta)
fmt.Printf(" %s\n", m.Message)
color.Unset()
case "HACK":
color.Set(color.Bold, color.FgHiYellow)
if len(m.Author) > 0 {
fmt.Printf(" %s from %s:", m.Label, m.Author)
} else {
fmt.Printf(" %s:", m.Label)
}
color.Unset()
color.Set(color.FgYellow)
fmt.Printf(" %s\n", m.Message)
color.Unset()
case "XXX":
color.Set(color.Bold, color.FgHiCyan)
if len(m.Author) > 0 {
fmt.Printf(" %s from %s:", m.Label, m.Author)
} else {
fmt.Printf(" %s:", m.Label)
}
color.Unset()
color.Set(color.FgCyan)
fmt.Printf(" %s\n", m.Message)
color.Unset()
case "FIXME":
color.Set(color.Bold, color.FgHiRed)
if len(m.Author) > 0 {
fmt.Printf(" %s from %s:", m.Label, m.Author)
} else {
fmt.Printf(" %s:", m.Label)
}
color.Unset()
color.Set(color.FgRed)
fmt.Printf(" %s\n", m.Message)
color.Unset()
case "BUG":
fmt.Print(" ")
color.Set(color.Bold, color.FgWhite, color.BgRed)
if len(m.Author) > 0 {
fmt.Printf("%s from %s:", m.Label, m.Author)
} else {
fmt.Printf("%s:", m.Label)
}
color.Unset()
fmt.Print(" ")
color.Set(color.FgRed)
fmt.Printf("%s\n", m.Message)
color.Unset()
fmt.Println()
}
}
fmt.Println()
}
func processFile(file string) (Result, error) {
var result Result
result.Filename = file
log.Debug("Processing " + file)
f, err := os.Open(file)
if err != nil {
return result, err
}
scanner := bufio.NewScanner(f)
lineNumber := 0
for scanner.Scan() {
line := scanner.Text()
lineNumber++
// skip if the line is too long
if len(line) > *lineLengthLimit {
continue
}
// check the line with the MPM before running against regular expressions
hits := tagMatcher.Match([]byte(line))
if len(hits) == 0 {
continue
}
// check the line against the regexes
for _, m := range matchers {
re := regexp.MustCompile(m.Regex)
if re.MatchString(line) {
// skip tags with an empty message
if len(re.FindStringSubmatch(line)[2]) == 0 {
continue
}
result.Matches = append(result.Matches, match{lineNumber, m.Tag, m.Label, re.FindStringSubmatch(line)[1], re.FindStringSubmatch(line)[2]})
}
}
}
return result, nil
}
// getFiles returns a list of the files to be processed
func getFiles(filePath string) []string {
fileList := []string{}
err := filepath.Walk(filePath, func(path string, f os.FileInfo, err error) error {
// catch any errors while walking the filepath
if err != nil {
return err
}
// skip hidden directories if the user requests it
if *skipHidden {
if f.IsDir() && strings.HasPrefix(f.Name(), ".") {
return filepath.SkipDir
}
}
// skip any directories the user wants to ignore
if len(*ignoreDirs) > 0 {
for _, dir := range *ignoreDirs {
if f.IsDir() && strings.HasPrefix(f.Name(), dir) {
return filepath.SkipDir
}
}
}
// skip any files with an extension the user wants to ignore
if len(*ignoreExts) > 0 {
for _, ext := range *ignoreExts {
if !f.IsDir() && strings.HasSuffix(f.Name(), ext) {
return filepath.SkipDir
}
}
}
if !f.IsDir() {
fileList = append(fileList, path)
log.Debug("found file: " + path)
}
return nil
})
if err != nil {
log.WithError(err).Fatal("failed getting file names")
}
return fileList
}
func initMatchers() []matcher {
return []matcher{
{
Regex: `(?i)(?:[\/\/][\/\*]|#|%)\s*NOTE\b\s*(?:\(([^:]*)\))*\s*:?\s*(.*)`,
Label: ` ✐ NOTE`,
Tag: "NOTE",
},
{
Regex: `(?i)(?:[\/\/][\/\*]|#|%)\s*OPTIMIZE\b\s*(?:\(([^:]*)\))*\s*:?\s*(.*)`,
Label: ` ↻ OPTIMIZE`,
Tag: "OPTIMIZE",
},
{
Regex: `(?i)(?:[\/\/][\/\*]|#|%)\s*TODO\b\s*(?:\(([^:]*)\))*\s*:?\s*(.*)`,
Label: ` ✓ TODO`,
Tag: "TODO",
},
{
Regex: `(?i)(?:[\/\/][\/\*]|#|%)\s*HACK\b\s*(?:\(([^:]*)\))*\s*:?\s*(.*)`,
Label: ` ✄ HACK`,
Tag: "HACK",
},
{
Regex: `(?i)(?:[\/\/][\/\*]|#|%)\s*XXX\b\s*(?:\(([^:]*)\))*\s*:?\s*(.*)`,
Label: ` ✗ XXX`,
Tag: "XXX",
},
{
Regex: `(?i)(?:[\/\/][\/\*]|#|%)\s*FIXME\b\s*(?:\(([^:]*)\))*\s*:?\s*(.*)`,
Label: ` ☠ FIXME`,
Tag: "FIXME",
},
{
Regex: `(?i)(?:[\/\/][\/\*]|#|%)\s*BUG\b\s*(?:\(([^:]*)\))*\s*:?\s*(.*)`,
Label: `☢ BUG`,
Tag: "BUG",
},
}
}