github.com/googleapis/api-linter@v1.65.2/rules/aip0123/resource_type_name.go (about)

     1  // Copyright 2022 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 aip0123
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/locations"
    22  	"github.com/googleapis/api-linter/rules/internal/utils"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  var resourceTypeName = &lint.MessageRule{
    27  	Name: lint.NewRuleName(123, "resource-type-name"),
    28  	OnlyIf: func(m *desc.MessageDescriptor) bool {
    29  		return utils.GetResource(m) != nil
    30  	},
    31  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    32  		resource := utils.GetResource(m)
    33  		_, typeName, ok := utils.SplitResourceTypeName(resource.GetType())
    34  		upperTypeName := utils.ToUpperCamelCase(typeName)
    35  		if !ok {
    36  			return []lint.Problem{{
    37  				Message:    "Resource type names must be of the form {Service Name}/{Type}.",
    38  				Descriptor: m,
    39  				Location:   locations.MessageResource(m),
    40  			}}
    41  		}
    42  		if upperTypeName != typeName {
    43  			return []lint.Problem{{
    44  				Message:    fmt.Sprintf("Type must be UpperCamelCase with alphanumeric characters: %q", upperTypeName),
    45  				Descriptor: m,
    46  				Location:   locations.MessageResource(m),
    47  			}}
    48  		}
    49  		return nil
    50  	},
    51  }