forked from uber/prototool
-
Notifications
You must be signed in to change notification settings - Fork 0
/
check_enum_field_names_upper_snake_case.go
59 lines (51 loc) · 2.21 KB
/
check_enum_field_names_upper_snake_case.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) 2018 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/uber/prototool/internal/strs"
"github.com/uber/prototool/internal/text"
)
var enumFieldNamesUpperSnakeCaseLinter = NewLinter(
"ENUM_FIELD_NAMES_UPPER_SNAKE_CASE",
"Verifies that all enum field names are UPPER_SNAKE_CASE.",
checkEnumFieldNamesUpperSnakeCase,
)
func checkEnumFieldNamesUpperSnakeCase(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
return runVisitor(enumFieldNamesUpperSnakeCaseVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
}
type enumFieldNamesUpperSnakeCaseVisitor struct {
baseAddVisitor
}
func (v enumFieldNamesUpperSnakeCaseVisitor) VisitMessage(message *proto.Message) {
for _, element := range message.Elements {
element.Accept(v)
}
}
func (v enumFieldNamesUpperSnakeCaseVisitor) VisitEnum(enum *proto.Enum) {
for _, element := range enum.Elements {
element.Accept(v)
}
}
func (v enumFieldNamesUpperSnakeCaseVisitor) VisitEnumField(field *proto.EnumField) {
if !strs.IsUpperSnakeCase(field.Name) {
v.AddFailuref(field.Position, "Field name %q must be UPPER_SNAKE_CASE.", field.Name)
}
}