bufcli

package
v0.53.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 25, 2021 License: Apache-2.0 Imports: 38 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// Version is the CLI version of buf.
	Version = "0.53.0"

	// 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.`
)
View Source 
const (
	// ExitCodeFileAnnotation is the exit code used when we print file annotations.
	//
	// We use a different exit code to be able to distinguish user-parsable errors from
	// system errors.
	ExitCodeFileAnnotation = 100
)

Variables

View Source 
var (

	// AllCacheModuleRelDirPaths are all directory paths for all time concerning the module cache.
	//
	// These are normalized.
	// These are relative to container.CacheDirPath().
	//
	// This variable is used for clearing the cache.
	AllCacheModuleRelDirPaths = []string{
		v1beta1CacheModuleDataRelDirPath,
		v1beta1CacheModuleLockRelDirPath,
		v1CacheModuleDataRelDirPath,
		v1CacheModuleLockRelDirPath,
		v1CacheModuleSumRelDirPath,
	}

	// ErrNotATTY is returned when an input io.Reader is not a TTY where it is expected.
	ErrNotATTY = errors.New("reader was not a TTY as expected")
)
View Source 
var (
	// ErrNoModuleName is used when the user does not specify a module name in their configuration file.
	ErrNoModuleName = errors.New(`please specify a module name in your configuration file with the "name" key`)

	// ErrNoConfigFile is used when the user tries to execute a command without a configuration file.
	ErrNoConfigFile = errors.New(`please define a configuration file in the current directory; you can create one by running "buf mod init"`)

	// ErrFileAnnotation is used when we print file annotations and want to return an error.
	//
	// The app package works on the concept that an error results in a non-zero exit
	// code, and we already print the messages with PrintFileAnnotations, so we do
	// not want to print any additional error message.
	//
	// We also exit with 100 to be able to distinguish user-parsable errors from
	// system errors.
	ErrFileAnnotation = app.NewError(ExitCodeFileAnnotation, "")
)

Functions

func BindAsFileDescriptorSet added in v0.30.1 

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

BindAsFileDescriptorSet binds the exclude-imports flag.

func BindExcludeImports added in v0.30.1 

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

BindExcludeImports binds the exclude-imports flag.

func BindExcludeSourceInfo added in v0.30.1 

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

BindExcludeSourceInfo binds the exclude-source-info flag.

func BindInputHashtag added in v0.30.1 

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 added in v0.31.0 

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

BindPaths binds the paths flag.

func BindPathsAndDeprecatedFiles added in v0.31.0 

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 added in v0.30.1 

func GetInputLong(inputArgDescription string) string

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

func GetInputValue added in v0.30.1 

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 added in v0.30.1 

func GetSourceOrModuleLong(inputArgDescription string) string

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

func GetStringFlagOrDeprecatedFlag added in v0.31.0 

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

GetStringFlagOrDeprecatedFlag gets the flag, or the deprecated flag.

func GetStringSliceFlagOrDeprecatedFlag added in v0.31.0 

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

GetStringSliceFlagOrDeprecatedFlag gets the flag, or the deprecated flag.

func NewBranchOrTagNameAlreadyExistsError added in v0.40.0 

func NewBranchOrTagNameAlreadyExistsError(name string) error

NewBranchOrTagNameAlreadyExistsError informs the user that a branch or tag with that name already exists.

func NewConfig added in v0.37.0 

func NewConfig(container appflag.Container) (*bufapp.Config, error)

NewConfig creates a new Config.

func NewContextModifierProvider added in v0.37.1 

func NewContextModifierProvider(
	container appflag.Container,
) func(string) (func(context.Context) context.Context, error)

NewContextModifierProvider returns a new context modifier provider for API providers.

Public for use in other packages that provide API provider constructors.

func NewErrorInterceptor added in v0.37.1 

func NewErrorInterceptor() appflag.Interceptor

NewErrorInterceptor returns a CLI interceptor that wraps Buf CLI errors.

func NewInternalError added in v0.37.0 

func NewInternalError(err error) error

NewInternalError represents an internal error encountered by the buf CLI. These errors should not happen and therefore warrant a bug report.

func NewModuleReaderAndCreateCacheDirs added in v0.45.0 

func NewModuleReaderAndCreateCacheDirs(
	container appflag.Container,
	registryProvider registryv1alpha1apiclient.Provider,
) (bufmodule.ModuleReader, error)

NewModuleReaderAndCreateCacheDirs returns a new ModuleReader while creating the required cache directories.

func NewModuleRefError added in v0.37.0 

func NewModuleRefError(moduleRef string) error

NewModuleRefError is used when the client fails to parse a module ref.

func NewModuleReferenceNotFoundError added in v0.40.0 

func NewModuleReferenceNotFoundError(reference bufmodule.ModuleReference) error

NewModuleReferenceNotFoundError informs the user that a module reference does not exist.

func NewOrganizationNameAlreadyExistsError added in v0.37.0 

func NewOrganizationNameAlreadyExistsError(name string) error

NewOrganizationNameAlreadyExistsError informs the user that an organization with that name already exists.

func NewOrganizationNotFoundError added in v0.37.0 

func NewOrganizationNotFoundError(name string) error

NewOrganizationNotFoundError informs the user that an organization with that name does not exist.

func NewPluginNotFoundError added in v0.45.0 

func NewPluginNotFoundError(owner string, name string) error

