forked from matoous/godox
-
Notifications
You must be signed in to change notification settings - Fork 0
/
godox.go
193 lines (155 loc) · 3.98 KB
/
godox.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
package godox
import (
"bufio"
"bytes"
"fmt"
"go/ast"
"go/token"
"path/filepath"
"regexp"
"strings"
"unicode"
"unicode/utf8"
"github.com/matoous/godox/config"
)
var defaultKeywords = []string{"TODO", "BUG", "FIXME"}
// Message contains a message and position.
type Message struct {
Pos token.Position
Message string
}
func getMessages(comment *ast.Comment, fset *token.FileSet, keywords []string) []Message {
commentText := extractComment(comment.Text)
b := bufio.NewReader(bytes.NewBufferString(commentText))
var comments []Message
for lineNum := 0; ; lineNum++ {
line, _, err := b.ReadLine()
if err != nil {
break
}
const minimumSize = 4
sComment := bytes.TrimSpace(line)
if len(sComment) < minimumSize {
continue
}
for _, kw := range keywords {
if lkw := len(kw); !(bytes.EqualFold([]byte(kw), sComment[0:lkw]) &&
!hasAlphanumRuneAdjacent(sComment[lkw:])) {
continue
}
pos := fset.Position(comment.Pos())
// trim the comment
const commentLimit = 40
if len(sComment) > commentLimit {
sComment = []byte(fmt.Sprintf("%.40s...", sComment))
}
comments = append(comments, Message{
Pos: pos,
Message: fmt.Sprintf(
"%s:%d: Line contains %s: %q",
filepath.Clean(pos.Filename),
pos.Line+lineNum,
strings.Join(keywords, "/"),
sComment,
),
})
break
}
}
return comments
}
func getMessagesFormat(comment *ast.Comment, fset *token.FileSet, formatRules []config.GoDoxFormatRule) []Message {
commentText := extractComment(comment.Text)
b := bufio.NewReader(bytes.NewBufferString(commentText))
var comments []Message
for lineNum := 0; ; lineNum++ {
line, _, err := b.ReadLine()
if err != nil {
break
}
const minimumSize = 4
sComment := bytes.TrimSpace(line)
if len(sComment) < minimumSize {
continue
}
for _, formatRule := range formatRules {
kw := formatRule.Keyword
formatPattern := formatRule.RegularExpression
if lkw := len(kw); !(bytes.EqualFold([]byte(kw), sComment[0:lkw]) &&
!hasAlphanumRuneAdjacent(sComment[lkw:])) {
continue
}
// check the format
if formatPattern != "" && isFormatted(formatPattern, string(sComment)) {
continue
}
pos := fset.Position(comment.Pos())
// trim the comment
const commentLimit = 40
if len(sComment) > commentLimit {
sComment = []byte(fmt.Sprintf("%.40s...", sComment))
}
comments = append(comments, Message{
Pos: pos,
Message: fmt.Sprintf(
"%s:%d: Line does not match the expected format: %s, %q",
filepath.Clean(pos.Filename),
pos.Line+lineNum,
formatPattern,
sComment,
),
})
break
}
}
return comments
}
func isFormatted(regularExpression, input string) bool {
regex := regexp.MustCompile(regularExpression)
if regex.MatchString(input) {
return true
} else {
return false
}
}
func extractComment(commentText string) string {
switch commentText[1] {
case '/':
commentText = commentText[2:]
if len(commentText) > 0 && commentText[0] == ' ' {
commentText = commentText[1:]
}
case '*':
commentText = commentText[2 : len(commentText)-2]
}
return commentText
}
func hasAlphanumRuneAdjacent(rest []byte) bool {
if len(rest) == 0 {
return false
}
switch rest[0] { // most common cases
case ':', ' ', '(':
return false
}
r, _ := utf8.DecodeRune(rest)
return unicode.IsLetter(r) || unicode.IsNumber(r) || unicode.IsDigit(r)
}
// Run runs the godox linter on given file.
// Godox searches for comments starting with given keywords and reports them.
func Run(file *ast.File, fset *token.FileSet, settings *config.GoDoxSettings) []Message {
var messages []Message
if len(settings.Keywords) == 0 {
settings.Keywords = defaultKeywords
}
for _, c := range file.Comments {
for _, ci := range c.List {
if settings.Format {
messages = append(messages, getMessagesFormat(ci, fset, settings.FormatRules)...)
} else {
messages = append(messages, getMessages(ci, fset, settings.Keywords)...)
}
}
}
return messages
}