github.com/googleapis/api-linter@v1.65.2/rules/aip0123/resource_plural.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 resourcePlural = &lint.MessageRule{
    27  	Name:   lint.NewRuleName(123, "resource-plural"),
    28  	OnlyIf: hasResourceAnnotation,
    29  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    30  		r := utils.GetResource(m)
    31  		l := locations.MessageResource(m)
    32  		p := r.GetPlural()
    33  		pLower := utils.ToLowerCamelCase(p)
    34  		if p == "" {
    35  			return []lint.Problem{{
    36  				Message:    "Resources should declare plural.",
    37  				Descriptor: m,
    38  				Location:   l,
    39  			}}
    40  		}
    41  		if pLower != p {
    42  			return []lint.Problem{{
    43  				Message: fmt.Sprintf(
    44  					"Resource plural should be lowerCamelCase: %q", pLower,
    45  				),
    46  				Descriptor: m,
    47  				Location:   l,
    48  			}}
    49  		}
    50  		return nil
    51  	},
    52  }