forked from googleapis/api-linter
/
prepositions.go
45 lines (41 loc) · 1.43 KB
/
prepositions.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
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package aip0140
import (
"fmt"
"strings"
"bitbucket.org/creachadair/stringset"
"github.com/commure/api-linter/lint"
"github.com/commure/api-linter/locations"
"github.com/commure/api-linter/rules/internal/data"
"github.com/jhump/protoreflect/desc"
)
var noPrepositions = &lint.FieldRule{
Name: lint.NewRuleName(140, "prepositions"),
OnlyIf: func(f *desc.FieldDescriptor) bool {
return !stringset.New("order_by", "group_by", "hour_of_day", "day_of_week").Contains(f.GetName())
},
LintField: func(f *desc.FieldDescriptor) (problems []lint.Problem) {
for _, word := range strings.Split(f.GetName(), "_") {
if data.Prepositions.Contains(word) {
problems = append(problems, lint.Problem{
Message: fmt.Sprintf("Avoid using %q in field names.", word),
Descriptor: f,
Location: locations.DescriptorName(f),
})
}
}
return
},
}