github.com/googleapis/api-linter@v1.65.2/rules/aip0148/human_names.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 aip0148
    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 humanNames = &lint.FieldRule{
    26  	Name: lint.NewRuleName(148, "human-names"),
    27  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    28  		for got, want := range corrections {
    29  			if f.GetName() == got {
    30  				return []lint.Problem{{
    31  					Message:    fmt.Sprintf("Use %s instead of %s.", want, got),
    32  					Descriptor: f,
    33  					Location:   locations.DescriptorName(f),
    34  					Suggestion: want,
    35  				}}
    36  			}
    37  		}
    38  		return nil
    39  	},
    40  }
    41  
    42  var corrections = map[string]string{
    43  	"first_name": "given_name",
    44  	"last_name":  "family_name",
    45  }