github.com/googleapis/api-linter@v1.65.2/rules/aip0231/plural_method_name.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 aip0231
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"github.com/gertd/go-pluralize"
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/locations"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  var pluralMethodResourceName = &lint.MethodRule{
    27  	Name:   lint.NewRuleName(231, "plural-method-name"),
    28  	OnlyIf: isBatchGetMethod,
    29  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    30  		// Note: m.GetName()[8:] is used to retrieve the resource name from the
    31  		// method name. For example, "BatchGetFoos" -> "Foos"
    32  		pluralMethodResourceName := m.GetName()[8:]
    33  
    34  		pluralize := pluralize.NewClient()
    35  
    36  		// Rule check: Establish that for methods such as `BatchGetFoos`
    37  		if !pluralize.IsPlural(pluralMethodResourceName) {
    38  			return []lint.Problem{{
    39  				Message: fmt.Sprintf(
    40  					`The resource part in method %q should not be %q, but should be its plural form %q`,
    41  					m.GetName(), pluralMethodResourceName, pluralize.Plural(pluralMethodResourceName),
    42  				),
    43  				Descriptor: m,
    44  				Location:   locations.DescriptorName(m),
    45  			}}
    46  		}
    47  
    48  		return nil
    49  	},
    50  }