github.com/googleapis/api-linter@v1.65.2/rules/aip0131/synonyms.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 aip0131
    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/jhump/protoreflect/desc"
    24  )
    25  
    26  // Get methods should not generally use synonyms for "get".
    27  var synonyms = &lint.MethodRule{
    28  	Name: lint.NewRuleName(131, "synonyms"),
    29  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    30  		name := m.GetName()
    31  		for _, syn := range []string{"Acquire", "Fetch", "Lookup", "Read", "Retrieve"} {
    32  			if strings.HasPrefix(name, syn) {
    33  				return []lint.Problem{{
    34  					Message: fmt.Sprintf(
    35  						`%q can be a synonym for "Get". Should this be a Get method?`,
    36  						syn,
    37  					),
    38  					Suggestion: strings.Replace(name, syn, "Get", 1),
    39  					Descriptor: m,
    40  					Location:   locations.DescriptorName(m),
    41  				}}
    42  			}
    43  		}
    44  		return nil
    45  	},
    46  }