bufcli

Documentation

Index

• Constants
• func BindAsFileDescriptorSet(flagSet *pflag.FlagSet, addr *bool, flagName string)
• func BindExcludeImports(flagSet *pflag.FlagSet, addr *bool, flagName string)
• func BindExcludeSourceInfo(flagSet *pflag.FlagSet, addr *bool, flagName string)
• func BindInputHashtag(flagSet *pflag.FlagSet, addr *string)
• func BindPaths(flagSet *pflag.FlagSet, pathsAddr *[]string, pathsFlagName string)
• func BindPathsAndDeprecatedFiles(flagSet *pflag.FlagSet, pathsAddr *[]string, pathsFlagName string, ...)
• func GetInputLong(inputArgDescription string) string
• func GetInputValue(container appflag.Container, inputHashtag string, deprecatedFlag string, ...) (string, error)
• func GetSourceOrModuleLong(inputArgDescription string) string
• func GetStringFlagOrDeprecatedFlag(flag string, flagName string, deprecatedFlag string, deprecatedFlagName string) (string, error)
• func GetStringSliceFlagOrDeprecatedFlag(flag []string, flagName string, deprecatedFlag []string, ...) ([]string, error)
• func NewFetchImageReader(logger *zap.Logger, storageosProvider storageos.Provider) buffetch.ImageReader
• func NewFetchReader(logger *zap.Logger, storageosProvider storageos.Provider, ...) buffetch.Reader
• func NewFetchSourceReader(logger *zap.Logger, storageosProvider storageos.Provider) buffetch.SourceReader
• func NewWireFileLister(logger *zap.Logger, storageosProvider storageos.Provider, ...) bufwire.FileLister
• func NewWireImageConfigReader(logger *zap.Logger, storageosProvider storageos.Provider, ...) bufwire.ImageConfigReader
• func NewWireImageReader(logger *zap.Logger, storageosProvider storageos.Provider) bufwire.ImageReader
• func NewWireImageWriter(logger *zap.Logger) bufwire.ImageWriter
• func NewWireModuleConfigReader(logger *zap.Logger, storageosProvider storageos.Provider, ...) bufwire.ModuleConfigReader
• type ModuleResolverReaderProvider
• type NopModuleResolverReaderProvider
  • func (NopModuleResolverReaderProvider) GetModuleReader(_ context.Context, _ appflag.Container) (bufmodule.ModuleReader, error)
  • func (NopModuleResolverReaderProvider) GetModuleResolver(_ context.Context, _ appflag.Container) (bufmodule.ModuleResolver, error)

Constants

const (
	// FlagDeprecationMessageSuffix is the suffix for flag deprecation messages.
	FlagDeprecationMessageSuffix = `
We recommend migrating, however this flag continues to work.
See https://docs.buf.build/faq for more details.`
)

Functions

func BindAsFileDescriptorSet

func BindAsFileDescriptorSet(flagSet *pflag.FlagSet, addr *bool, flagName string)

BindAsFileDescriptorSet binds the exclude-imports flag.

func BindExcludeImports

func BindExcludeImports(flagSet *pflag.FlagSet, addr *bool, flagName string)

BindExcludeImports binds the exclude-imports flag.

func BindExcludeSourceInfo

func BindExcludeSourceInfo(flagSet *pflag.FlagSet, addr *bool, flagName string)

BindExcludeSourceInfo binds the exclude-source-info flag.

func BindInputHashtag

func BindInputHashtag(flagSet *pflag.FlagSet, addr *string)

BindInputHashtag binds the input hashtag flag.

This needs to be added to any command that has the input as the first argument. This deals with the situation "buf build -#format=json" which results in a parse error from pflag.

func BindPaths

func BindPaths(
	flagSet *pflag.FlagSet,
	pathsAddr *[]string,
	pathsFlagName string,
)

BindPaths binds the paths flag.

func BindPathsAndDeprecatedFiles

func BindPathsAndDeprecatedFiles(
	flagSet *pflag.FlagSet,
	pathsAddr *[]string,
	pathsFlagName string,
	filesAddr *[]string,
	filesFlagName string,
)

BindPathAndDeprecatedFiles binds the paths flag and the deprecated files flag.

func GetInputLong

func GetInputLong(inputArgDescription string) string

GetInputLong gets the long command description for an input-based command.

func GetInputValue

func GetInputValue(
	container appflag.Container,
	inputHashtag string,
	deprecatedFlag string,
	deprecatedFlagName string,
	defaultValue string,
) (string, error)

