scribe

Documentation

Index

• Variables
• type Bar
  • func NewBar(w io.Writer) *Bar
  • func (b *Bar) Finish()
  • func (b *Bar) Increment()
  • func (b *Bar) Start()
• type Color
  • func NewColor(bold bool, fg, bg int) Color
• type Emitter
  • func NewEmitter(output io.Writer) Emitter
  • func (e Emitter) Candidates(entries []packit.BuildpackPlanEntry)
  • func (e Emitter) EnvironmentVariables(layer packit.Layer)
  • func (e Emitter) LaunchProcesses(processes []packit.Process, processEnvs ...map[string]packit.Environment)
  • func (e Emitter) SelectedDependency(entry packit.BuildpackPlanEntry, dependency postal.Dependency, now time.Time)
• type FormattedList
  • func (l FormattedList) String() string
• type FormattedMap
  • func NewFormattedMapFromEnvironment(environment packit.Environment) FormattedMap
  • func (m FormattedMap) String() string
• type Logger
  • func NewLogger(writer io.Writer) Logger
  • func (l Logger) Action(format string, v ...interface{})
  • func (l Logger) Break()
  • func (l Logger) Detail(format string, v ...interface{})
  • func (l Logger) Process(format string, v ...interface{})
  • func (l Logger) Subdetail(format string, v ...interface{})
  • func (l Logger) Subprocess(format string, v ...interface{})
  • func (l Logger) Title(format string, v ...interface{})
• type Option
  • func WithColor(color Color) Option
  • func WithIndent(indent int) Option
• type Writer
  • func NewWriter(writer io.Writer, options ...Option) Writer
  • func (w Writer) Write(b []byte) (int, error)

Variables

var (
	BlackColor   = NewColor(false, 0, -1)
	RedColor     = NewColor(false, 1, -1)
	GreenColor   = NewColor(false, 2, -1)
	YellowColor  = NewColor(false, 3, -1)
	BlueColor    = NewColor(false, 4, -1)
	MagentaColor = NewColor(false, 5, -1)
	CyanColor    = NewColor(false, 6, -1)
	WhiteColor   = NewColor(false, 7, -1)
	GrayColor    = NewColor(false, 244, -1)
)

Types

type Bar

type Bar struct {
	// contains filtered or unexported fields
}

func NewBar

func NewBar(w io.Writer) *Bar

func (*Bar) Finish

func (b *Bar) Finish()

func (*Bar) Increment

func (b *Bar) Increment()

func (*Bar) Start

func (b *Bar) Start()

type Color

type Color func(message string) string

func NewColor

func NewColor(bold bool, fg, bg int) Color

type Emitter

type Emitter struct {
	// Logger is embedded and therefore delegates all of its functions to the
	// Emitter.
	Logger
}

func NewEmitter

func NewEmitter(output io.Writer) Emitter

func (Emitter) Candidates

func (e Emitter) Candidates(entries []packit.BuildpackPlanEntry)

func (Emitter) EnvironmentVariables

func (e Emitter) EnvironmentVariables(layer packit.Layer)

func (Emitter) LaunchProcesses

func (e Emitter) LaunchProcesses(processes []packit.Process, processEnvs ...map[string]packit.Environment)

func (Emitter) SelectedDependency

func (e Emitter) SelectedDependency(entry packit.BuildpackPlanEntry, dependency postal.Dependency, now time.Time)

type FormattedList

type FormattedList []string

func (FormattedList) String

func (l FormattedList) String() string

type FormattedMap

type FormattedMap map[string]interface{}

func NewFormattedMapFromEnvironment

func NewFormattedMapFromEnvironment(environment packit.Environment) FormattedMap

func (FormattedMap) String

func (m FormattedMap) String() string

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

func NewLogger

func NewLogger(writer io.Writer) Logger

func (Logger) Action

func (l Logger) Action(format string, v ...interface{})

func (Logger) Break

func (l Logger) Break()

func (Logger) Detail

func (l Logger) Detail(format string, v ...interface{})

func (Logger) Process

func (l Logger) Process(format string, v ...interface{})

func (Logger) Subdetail

func (l Logger) Subdetail(format string, v ...interface{})

func (Logger) Subprocess

func (l Logger) Subprocess(format string, v ...interface{})

func (Logger) Title

func (l Logger) Title(format string, v ...interface{})

type Option

type Option func(Writer) Writer

func WithColor

func WithColor(color Color) Option

func WithIndent

func WithIndent(indent int) Option

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

func NewWriter

func NewWriter(writer io.Writer, options ...Option) Writer

func (Writer) Write

func (w Writer) Write(b []byte) (int, error)