desc

Documentation

Overview

Package desc contains libraries for printing package descriptions.

Index

• type Command
  • func (c Command) GetStdOut() io.Writer
  • func (c Command) Run() error

Types

type Command

type Command struct {
	// StdOut is the StdOut value
	StdOut io.Writer

	// PkgPaths refers to the pkg directories to be described.
	PkgPaths []string

	PrintBasePath bool
}

Command prints information about the given packages.

func (Command) GetStdOut

func (c Command) GetStdOut() io.Writer

GetStdOut returns the io.Writer that will be used as describe stdout.

func (Command) Run

func (c Command) Run() error

Run prints information about given packages in a tabular format. A directory containing KptFile is considered to be a valid package. Invalid packages are ignored.