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

     1  // Copyright 2023 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 resourceSingular = &lint.MessageRule{
    27  	Name:   lint.NewRuleName(123, "resource-singular"),
    28  	OnlyIf: hasResourceAnnotation,
    29  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    30  		r := utils.GetResource(m)
    31  		l := locations.MessageResource(m)
    32  		s := r.GetSingular()
    33  		_, typeName, ok := utils.SplitResourceTypeName(r.GetType())
    34  		lowerTypeName := utils.ToLowerCamelCase(typeName)
    35  		if s == "" {
    36  			return []lint.Problem{{
    37  				Message:    fmt.Sprintf("Resources should declare singular: %q", lowerTypeName),
    38  				Descriptor: m,
    39  				Location:   l,
    40  			}}
    41  		}
    42  		if !ok || lowerTypeName != s {
    43  			return []lint.Problem{{
    44  				Message: fmt.Sprintf(
    45  					"Resource singular should be lower camel case of type: %q",
    46  					lowerTypeName,
    47  				),
    48  				Descriptor: m,
    49  				Location:   l,
    50  			}}
    51  		}
    52  		return nil
    53  	},
    54  }