github.com/nikron/prototool@v1.3.0/internal/lint/check_wkt_directly_imported.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  	"github.com/uber/prototool/internal/wkt"
    29  )
    30  
    31  // TODO: This will not detect things like "timestamp.proto" or "protobuf/timestamp.proto"
    32  // A more robust solution might be needed
    33  
    34  var (
    35  	wktDirectlyImportedLinter = NewLinter(
    36  		"WKT_DIRECTLY_IMPORTED",
    37  		`Verifies that the Well-Known Types are directly imported using "google/protobuf/" as the base of the import.`,
    38  		checkWKTDirectlyImported,
    39  	)
    40  )
    41  
    42  func checkWKTDirectlyImported(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    43  	return runVisitor(&wktDirectlyImportedVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
    44  }
    45  
    46  type wktDirectlyImportedVisitor struct {
    47  	baseAddVisitor
    48  }
    49  
    50  func (v wktDirectlyImportedVisitor) VisitImport(element *proto.Import) {
    51  	for wktFilename := range wkt.Filenames {
    52  		if strings.HasSuffix(element.Filename, wktFilename) && element.Filename != wktFilename {
    53  			v.AddFailuref(element.Position, "Import %q is a Well-Known Type import but should be imported using google/protobuf as the base.", element.Filename)
    54  		}
    55  	}
    56  }