bufgen

Documentation

Overview

Package bufgen does configuration-based generation.

It is used by the buf generate command.

Index

• type GenerateOption
  • func GenerateWithBaseOutDirPath(baseOutDirPath string) GenerateOption
  • func GenerateWithDeleteOuts() GenerateOption
  • func GenerateWithIncludeImportsOverride(includeImports bool) GenerateOption
  • func GenerateWithIncludeWellKnownTypesOverride(includeWellKnownTypes bool) GenerateOption
• type Generator
  • func NewGenerator(logger *zap.Logger, tracer tracing.Tracer, ...) Generator
• type Strategy
  • func ParseStrategy(s string) (Strategy, error)
  • func (s Strategy) String() string

Types

type GenerateOption

type GenerateOption func(*generateOptions)

GenerateOption is an option for Generate.

func GenerateWithBaseOutDirPath

func GenerateWithBaseOutDirPath(baseOutDirPath string) GenerateOption

GenerateWithBaseOutDirPath returns a new GenerateOption that uses the given base directory as the output directory.

The default is to use the current directory.

func GenerateWithDeleteOuts

func GenerateWithDeleteOuts() GenerateOption

GenerateWithDeleteOuts returns a new GenerateOption that results in the output directories, zip files, or jar files being deleted before generation is run.

func GenerateWithIncludeImportsOverride

func GenerateWithIncludeImportsOverride(includeImports bool) GenerateOption

GenerateWithIncludeImportsOverride is a strict override on whether imports are generated. This overrides IncludeImports from the GeneratePluginConfig.

This option has presence, i.e. setting this option to false is not the same as not setting it, as the latter does not override the config.

Note that this does NOT result in the Well-Known Types being generated when set to true, use GenerateWithIncludeWellKnownTypes to include the Well-Known Types.

func GenerateWithIncludeWellKnownTypesOverride

func GenerateWithIncludeWellKnownTypesOverride(includeWellKnownTypes bool) GenerateOption

GenerateWithIncludeWellKnownTypesOverride is a strict override on whether the well known types are generated. This overrides IncludeWKT from the GeneratePluginConfig.

This option has presence, i.e. setting this option to false is not the same as not setting it, as the latter does not override the config.

Setting this option to true has no effect if GenerateWithIncludeImports is not set to true.

type Generator

type Generator interface {
	// Generate calls the generation logic.
	//
	// The config is assumed to be valid. If created by ReadConfig, it will
	// always be valid.
	Generate(
		ctx context.Context,
		container app.EnvStdioContainer,
		config bufconfig.GenerateConfig,
		images []bufimage.Image,
		options ...GenerateOption,
	) error
}

Generator generates Protobuf stubs based on configurations.

func NewGenerator

func NewGenerator(
	logger *zap.Logger,
	tracer tracing.Tracer,
	storageosProvider storageos.Provider,
	runner command.Runner,

	clientConfig *connectclient.Config,
) Generator

NewGenerator returns a new Generator.

type Strategy

type Strategy int

Strategy is a generation stategy.

const (
	// StrategyDirectory is the strategy that says to generate per directory.
	//
	// This is the default value.
	StrategyDirectory Strategy = 1
	// StrategyAll is the strategy that says to generate with all files at once.
	StrategyAll Strategy = 2
)

func ParseStrategy

func ParseStrategy(s string) (Strategy, error)

ParseStrategy parses the Strategy.

If the empty string is provided, this is interpreted as StrategyDirectory.

func (Strategy) String

func (s Strategy) String() string

String implements fmt.Stringer.