bufprint

Documentation

Index

• Variables
• func PrintEntity(writer io.Writer, format Format, entity Entity) error
• func PrintNames(writer io.Writer, format Format, entities ...Entity) error
• func PrintPage(writer io.Writer, format Format, nextPageToken string, nextPageCommand string, ...) error
• func WithTabWriter(writer io.Writer, header []string, f func(TabWriter) error) (retErr error)
• type CuratedPluginPrinter
  • func NewCuratedPluginPrinter(writer io.Writer) CuratedPluginPrinter
• type Entity
  • func NewCommitEntity(commit interface{ ... }, moduleFullName bufparse.FullName) Entity
  • func NewLabelEntity(label interface{ ... }, moduleFullName bufparse.FullName) Entity
  • func NewModuleEntity(module *modulev1.Module, moduleFullName bufparse.FullName) Entity
  • func NewOrganizationEntity(organization *ownerv1.Organization, remote string) Entity
  • func NewPluginEntity(plugin *pluginv1beta1.Plugin, pluginFullName bufparse.FullName) Entity
  • func NewUserEntity(user *registryv1alpha1.User) Entity
• type Format
  • func ParseFormat(s string) (Format, error)
  • func (f Format) String() string
• type StatsPrinter
  • func NewStatsPrinter(writer io.Writer) StatsPrinter
• type TabWriter
• type TokenPrinter
  • func NewTokenPrinter(writer io.Writer, format Format) (TokenPrinter, error)

Variables

var (
	// AllFormatsString is the string representation of all Formats.
	AllFormatsString = stringutil.SliceToString([]string{FormatText.String(), FormatJSON.String()})
)

Functions

func PrintEntity

func PrintEntity(writer io.Writer, format Format, entity Entity) error

PrintEntity prints an entity.

If format is FormatText, this prints the information in a table. If format is FormatJSON, this prints the information as a JSON object.

func PrintNames

func PrintNames(writer io.Writer, format Format, entities ...Entity) error

PrintNames prints entities' names.

If format is FormatJSON, this also prints information about each entity, the same as calling PrintInfo on each entity.

func PrintPage

func PrintPage(
	writer io.Writer,
	format Format,
	nextPageToken string,
	nextPageCommand string,
	entities []Entity,
) error

PrintPage prints a page of entities.

func WithTabWriter

func WithTabWriter(
	writer io.Writer,
	header []string,
	f func(TabWriter) error,
) (retErr error)

WithTabWriter calls a function with a TabWriter.

Shared with internal packages.

Types

type CuratedPluginPrinter

type CuratedPluginPrinter interface {
	PrintCuratedPlugin(ctx context.Context, format Format, plugin *registryv1alpha1.CuratedPlugin) error
	PrintCuratedPlugins(ctx context.Context, format Format, nextPageToken string, plugins ...*registryv1alpha1.CuratedPlugin) error
}

CuratedPluginPrinter is a printer for curated plugins.

func NewCuratedPluginPrinter

func NewCuratedPluginPrinter(writer io.Writer) CuratedPluginPrinter

NewCuratedPluginPrinter returns a new CuratedPluginPrinter.

type Entity

type Entity interface {
	// contains filtered or unexported methods
}

Entity is an entity printed structurally by functions in bufprint package. It's used in "buf registry" commands where the CLI prints a page of entities, such as commits, an entity's info or simply an entity's full name.

When printed by PrintEntity in text format, any field with a field tag in the form of `bufprint:"<field name>[,omitempty]"` is printed.

This means that an implementation of Entity must also be a struct.

func NewCommitEntity

func NewCommitEntity(commit interface {
	GetId() string
	GetCreateTime() *timestamppb.Timestamp
}, moduleFullName bufparse.FullName) Entity

NewCommitEntity returns a new commit entity to print. It takes a commit as an interface to allow for modulev1.Commit and pluginv1beta1.Commit to be passed.

func NewLabelEntity

func NewLabelEntity(label interface {
	GetName() string
	GetCommitId() string
	GetCreateTime() *timestamppb.Timestamp
	GetArchiveTime() *timestamppb.Timestamp
}, moduleFullName bufparse.FullName) Entity

NewLabelEntity returns a new label entity to print. It takes a label as an interface to allow for modulev1.Label and pluginv1beta1.Label to be passed.

func NewModuleEntity

func NewModuleEntity(module *modulev1.Module, moduleFullName bufparse.FullName) Entity

NewModuleEntity returns a new module entity to print.

func NewOrganizationEntity

func NewOrganizationEntity(organization *ownerv1.Organization, remote string) Entity

NewOrganizationEntity returns a new organization entity to print.

func NewPluginEntity

func NewPluginEntity(plugin *pluginv1beta1.Plugin, pluginFullName bufparse.FullName) Entity

NewPluginEntity returns a new plugin entity to print.

func NewUserEntity

func NewUserEntity(user *registryv1alpha1.User) Entity

NewUserEntity returns a new user entity to print.

type Format

type Format int

Format is a format to print.

const (
	// FormatText is the text format.
	FormatText Format = 1
	// FormatJSON is the JSON format.
	FormatJSON Format = 2
)

func ParseFormat

func ParseFormat(s string) (Format, error)

ParseFormat parses the format.

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

func (Format) String

func (f Format) String() string

String implements fmt.Stringer.

type StatsPrinter

type StatsPrinter interface {
	PrintStats(ctx context.Context, format Format, stats *protostat.Stats) error
}

StatsPrinter is a printer of Stats.

func NewStatsPrinter

func NewStatsPrinter(writer io.Writer) StatsPrinter

NewStatsPrinter returns a new StatsPrinter.

type TabWriter

type TabWriter interface {
	Write(values ...string) error
}

TabWriter is a tab writer.

type TokenPrinter

type TokenPrinter interface {
	PrintTokens(ctx context.Context, tokens ...*registryv1alpha1.Token) error
}

TokenPrinter is a token printer.

TODO: update to same format as other printers.

func NewTokenPrinter

func NewTokenPrinter(writer io.Writer, format Format) (TokenPrinter, error)

NewTokenPrinter returns a new TokenPrinter.

TODO: update to same format as other printers.