github.com/googleapis/api-linter@v1.65.2/rules/aip0216/nesting.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 aip0216
    16  
    17  import (
    18  	"fmt"
    19  	"strings"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/jhump/protoreflect/desc"
    23  )
    24  
    25  var nesting = &lint.EnumRule{
    26  	Name: lint.NewRuleName(216, "nesting"),
    27  	OnlyIf: func(e *desc.EnumDescriptor) bool {
    28  		return strings.HasSuffix(e.GetName(), "State") && e.GetName() != "State"
    29  	},
    30  	LintEnum: func(e *desc.EnumDescriptor) []lint.Problem {
    31  		messageName := strings.TrimSuffix(e.GetName(), "State")
    32  		fqMessageName := messageName
    33  		file := e.GetFile()
    34  		if pkg := file.GetPackage(); pkg != "" {
    35  			fqMessageName = pkg + "." + messageName
    36  		}
    37  		if file.FindMessage(fqMessageName) != nil {
    38  			return []lint.Problem{{
    39  				Message: fmt.Sprintf(
    40  					"Nest %q within %q, and name it `State`.",
    41  					e.GetName(),
    42  					messageName,
    43  				),
    44  				Descriptor: e,
    45  			}}
    46  		}
    47  		return nil
    48  	},
    49  }