github.com/googleapis/api-linter@v1.65.2/rules/aip0141/forbidden_types.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 aip0141
    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 forbiddenTypes = &lint.FieldRule{
    28  	Name: lint.NewRuleName(141, "forbidden-types"),
    29  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    30  		nope := stringset.New("fixed32", "fixed64", "uint32", "uint64")
    31  		if typeName := utils.GetTypeName(f); nope.Contains(typeName) {
    32  			// Preserve original intent w/r/t 32-bit vs. 64-bit.
    33  			want := "int" + typeName[len(typeName)-2:]
    34  			return []lint.Problem{{
    35  				Message:    fmt.Sprintf("Use %q instead of %q.", want, typeName),
    36  				Suggestion: want,
    37  				Descriptor: f,
    38  				Location:   locations.FieldType(f),
    39  			}}
    40  		}
    41  		return nil
    42  	},
    43  }