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