github.com/nikron/prototool@v1.3.0/internal/lint/check_packages_same_in_dir.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  	"sort"
    25  	"strings"
    26  	"text/scanner"
    27  
    28  	"github.com/emicklei/proto"
    29  	"github.com/uber/prototool/internal/text"
    30  )
    31  
    32  var packagesSameInDirLinter = NewLinter(
    33  	"PACKAGES_SAME_IN_DIR",
    34  	"Verifies that the packages of all files in a directory are the same.",
    35  	checkPackagesSameInDir,
    36  )
    37  
    38  func checkPackagesSameInDir(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    39  	visitor := &packagesSameInDirVisitor{baseAddVisitor: newBaseAddVisitor(add), pkgs: make(map[string]struct{})}
    40  	if err := runVisitor(visitor, descriptors); err != nil {
    41  		return err
    42  	}
    43  	if len(visitor.pkgs) > 1 {
    44  		pkgsSlice := make([]string, 0, len(visitor.pkgs))
    45  		for pkg := range visitor.pkgs {
    46  			pkgsSlice = append(pkgsSlice, pkg)
    47  		}
    48  		sort.Strings(pkgsSlice)
    49  		for _, descriptor := range descriptors {
    50  			visitor.AddFailuref(scanner.Position{Filename: descriptor.Filename}, "Multiple packages in directory: %v.", strings.Join(pkgsSlice, ", "))
    51  		}
    52  	}
    53  	return nil
    54  }
    55  
    56  type packagesSameInDirVisitor struct {
    57  	baseAddVisitor
    58  
    59  	pkgs map[string]struct{}
    60  
    61  	pkg *proto.Package
    62  }
    63  
    64  func (v *packagesSameInDirVisitor) OnStart(*proto.Proto) error {
    65  	v.pkg = nil
    66  	return nil
    67  }
    68  
    69  func (v *packagesSameInDirVisitor) VisitPackage(pkg *proto.Package) {
    70  	if v.pkg != nil {
    71  		v.AddFailuref(pkg.Position, "multiple package declarations, first was %v", v.pkg)
    72  		return
    73  	}
    74  	v.pkg = pkg
    75  }
    76  
    77  func (v *packagesSameInDirVisitor) Finally() error {
    78  	if v.pkg != nil {
    79  		v.pkgs[v.pkg.Name] = struct{}{}
    80  	}
    81  	return nil
    82  }