format

Documentation

Index

• Constants
• type Transformer
  • func NewTransformer(options ...TransformerOption) Transformer
• type TransformerOption
  • func TransformerWithFileHeader(fileHeader string) TransformerOption
  • func TransformerWithFix(fix int) TransformerOption
  • func TransformerWithJavaPackagePrefix(javaPackagePrefix string) TransformerOption
  • func TransformerWithLogger(logger *zap.Logger) TransformerOption

Constants

const (
	// FixNone says to not do fixing.
	FixNone = 0
	// FixV1 says to do V1 fixing.
	FixV1 = 1
	// FixV2 says to do V2 fixing.
	FixV2 = 2
)

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 TransformerWithFileHeader

func TransformerWithFileHeader(fileHeader string) TransformerOption

TransformerWithFileHeader returns a TransformerOption that will update the file header to match the given file header.

This is only valid if fix is set to a value other than FixNone.

func TransformerWithFix

func TransformerWithFix(fix int) TransformerOption

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

func TransformerWithJavaPackagePrefix

func TransformerWithJavaPackagePrefix(javaPackagePrefix string) TransformerOption

TransformerWithJavaPackagePrefix returns a TransformerOption that will override the Java package prefix.

This is only valid if fix is set to a value other than FixNone.

func TransformerWithLogger

func TransformerWithLogger(logger *zap.Logger) TransformerOption

TransformerWithLogger returns a TransformerOption that uses the given logger.

The default is to use zap.NewNop().