create

Documentation

Index

• Constants
• type Handler
  • func NewHandler(options ...HandlerOption) Handler
• type HandlerOption
  • func HandlerWithLogger(logger *zap.Logger) HandlerOption
  • func HandlerWithPackage(pkg string) HandlerOption

Constants

const DefaultPackage = "uber.prototool.generated"

DefaultPackage is the default package to use in lieu of one being able to be derived.

Types

type Handler

type Handler interface {
	// Create the files at the given filePaths.
	Create(filePaths ...string) error
}

Handler handles creation of Protobuf files from a template.

func NewHandler

func NewHandler(options ...HandlerOption) Handler

NewHandler returns a new Handler.

type HandlerOption

type HandlerOption func(*handler)

HandlerOption is an option for a new Handler.

func HandlerWithLogger

func HandlerWithLogger(logger *zap.Logger) HandlerOption

HandlerWithLogger returns a HandlerOption that uses the given logger.

The default is to use zap.NewNop().

func HandlerWithPackage

func HandlerWithPackage(pkg string) HandlerOption

HandlerWithPackage returns a HandlerOption that uses the given package for new Protobuf files.

The default is to derive this from the file path, or use DefaultPackage.