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

     1  // Copyright 2021 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  	"strings"
    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  var deprecatedComment = &lint.DescriptorRule{
    26  	Name:   lint.NewRuleName(192, "deprecated-comment"),
    27  	OnlyIf: isDeprecated,
    28  	LintDescriptor: func(d desc.Descriptor) []lint.Problem {
    29  		comment := utils.SeparateInternalComments(d.GetSourceInfo().GetLeadingComments())
    30  		if len(comment.External) > 0 && strings.HasPrefix(comment.External[0], "Deprecated:") {
    31  			return nil
    32  		}
    33  		return []lint.Problem{{
    34  			Message:    `Use "Deprecated: <reason>" as the first line in the comment.`,
    35  			Descriptor: d,
    36  		}}
    37  	},
    38  }