github.com/nikron/prototool@v1.3.0/internal/lint/check_message_fields_not_floats.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/text"
    26  )
    27  
    28  var messageFieldsNotFloatsLinter = NewLinter(
    29  	"MESSAGE_FIELDS_NOT_FLOATS",
    30  	"Verifies that all message fields are not floats or doubles.",
    31  	checkMessageFieldsNotFloats,
    32  )
    33  
    34  func checkMessageFieldsNotFloats(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    35  	return runVisitor(messageFieldsNotFloatsVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
    36  }
    37  
    38  type messageFieldsNotFloatsVisitor struct {
    39  	baseAddVisitor
    40  }
    41  
    42  func (v messageFieldsNotFloatsVisitor) VisitMessage(message *proto.Message) {
    43  	for _, element := range message.Elements {
    44  		element.Accept(v)
    45  	}
    46  }
    47  
    48  func (v messageFieldsNotFloatsVisitor) VisitOneof(oneof *proto.Oneof) {
    49  	for _, element := range oneof.Elements {
    50  		element.Accept(v)
    51  	}
    52  }
    53  
    54  func (v messageFieldsNotFloatsVisitor) VisitNormalField(field *proto.NormalField) {
    55  	v.checkNotFloat(field.Field)
    56  }
    57  
    58  func (v messageFieldsNotFloatsVisitor) VisitOneofField(field *proto.OneOfField) {
    59  	v.checkNotFloat(field.Field)
    60  }
    61  
    62  func (v messageFieldsNotFloatsVisitor) VisitMapField(field *proto.MapField) {
    63  	v.checkNotFloat(field.Field)
    64  }
    65  
    66  func (v messageFieldsNotFloatsVisitor) checkNotFloat(field *proto.Field) {
    67  	switch field.Type {
    68  	case "double", "float":
    69  		v.AddFailuref(field.Position, "Field %q is a float and floating point types are not allowed, consider using an int64 while representing your value in micros or nanos.", field.Name)
    70  	}
    71  }