github.com/googleapis/api-linter@v1.65.2/rules/aip0216/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 aip0216
    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  )
    24  
    25  var synonyms = &lint.EnumRule{
    26  	Name: lint.NewRuleName(216, "synonyms"),
    27  	LintEnum: func(e *desc.EnumDescriptor) []lint.Problem {
    28  		if strings.HasSuffix(e.GetName(), "Status") {
    29  			return []lint.Problem{{
    30  				Message:    `Prefer "State" over "Status" for lifecycle state enums.`,
    31  				Suggestion: strings.Replace(e.GetName(), "Status", "State", 1),
    32  				Descriptor: e,
    33  				Location:   locations.DescriptorName(e),
    34  			}}
    35  		}
    36  		return nil
    37  	},
    38  }