github.com/googleapis/api-linter@v1.65.2/rules/aip0140/prepositions.go (about)

     1  // Copyright 2019 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  // 		https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package aip0140
    16  
    17  import (
    18  	"fmt"
    19  	"strings"
    20  
    21  	"bitbucket.org/creachadair/stringset"
    22  	"github.com/googleapis/api-linter/lint"
    23  	"github.com/googleapis/api-linter/locations"
    24  	"github.com/googleapis/api-linter/rules/internal/data"
    25  	"github.com/jhump/protoreflect/desc"
    26  )
    27  
    28  var noPrepositions = &lint.FieldRule{
    29  	Name: lint.NewRuleName(140, "prepositions"),
    30  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    31  		return !stringset.New("order_by", "group_by", "hour_of_day", "day_of_week").Contains(f.GetName())
    32  	},
    33  	LintField: func(f *desc.FieldDescriptor) (problems []lint.Problem) {
    34  		for _, word := range strings.Split(f.GetName(), "_") {
    35  			if data.Prepositions.Contains(word) {
    36  				problems = append(problems, lint.Problem{
    37  					Message:    fmt.Sprintf("Avoid using %q in field names.", word),
    38  					Descriptor: f,
    39  					Location:   locations.DescriptorName(f),
    40  				})
    41  			}
    42  		}
    43  		return
    44  	},
    45  }