github.com/googleapis/api-linter@v1.65.2/rules/aip0192/has_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/locations"
    22  	"github.com/googleapis/api-linter/rules/internal/utils"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  // hasComments complains if there is no comment above something.
    27  var hasComments = &lint.DescriptorRule{
    28  	Name: lint.NewRuleName(192, "has-comments"),
    29  	LintDescriptor: func(d desc.Descriptor) (problems []lint.Problem) {
    30  		comment := utils.SeparateInternalComments(d.GetSourceInfo().GetLeadingComments())
    31  		if len(comment.External) == 0 {
    32  			problems = append(problems, lint.Problem{
    33  				Message:    fmt.Sprintf("Missing comment over %q.", d.GetName()),
    34  				Descriptor: d,
    35  				Location:   locations.DescriptorName(d),
    36  			})
    37  		}
    38  		return
    39  	},
    40  }