github.com/nikron/prototool@v1.3.0/internal/lint/check_message_field_names_lowercase.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  	"github.com/emicklei/proto"
    25  	"github.com/uber/prototool/internal/strs"
    26  	"github.com/uber/prototool/internal/text"
    27  )
    28  
    29  var messageFieldNamesLowercaseLinter = NewLinter(
    30  	"MESSAGE_FIELD_NAMES_LOWERCASE",
    31  	"Verifies that all message field names are lowercase.",
    32  	checkMessageFieldNamesLowercase,
    33  )
    34  
    35  func checkMessageFieldNamesLowercase(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    36  	return runVisitor(messageFieldNamesLowercaseVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
    37  }
    38  
    39  type messageFieldNamesLowercaseVisitor struct {
    40  	baseAddVisitor
    41  }
    42  
    43  func (v messageFieldNamesLowercaseVisitor) VisitMessage(message *proto.Message) {
    44  	for _, element := range message.Elements {
    45  		element.Accept(v)
    46  	}
    47  }
    48  
    49  func (v messageFieldNamesLowercaseVisitor) VisitOneof(oneof *proto.Oneof) {
    50  	for _, element := range oneof.Elements {
    51  		element.Accept(v)
    52  	}
    53  }
    54  
    55  func (v messageFieldNamesLowercaseVisitor) VisitNormalField(field *proto.NormalField) {
    56  	if !strs.IsLowercase(field.Name) {
    57  		v.AddFailuref(field.Position, "Field name %q must be lowercase.", field.Name)
    58  	}
    59  }
    60  
    61  func (v messageFieldNamesLowercaseVisitor) VisitOneofField(field *proto.OneOfField) {
    62  	if !strs.IsLowercase(field.Name) {
    63  		v.AddFailuref(field.Position, "Field name %q must be lowercase.", field.Name)
    64  	}
    65  }
    66  
    67  func (v messageFieldNamesLowercaseVisitor) VisitMapField(field *proto.MapField) {
    68  	if !strs.IsLowercase(field.Name) {
    69  		v.AddFailuref(field.Position, "Field name %q must be lowercase.", field.Name)
    70  	}
    71  }