github.com/psrajat/prototool@v1.3.0/internal/lint/check_go_package_not_long_form.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  var fileOptionsGoPackageNotLongFormLinter = NewLinter(
    31  	"FILE_OPTIONS_GO_PACKAGE_NOT_LONG_FORM",
    32  	`Verifies that the file option "go_package" is not of the form "go/import/path;package".`,
    33  	checkFileOptionsGoPackageNotLongForm,
    34  )
    35  
    36  func checkFileOptionsGoPackageNotLongForm(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    37  	return runVisitor(&fileOptionsGoPackageNotLongFormVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
    38  }
    39  
    40  type fileOptionsGoPackageNotLongFormVisitor struct {
    41  	baseAddVisitor
    42  
    43  	option *proto.Option
    44  }
    45  
    46  func (v *fileOptionsGoPackageNotLongFormVisitor) OnStart(descriptor *proto.Proto) error {
    47  	v.option = nil
    48  	return nil
    49  }
    50  
    51  func (v *fileOptionsGoPackageNotLongFormVisitor) VisitOption(element *proto.Option) {
    52  	if element.Name == "go_package" {
    53  		v.option = element
    54  	}
    55  }
    56  
    57  func (v *fileOptionsGoPackageNotLongFormVisitor) Finally() error {
    58  	if v.option == nil {
    59  		return nil
    60  	}
    61  	value := v.option.Constant.Source
    62  	if strings.Contains(value, ";") {
    63  		v.AddFailuref(v.option.Position, `Option "go_package" cannot be of the long-form "go/import/path;package" and must only be of the short-form "package", but was %q.`, value)
    64  	}
    65  	return nil
    66  }