github.com/googleapis/api-linter@v1.65.2/rules/aip0143/standardized_codes.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 aip0143
    16  
    17  import (
    18  	"fmt"
    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 fieldNames = &lint.FieldRule{
    26  	Name: lint.NewRuleName(143, "standardized-codes"),
    27  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    28  		variants := map[string]string{
    29  			"content_type": "mime_type",
    30  			"country":      "region_code",
    31  			"country_code": "region_code",
    32  			"currency":     "currency_code",
    33  			"lang":         "language_code",
    34  			"language":     "language_code",
    35  			"mime":         "mime_type",
    36  			"mimetype":     "mime_type",
    37  			"tz":           "time_zone",
    38  			"timezone":     "time_zone",
    39  		}
    40  		if want, ok := variants[f.GetName()]; ok {
    41  			return []lint.Problem{{
    42  				Message:    fmt.Sprintf("Use %q in place of %q.", want, f.GetName()),
    43  				Descriptor: f,
    44  				Location:   locations.DescriptorName(f),
    45  				Suggestion: want,
    46  			}}
    47  		}
    48  		return nil
    49  	},
    50  }