github.com/nikron/prototool@v1.3.0/internal/lint/check_package_lower_snake_case.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  	"strings"
    25  
    26  	"github.com/emicklei/proto"
    27  	"github.com/uber/prototool/internal/strs"
    28  	"github.com/uber/prototool/internal/text"
    29  )
    30  
    31  var packageLowerSnakeCaseLinter = NewLinter(
    32  	"PACKAGE_LOWER_SNAKE_CASE",
    33  	"Verifies that the package is lower_snake.case.",
    34  	checkPackageLowerSnakeCase,
    35  )
    36  
    37  func checkPackageLowerSnakeCase(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    38  	return runVisitor(&packageLowerSnakeCaseVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
    39  }
    40  
    41  type packageLowerSnakeCaseVisitor struct {
    42  	baseAddVisitor
    43  
    44  	filename string
    45  	pkg      *proto.Package
    46  }
    47  
    48  func (v *packageLowerSnakeCaseVisitor) OnStart(descriptor *proto.Proto) error {
    49  	v.filename = descriptor.Filename
    50  	v.pkg = nil
    51  	return nil
    52  }
    53  
    54  func (v *packageLowerSnakeCaseVisitor) VisitPackage(pkg *proto.Package) {
    55  	if v.pkg != nil {
    56  		v.AddFailuref(pkg.Position, "multiple package declarations, first was %v", v.pkg)
    57  		return
    58  	}
    59  	v.pkg = pkg
    60  }
    61  
    62  func (v *packageLowerSnakeCaseVisitor) Finally() error {
    63  	if v.pkg != nil {
    64  		if !strs.IsLowerSnakeCase(strings.Replace(v.pkg.Name, ".", "", -1)) {
    65  			v.AddFailuref(v.pkg.Position, "Package should be lower_snake.case but was %q.", v.pkg.Name)
    66  		}
    67  	}
    68  	return nil
    69  }