github.com/googleapis/api-linter@v1.65.2/rules/aip0136/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 aip0136
    16  
    17  import (
    18  	"fmt"
    19  	"strings"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/locations"
    23  	"github.com/googleapis/api-linter/rules/internal/data"
    24  	"github.com/jhump/protoreflect/desc"
    25  	"github.com/stoewer/go-strcase"
    26  )
    27  
    28  var noPrepositions = &lint.MethodRule{
    29  	Name: lint.NewRuleName(136, "prepositions"),
    30  	LintMethod: func(m *desc.MethodDescriptor) (problems []lint.Problem) {
    31  		for _, word := range strings.Split(strcase.SnakeCase(m.GetName()), "_") {
    32  			if data.Prepositions.Contains(word) {
    33  				problems = append(problems, lint.Problem{
    34  					Message:    fmt.Sprintf("Method names should not include prepositions (%q).", word),
    35  					Descriptor: m,
    36  					Location:   locations.DescriptorName(m),
    37  				})
    38  			}
    39  		}
    40  		return
    41  	},
    42  }