github.com/Zenithar/prototool@v1.3.0/internal/lint/base_linter.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/text"
    28  )
    29  
    30  type baseLinter struct {
    31  	id       string
    32  	purpose  string
    33  	addCheck func(func(*text.Failure), string, []*proto.Proto) error
    34  }
    35  
    36  func newBaseLinter(
    37  	id string,
    38  	purpose string,
    39  	addCheck func(func(*text.Failure), string, []*proto.Proto) error,
    40  ) *baseLinter {
    41  	return &baseLinter{
    42  		id:       strings.ToUpper(id),
    43  		purpose:  purpose,
    44  		addCheck: addCheck,
    45  	}
    46  }
    47  
    48  func (c *baseLinter) ID() string {
    49  	return c.id
    50  }
    51  
    52  func (c *baseLinter) Purpose() string {
    53  	return c.purpose
    54  }
    55  
    56  func (c *baseLinter) Check(dirPath string, descriptors []*proto.Proto) ([]*text.Failure, error) {
    57  	var failures []*text.Failure
    58  	err := c.addCheck(
    59  		func(failure *text.Failure) {
    60  			failures = append(failures, failure)
    61  		},
    62  		dirPath,
    63  		descriptors,
    64  	)
    65  	for _, failure := range failures {
    66  		failure.LintID = c.id
    67  	}
    68  	return failures, err
    69  }