NewPluginNotFoundError informs the user that a plugin with that owner and name does not exist.

func NewRegistryProvider added in v0.37.0 

func NewRegistryProvider(ctx context.Context, container appflag.Container) (registryv1alpha1apiclient.Provider, error)

NewRegistryProvider creates a new registryv1alpha1apiclient.Provider.

func NewRepositoryNameAlreadyExistsError added in v0.37.0 

func NewRepositoryNameAlreadyExistsError(name string) error

NewRepositoryNameAlreadyExistsError informs the user that a repository with that name already exists.

func NewRepositoryNotFoundError added in v0.37.0 

func NewRepositoryNotFoundError(name string) error

NewRepositoryNotFoundError informs the user that a repository with that name does not exist.

func NewTemplateNotFoundError added in v0.45.0 

func NewTemplateNotFoundError(owner string, name string) error

NewTemplateNotFoundError informs the user that a template with that owner and name does not exist.

func NewTokenNotFoundError added in v0.37.0 

func NewTokenNotFoundError(tokenID string) error

NewTokenNotFoundError informs the user that a token with that identifier does not exist.

func NewTooManyEmptyAnswersError added in v0.37.0 

func NewTooManyEmptyAnswersError(attempts int) error

NewTooManyEmptyAnswersError is used when the user does not answer a prompt in the given number of attempts.

func NewUnimplementedRemoteError added in v0.45.0 

func NewUnimplementedRemoteError(err error, remote string, moduleIdentity string) error

func NewWireFileLister added in v0.25.0 

func NewWireFileLister(
	container appflag.Container,
	storageosProvider storageos.Provider,
	registryProvider registryv1alpha1apiclient.Provider,
) (bufwire.FileLister, error)

NewWireFileLister returns a new FileLister.

func NewWireImageConfigReader added in v0.30.1 

func NewWireImageConfigReader(
	container appflag.Container,
	storageosProvider storageos.Provider,
	registryProvider registryv1alpha1apiclient.Provider,
) (bufwire.ImageConfigReader, error)

NewWireImageConfigReader returns a new ImageConfigReader.

func NewWireImageReader added in v0.25.0 

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

NewWireImageReader returns a new ImageReader.

func NewWireImageWriter added in v0.25.0 

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

NewWireImageWriter returns a new ImageWriter.

func NewWireModuleConfigReader added in v0.30.1 

func NewWireModuleConfigReader(
	container appflag.Container,
	storageosProvider storageos.Provider,
	registryProvider registryv1alpha1apiclient.Provider,
) (bufwire.ModuleConfigReader, error)

NewWireModuleConfigReader returns a new ModuleConfigReader.

func NewWireModuleConfigReaderForModuleReader added in v0.48.0 

func NewWireModuleConfigReaderForModuleReader(
	container appflag.Container,
	storageosProvider storageos.Provider,
	registryProvider registryv1alpha1apiclient.Provider,
	moduleReader bufmodule.ModuleReader,
) (bufwire.ModuleConfigReader, error)

NewWireModuleConfigReaderForModuleReader returns a new ModuleConfigReader using the given ModuleReader.

func PromptUser added in v0.46.0 

func PromptUser(container app.Container, prompt string) (string, error)

PromptUser reads a line from Stdin, prompting the user with the prompt first. The prompt is repeatedly shown until the user provides a non-empty response. ErrNotATTY is returned if the input containers Stdin is not a terminal.

func PromptUserForDelete added in v0.37.0 

func PromptUserForDelete(container app.Container, entityType string, expectedAnswer string) error

PromptUserForDelete is used to receieve user confirmation that a specific entity should be deleted. If the user's answer does not match the expected answer, an error is returned. ErrNotATTY is returned if the input containers Stdin is not a terminal.

func PromptUserForPassword added in v0.46.0 

func PromptUserForPassword(container app.Container, prompt string) (string, error)

PromptUserForPassword reads a line from Stdin, prompting the user with the prompt first. The prompt is repeatedly shown until the user provides a non-empty response. ErrNotATTY is returned if the input containers Stdin is not a terminal.

func ReadModuleWithWorkspacesDisabled added in v0.45.0 

func ReadModuleWithWorkspacesDisabled(
	ctx context.Context,
	container appflag.Container,
	storageosProvider storageos.Provider,
	source string,
) (bufmodule.Module, bufmodule.ModuleIdentity, error)

ReadModuleWithWorkspacesDisabled gets a module from a source ref.

Workspaces are disabled for this function.

func ValidateErrorFormatFlag added in v0.46.0 

func ValidateErrorFormatFlag(errorFormatString string, errorFormatFlagName string) error

ValidateErrorFormatFlag validates the error format flag for all commands but lint.

func ValidateErrorFormatFlagLint added in v0.46.0 

func ValidateErrorFormatFlagLint(errorFormatString string, errorFormatFlagName string) error

ValidateErrorFormatFlagLint validates the error format flag for lint.

Types

type GlobalFlags added in v0.45.0 

type GlobalFlags struct{}

GlobalFlags contains global flags for buf commands.

func NewGlobalFlags added in v0.45.0 

func NewGlobalFlags() *GlobalFlags

NewGlobalFlags creates a new GlobalFlags with default values..

func (*GlobalFlags) BindRoot added in v0.45.0 

func (*GlobalFlags) BindRoot(*pflag.FlagSet)

BindRoot binds the global flags to the root command flag set.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.