github.com/Zenithar/prototool@v1.3.0/internal/lint/check_enums_no_allow_alias.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 enumsNoAllowAliasLinter = NewLinter(
    29  	"ENUMS_NO_ALLOW_ALIAS",
    30  	`Verifies that no enums use the option "allow_alias".`,
    31  	checkEnumsNoAllowAlias,
    32  )
    33  
    34  func checkEnumsNoAllowAlias(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    35  	return runVisitor(enumsNoAllowAliasVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
    36  }
    37  
    38  type enumsNoAllowAliasVisitor struct {
    39  	baseAddVisitor
    40  }
    41  
    42  func (v enumsNoAllowAliasVisitor) VisitMessage(element *proto.Message) {
    43  	// for nested enums
    44  	for _, child := range element.Elements {
    45  		child.Accept(v)
    46  	}
    47  }
    48  
    49  func (v enumsNoAllowAliasVisitor) VisitEnum(element *proto.Enum) {
    50  	for _, child := range element.Elements {
    51  		child.Accept(v)
    52  	}
    53  }
    54  
    55  func (v enumsNoAllowAliasVisitor) VisitOption(element *proto.Option) {
    56  	// file option
    57  	if element.Parent == nil {
    58  		return
    59  	}
    60  	switch element.Parent.(type) {
    61  	case (*proto.Enum):
    62  		if element.Name == "allow_alias" {
    63  			v.AddFailuref(element.Position, "Enum aliases are not allowed.")
    64  		}
    65  	}
    66  }