printer

Documentation

Overview

Package printer defines utilities to display kpt CLI output.

Index

• Variables
• func WithContext(ctx context.Context, pr Printer) context.Context
• type Options
  • func NewOpt() *Options
  • func (opt *Options) Pkg(p types.UniquePath) *Options
  • func (opt *Options) PkgDisplay(p types.DisplayPath) *Options
• type Printer
  • func FromContextOrDie(ctx context.Context) Printer
  • func New(outStream, errStream io.Writer) Printer

Variables

var TruncateOutput bool

TruncateOutput defines should output be truncated

Functions

func WithContext

func WithContext(ctx context.Context, pr Printer) context.Context

WithContext creates new context from the given parent context by setting the printer instance.

Types

type Options

type Options struct {
	// PkgPath is the unique path to the package
	PkgPath types.UniquePath
	// PkgDisplayPath is the display path for the package
	PkgDisplayPath types.DisplayPath
}

Options are optional options for printer

func NewOpt

func NewOpt() *Options

NewOpt returns a pointer to new options

func (*Options) Pkg

func (opt *Options) Pkg(p types.UniquePath) *Options

Pkg sets the package unique path in options

func (*Options) PkgDisplay

func (opt *Options) PkgDisplay(p types.DisplayPath) *Options

PkgDisplayPath sets the package display path in options

type Printer

type Printer interface {
	PrintPackage(pkg *pkg.Pkg, leadingNewline bool)
	Printf(format string, args ...interface{})
	OptPrintf(opt *Options, format string, args ...interface{})
	OutStream() io.Writer
	ErrStream() io.Writer
}

Printer defines capabilities to display content in kpt CLI. The main intention, at the moment, is to abstract away printing output in the CLI so that we can evolve the kpt CLI UX.

func FromContextOrDie

func FromContextOrDie(ctx context.Context) Printer

FromContext returns printer instance associated with the context.

func New

func New(outStream, errStream io.Writer) Printer

New returns an instance of Printer.