github.com/googleapis/api-linter@v1.65.2/rules/aip0136/verb_noun.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  	"strings"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/locations"
    22  	"github.com/jhump/protoreflect/desc"
    23  	"github.com/stoewer/go-strcase"
    24  )
    25  
    26  var verbNoun = &lint.MethodRule{
    27  	Name: lint.NewRuleName(136, "verb-noun"),
    28  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    29  		// We can not detect this precisely without a full dictionary (probably
    30  		// not worth it), but we can catch some common mistakes.
    31  
    32  		// Are there at least two words?
    33  		if wordCount := len(strings.Split(strcase.SnakeCase(m.GetName()), "_")); wordCount == 1 {
    34  			return []lint.Problem{{
    35  				Message:    "Custom methods should be named using a verb followed by a noun.",
    36  				Descriptor: m,
    37  				Location:   locations.DescriptorName(m),
    38  			}}
    39  		}
    40  
    41  		return nil
    42  	},
    43  }