forked from uber/prototool
/
check_enum_fields_have_comments.go
59 lines (51 loc) · 2.22 KB
/
check_enum_fields_have_comments.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
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package lint
import (
"github.com/emicklei/proto"
"github.com/b1ackhuang/prototool/internal/text"
)
var enumFieldsHaveCommentsLinter = NewLinter(
"ENUM_FIELDS_HAVE_COMMENTS",
`Verifies that all enum fields have a comment of the form "// FIELD_NAME ...".`,
checkEnumFieldsHaveComments,
)
func checkEnumFieldsHaveComments(add func(*text.Failure), dirPath string, descriptors []*FileDescriptor) error {
return runVisitor(enumFieldsHaveCommentsVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
}
type enumFieldsHaveCommentsVisitor struct {
baseAddVisitor
}
func (v enumFieldsHaveCommentsVisitor) VisitMessage(message *proto.Message) {
// for nested enums
for _, child := range message.Elements {
child.Accept(v)
}
}
func (v enumFieldsHaveCommentsVisitor) VisitEnum(enum *proto.Enum) {
for _, child := range enum.Elements {
child.Accept(v)
}
}
func (v enumFieldsHaveCommentsVisitor) VisitEnumField(enumField *proto.EnumField) {
if !hasGolangStyleComment(enumField.Comment, enumField.Name) {
v.AddFailuref(enumField.Position, `Enum field %q needs a comment of the form "// %s ..."`, enumField.Name, enumField.Name)
}
}