github.com/googleapis/api-linter@v1.65.2/rules/aip0140/aip0140.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 aip0140 contains rules defined in https://aip.dev/140.
    16  package aip0140
    17  
    18  import (
    19  	"strings"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/jhump/protoreflect/desc"
    23  	"github.com/jhump/protoreflect/desc/builder"
    24  	"github.com/stoewer/go-strcase"
    25  )
    26  
    27  // AddRules adds all of the AIP-140 rules to the provided registry.
    28  func AddRules(r lint.RuleRegistry) error {
    29  	return r.Register(
    30  		140,
    31  		abbreviations,
    32  		base64,
    33  		lowerSnake,
    34  		noPrepositions,
    35  		numbers,
    36  		reservedWords,
    37  		underscores,
    38  		uri,
    39  	)
    40  }
    41  
    42  // toLowerSnakeCase converts s to lower_snake_case.
    43  func toLowerSnakeCase(s string) string {
    44  	return strings.ToLower(strcase.SnakeCase(s))
    45  }
    46  
    47  // isStringField returns true if the field is a string field.
    48  func isStringField(f *desc.FieldDescriptor) bool {
    49  	return f.GetType() == builder.FieldTypeString().GetType()
    50  }