github.com/Zenithar/prototool@v1.3.0/internal/lint/check_file_options_unset.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  	"text/scanner"
    25  
    26  	"github.com/emicklei/proto"
    27  	"github.com/uber/prototool/internal/text"
    28  )
    29  
    30  var fileOptionsUnsetJavaMultipleFilesLinter = NewLinter(
    31  	"FILE_OPTIONS_UNSET_JAVA_MULTIPLE_FILES",
    32  	`Verifies that the file option "java_multiple_files" is unset.`,
    33  	newCheckFileOptionsUnset("java_multiple_files"),
    34  )
    35  
    36  var fileOptionsUnsetJavaOuterClassnameLinter = NewLinter(
    37  	"FILE_OPTIONS_UNSET_JAVA_OUTER_CLASSNAME",
    38  	`Verifies that the file option "java_outer_classname" is unset.`,
    39  	newCheckFileOptionsUnset("java_outer_classname"),
    40  )
    41  
    42  func newCheckFileOptionsUnset(fileOption string) func(func(*text.Failure), string, []*proto.Proto) error {
    43  	return func(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    44  		return runVisitor(&fileOptionsUnsetVisitor{
    45  			baseAddVisitor: newBaseAddVisitor(add),
    46  			fileOption:     fileOption,
    47  		}, descriptors)
    48  	}
    49  }
    50  
    51  type fileOptionsUnsetVisitor struct {
    52  	baseAddVisitor
    53  
    54  	fileOption string
    55  
    56  	seen     bool
    57  	position scanner.Position
    58  }
    59  
    60  func (v *fileOptionsUnsetVisitor) OnStart(descriptor *proto.Proto) error {
    61  	v.seen = false
    62  	v.position = scanner.Position{}
    63  	return nil
    64  }
    65  
    66  func (v *fileOptionsUnsetVisitor) VisitOption(element *proto.Option) {
    67  	// since we are not recursing on any elements, this is a file option
    68  	if element.Name == v.fileOption {
    69  		v.seen = true
    70  		v.position = element.Position
    71  	}
    72  }
    73  
    74  func (v *fileOptionsUnsetVisitor) Finally() error {
    75  	if v.seen {
    76  		v.AddFailuref(v.position, "File option %q should not be set.", v.fileOption)
    77  	}
    78  	return nil
    79  }