github.com/googleapis/api-linter@v1.65.2/rules/aip0140/uri.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 aip0140
    16  
    17  import (
    18  	"strings"
    19  
    20  	"bitbucket.org/creachadair/stringset"
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/locations"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  var uri = &lint.FieldRule{
    27  	Name: lint.NewRuleName(140, "uri"),
    28  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    29  		nameSegments := stringset.New(strings.Split(f.GetName(), "_")...)
    30  		if nameSegments.Contains("url") {
    31  			return []lint.Problem{{
    32  				Message:    "Use `uri` instead of `url` in field names.",
    33  				Descriptor: f,
    34  				Location:   locations.DescriptorName(f),
    35  				Suggestion: strings.ReplaceAll(f.GetName(), "url", "uri"),
    36  			}}
    37  		}
    38  		return nil
    39  	},
    40  }