github.com/googleapis/api-linter@v1.65.2/rules/aip0216/value_synonyms.go (about)

     1  // Copyright 2020 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  	"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  var valueSynonyms = &lint.EnumValueRule{
    27  	Name: lint.NewRuleName(216, "value-synonyms"),
    28  	OnlyIf: func(v *desc.EnumValueDescriptor) bool {
    29  		return strings.HasSuffix(v.GetEnum().GetName(), "State")
    30  	},
    31  	LintEnumValue: func(v *desc.EnumValueDescriptor) []lint.Problem {
    32  		for bad, good := range map[string]string{
    33  			"CANCELED":   "CANCELLED",
    34  			"CANCELING":  "CANCELLING",
    35  			"FAIL":       "FAILED",
    36  			"FAILURE":    "FAILED",
    37  			"READY":      "ACTIVE",
    38  			"SUCCESS":    "SUCCEEDED",
    39  			"SUCCESSFUL": "SUCCEEDED",
    40  		} {
    41  			if v.GetName() == bad {
    42  				return []lint.Problem{{
    43  					Message:    fmt.Sprintf("Prefer %q over %q for state names.", good, bad),
    44  					Suggestion: good,
    45  					Descriptor: v,
    46  					Location:   locations.DescriptorName(v),
    47  				}}
    48  			}
    49  		}
    50  		return nil
    51  	},
    52  }