github.com/nikron/prototool@v1.3.0/internal/lint/check_service_names_capitalized.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  	"github.com/emicklei/proto"
    25  	"github.com/uber/prototool/internal/strs"
    26  	"github.com/uber/prototool/internal/text"
    27  )
    28  
    29  var serviceNamesCapitalizedLinter = NewLinter(
    30  	"SERVICE_NAMES_CAPITALIZED",
    31  	"Verifies that all service names are Capitalized.",
    32  	checkServiceNamesCapitalized,
    33  )
    34  
    35  func checkServiceNamesCapitalized(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    36  	return runVisitor(serviceNamesCapitalizedVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
    37  }
    38  
    39  type serviceNamesCapitalizedVisitor struct {
    40  	baseAddVisitor
    41  }
    42  
    43  func (v serviceNamesCapitalizedVisitor) VisitService(service *proto.Service) {
    44  	if !strs.IsCapitalized(service.Name) {
    45  		v.AddFailuref(service.Position, "Service name %q must be capitalized.", service.Name)
    46  	}
    47  }