github.com/ovsinc/prototool@v1.3.0/internal/create/create.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 create 22 23 import "go.uber.org/zap" 24 25 // DefaultPackage is the default package to use in lieu of one being able to be 26 // derived. 27 const DefaultPackage = "uber.prototool.generated" 28 29 // Handler handles creation of Protobuf files from a template. 30 type Handler interface { 31 // Create the files at the given filePaths. 32 Create(filePaths ...string) error 33 } 34 35 // HandlerOption is an option for a new Handler. 36 type HandlerOption func(*handler) 37 38 // HandlerWithLogger returns a HandlerOption that uses the given logger. 39 // 40 // The default is to use zap.NewNop(). 41 func HandlerWithLogger(logger *zap.Logger) HandlerOption { 42 return func(handler *handler) { 43 handler.logger = logger 44 } 45 } 46 47 // HandlerWithPackage returns a HandlerOption that uses the given package for 48 // new Protobuf files. 49 // 50 // The default is to derive this from the file path, or use DefaultPackage. 51 func HandlerWithPackage(pkg string) HandlerOption { 52 return func(handler *handler) { 53 handler.pkg = pkg 54 } 55 } 56 57 // NewHandler returns a new Handler. 58 func NewHandler(options ...HandlerOption) Handler { 59 return newHandler(options...) 60 }