github.com/googleapis/api-linter@v1.65.2/rules/aip0192/only_leading_comments.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 aip0192
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/rules/internal/utils"
    22  	"github.com/jhump/protoreflect/desc"
    23  )
    24  
    25  // onlyLeadingComments ensures that a descriptor has only leading external
    26  // comments. (Internal trailing or detached comments are permitted.)
    27  var onlyLeadingComments = &lint.DescriptorRule{
    28  	Name: lint.NewRuleName(192, "only-leading-comments"),
    29  	LintDescriptor: func(d desc.Descriptor) []lint.Problem {
    30  		problems := []lint.Problem{}
    31  		c := d.GetSourceInfo()
    32  		if len(utils.SeparateInternalComments(c.GetTrailingComments()).External) > 0 {
    33  			problems = append(problems, lint.Problem{
    34  				Message: fmt.Sprintf(
    35  					"%q should have only leading (not trailing) public comments.",
    36  					d.GetName(),
    37  				),
    38  				Descriptor: d,
    39  			})
    40  		}
    41  		if len(utils.SeparateInternalComments(c.GetLeadingDetachedComments()...).External) > 0 {
    42  			problems = append(problems, lint.Problem{
    43  				Message: fmt.Sprintf(
    44  					"%q has comments with empty lines between the comment and %q.",
    45  					d.GetName(), d.GetName(),
    46  				),
    47  				Descriptor: d,
    48  			})
    49  		}
    50  		return problems
    51  	},
    52  }