format

Documentation

Index

• type Transformer
  • func NewTransformer(options ...TransformerOption) Transformer
• type TransformerOption
  • func TransformerWithFix() TransformerOption
  • func TransformerWithLogger(logger *zap.Logger) TransformerOption

Types

type Transformer

type Transformer interface {
	// Transform transforms the data.
	//
	// Failures should never happen in the CLI tool as we run the files
	// through protoc first, but this is done because we want to verify
	// code correctness here and protect against the bad case.
	Transform(filename string, data []byte) ([]byte, []*text.Failure, error)
}

Transformer transforms an input file into an output file.

func NewTransformer

func NewTransformer(options ...TransformerOption) Transformer

NewTransformer returns a new Transformer.

type TransformerOption

type TransformerOption func(*transformer)

TransformerOption is an option for a new Transformer.

func TransformerWithFix

func TransformerWithFix() TransformerOption

TransformerWithFix returns a TransformerOption that will update the file options go_package, java_package to match the package per the guidelines of the style guide.

func TransformerWithLogger

func TransformerWithLogger(logger *zap.Logger) TransformerOption

TransformerWithLogger returns a TransformerOption that uses the given logger.

The default is to use zap.NewNop().