commands

Documentation

Overview

Package commands containers all the commands for the application CLI

Index

• type Controller
  • func (ctrl *Controller) Init(ctx *cli.Context) error
  • func (ctrl *Controller) Lint(pfpath string) error
  • func (ctrl *Controller) List(flags FlagsList) error
  • func (ctrl *Controller) New(args []string, flags FlagsNew) error
  • func (ctrl *Controller) Prepare(e *engine.Engine, src *scaffoldrc.ScaffoldRC)
  • func (ctrl *Controller) RuntimeConfigYAML() (string, error)
  • func (ctrl *Controller) Update(ctx *cli.Context) error
• type ErrList
  • func (e ErrList) Error() string
• type Flags
• type FlagsList
• type FlagsNew
  • func (f FlagsNew) OutputFS() rwfs.WriteFS

Types

type Controller

type Controller struct {
	// Flags contains the CLI flags
	// that are from the root command
	Flags   Flags
	Version string
	// contains filtered or unexported fields
}

func (*Controller) Init

func (ctrl *Controller) Init(ctx *cli.Context) error

func (*Controller) Lint

func (ctrl *Controller) Lint(pfpath string) error

func (*Controller) List

func (ctrl *Controller) List(flags FlagsList) error

func (*Controller) New

func (ctrl *Controller) New(args []string, flags FlagsNew) error

func (*Controller) Prepare

func (ctrl *Controller) Prepare(e *engine.Engine, src *scaffoldrc.ScaffoldRC)

Prepare sets up the controller to be called by the CLI, if the controller is not prepared it will panic

func (*Controller) RuntimeConfigYAML

func (ctrl *Controller) RuntimeConfigYAML() (string, error)

func (*Controller) Update

func (ctrl *Controller) Update(ctx *cli.Context) error

type ErrList

type ErrList []error

func (ErrList) Error

func (e ErrList) Error() string

type Flags

type Flags struct {
	ScaffoldRCPath string
	Cache          string
	ScaffoldDirs   []string
}

type FlagsList

type FlagsList struct {
	OutputDir string
}

type FlagsNew

type FlagsNew struct {
	NoPrompt   bool
	Preset     string
	Snapshot   string
	NoClobber  bool
	ForceApply bool
	OutputDir  string
}

func (FlagsNew) OutputFS

func (f FlagsNew) OutputFS() rwfs.WriteFS

OutputFS returns a WriteFS based on the OutputDir flag