github.com/googleapis/api-linter@v1.65.2/rules/aip0143/string_type.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  	"bitbucket.org/creachadair/stringset"
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/locations"
    23  	"github.com/googleapis/api-linter/rules/internal/utils"
    24  	"github.com/jhump/protoreflect/desc"
    25  )
    26  
    27  var fieldTypes = &lint.FieldRule{
    28  	Name: lint.NewRuleName(143, "string-type"),
    29  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    30  		return stringset.New(
    31  			"country_code",
    32  			"currency_code",
    33  			"language_code",
    34  			"mime_type",
    35  			"time_zone",
    36  		).Contains(f.GetName())
    37  	},
    38  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    39  		if typeName := utils.GetTypeName(f); typeName != "string" {
    40  			if f.GetName() == "time_zone" && typeName == "google.type.TimeZone" {
    41  				return nil
    42  			}
    43  			return []lint.Problem{{
    44  				Message:    fmt.Sprintf("Field %q should be a string, not %s.", f.GetName(), typeName),
    45  				Suggestion: "string",
    46  				Descriptor: f,
    47  				Location:   locations.FieldType(f),
    48  			}}
    49  		}
    50  		return nil
    51  	},
    52  }