GetInputValue gets either the first arg or the deprecated flag, but not both.

Also parses the special input hashtag flag that deals with the situation "buf build -#format=json". The existence of 0 or 1 args should be handled by the Args field on Command.

func GetSourceOrModuleLong

func GetSourceOrModuleLong(inputArgDescription string) string

GetSourceOrModuleLong gets the long command description for an input-based command.

func GetStringFlagOrDeprecatedFlag

func GetStringFlagOrDeprecatedFlag(
	flag string,
	flagName string,
	deprecatedFlag string,
	deprecatedFlagName string,
) (string, error)

GetStringFlagOrDeprecatedFlag gets the flag, or the deprecated flag.

func GetStringSliceFlagOrDeprecatedFlag

func GetStringSliceFlagOrDeprecatedFlag(
	flag []string,
	flagName string,
	deprecatedFlag []string,
	deprecatedFlagName string,
) ([]string, error)

GetStringSliceFlagOrDeprecatedFlag gets the flag, or the deprecated flag.

func NewFetchImageReader

func NewFetchImageReader(
	logger *zap.Logger,
	storageosProvider storageos.Provider,
) buffetch.ImageReader

NewFetchImageReader creates a new buffetch.ImageReader with the default HTTP client and git cloner.

func NewFetchReader

func NewFetchReader(
	logger *zap.Logger,
	storageosProvider storageos.Provider,
	moduleResolver bufmodule.ModuleResolver,
	moduleReader bufmodule.ModuleReader,
) buffetch.Reader

NewFetchReader creates a new buffetch.Reader with the default HTTP client and git cloner.

func NewFetchSourceReader

func NewFetchSourceReader(
	logger *zap.Logger,
	storageosProvider storageos.Provider,
) buffetch.SourceReader

NewFetchSourceReader creates a new buffetch.SourceReader with the default HTTP client and git cloner.

func NewWireFileLister

func NewWireFileLister(
	logger *zap.Logger,
	storageosProvider storageos.Provider,
	configProvider bufconfig.Provider,
	moduleResolver bufmodule.ModuleResolver,
	moduleReader bufmodule.ModuleReader,
) bufwire.FileLister

NewWireFileLister returns a new FileLister.

func NewWireImageConfigReader

func NewWireImageConfigReader(
	logger *zap.Logger,
	storageosProvider storageos.Provider,
	configProvider bufconfig.Provider,
	moduleResolver bufmodule.ModuleResolver,
	moduleReader bufmodule.ModuleReader,
) bufwire.ImageConfigReader

NewWireImageConfigReader returns a new ImageConfigReader.

func NewWireImageReader

func NewWireImageReader(
	logger *zap.Logger,
	storageosProvider storageos.Provider,
) bufwire.ImageReader

NewWireImageReader returns a new ImageReader.

func NewWireImageWriter

func NewWireImageWriter(
	logger *zap.Logger,
) bufwire.ImageWriter

NewWireImageWriter returns a new ImageWriter.

func NewWireModuleConfigReader

func NewWireModuleConfigReader(
	logger *zap.Logger,
	storageosProvider storageos.Provider,
	configProvider bufconfig.Provider,
	moduleResolver bufmodule.ModuleResolver,
	moduleReader bufmodule.ModuleReader,
) bufwire.ModuleConfigReader

NewWireModuleConfigReader returns a new ModuleConfigReader.

Types

type ModuleResolverReaderProvider

type ModuleResolverReaderProvider interface {
	GetModuleReader(context.Context, appflag.Container) (bufmodule.ModuleReader, error)
	GetModuleResolver(context.Context, appflag.Container) (bufmodule.ModuleResolver, error)
}

ModuleResolverReaderProvider provides ModuleResolvers and ModuleReaders.

type NopModuleResolverReaderProvider

type NopModuleResolverReaderProvider struct{}

NopModuleResolverReaderProvider is a no-op ModuleResolverReaderProvider.

func (NopModuleResolverReaderProvider) GetModuleReader

func (NopModuleResolverReaderProvider) GetModuleReader(_ context.Context, _ appflag.Container) (bufmodule.ModuleReader, error)

GetModuleReader returns a no-op module reader.

func (NopModuleResolverReaderProvider) GetModuleResolver

func (NopModuleResolverReaderProvider) GetModuleResolver(_ context.Context, _ appflag.Container) (bufmodule.ModuleResolver, error)

GetModuleResolver returns a no-op module resolver.