github.com/googleapis/api-linter@v1.65.2/rules/aip0192/no_markdown_headings.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  	"regexp"
    19  	"strings"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/rules/internal/utils"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  var noMarkdownHeadings = &lint.DescriptorRule{
    27  	Name: lint.NewRuleName(192, "no-markdown-headings"),
    28  	LintDescriptor: func(d desc.Descriptor) []lint.Problem {
    29  		for _, cmt := range utils.SeparateInternalComments(d.GetSourceInfo().GetLeadingComments()).External {
    30  			for _, line := range strings.Split(cmt, "\n") {
    31  				if heading.FindString(line) != "" {
    32  					return []lint.Problem{{
    33  						Message:    "Comments should not include Markdown headings.",
    34  						Descriptor: d,
    35  					}}
    36  				}
    37  			}
    38  		}
    39  		return nil
    40  	},
    41  }
    42  
    43  var heading = regexp.MustCompile(`^\s*[#]+ `)