github.com/nikron/prototool@v1.3.0/internal/lint/check_package_is_declared.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 packageIsDeclaredLinter = NewLinter(
    31  	"PACKAGE_IS_DECLARED",
    32  	"Verifies that there is a package declaration.",
    33  	checkPackageIsDeclared,
    34  )
    35  
    36  func checkPackageIsDeclared(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    37  	return runVisitor(&packageIsDeclaredVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
    38  }
    39  
    40  type packageIsDeclaredVisitor struct {
    41  	baseAddVisitor
    42  
    43  	filename string
    44  	pkg      *proto.Package
    45  }
    46  
    47  func (v *packageIsDeclaredVisitor) OnStart(descriptor *proto.Proto) error {
    48  	v.filename = descriptor.Filename
    49  	v.pkg = nil
    50  	return nil
    51  }
    52  
    53  func (v *packageIsDeclaredVisitor) VisitPackage(pkg *proto.Package) {
    54  	if v.pkg != nil {
    55  		v.AddFailuref(pkg.Position, "multiple package declarations, first was %v", v.pkg)
    56  		return
    57  	}
    58  	v.pkg = pkg
    59  }
    60  
    61  func (v *packageIsDeclaredVisitor) Finally() error {
    62  	if v.pkg == nil {
    63  		v.AddFailuref(scanner.Position{Filename: v.filename}, "No package declaration found.")
    64  		return nil
    65  	}
    66  	return nil
    67  }