github.com/nikron/prototool@v1.3.0/internal/lint/check_enums_have_comments.go (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package lint
    22  
    23  import (
    24  	"fmt"
    25  	"strings"
    26  
    27  	"github.com/emicklei/proto"
    28  	"github.com/uber/prototool/internal/text"
    29  )
    30  
    31  var enumsHaveCommentsLinter = NewLinter(
    32  	"ENUMS_HAVE_COMMENTS",
    33  	`Verifies that all enums have a comment of the form "// EnumName ...".`,
    34  	checkEnumsHaveComments,
    35  )
    36  
    37  func checkEnumsHaveComments(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    38  	return runVisitor(enumsHaveCommentsVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
    39  }
    40  
    41  type enumsHaveCommentsVisitor struct {
    42  	baseAddVisitor
    43  }
    44  
    45  func (v enumsHaveCommentsVisitor) VisitMessage(message *proto.Message) {
    46  	// for nested enums
    47  	for _, child := range message.Elements {
    48  		child.Accept(v)
    49  	}
    50  }
    51  
    52  func (v enumsHaveCommentsVisitor) VisitEnum(enum *proto.Enum) {
    53  	if enum.Comment == nil || len(enum.Comment.Lines) == 0 || !strings.HasPrefix(enum.Comment.Lines[0], fmt.Sprintf(" %s ", enum.Name)) {
    54  		v.AddFailuref(enum.Position, `Enum %q needs a comment of the form "// %s ..."`, enum.Name, enum.Name)
    55  	}
    56  }