new

Documentation

Index

• Variables
• type AfterInitializer
• type Command
  • func (d *Command) AppName(args []string) string
  • func (d *Command) FindRoot() string
  • func (d *Command) Flags() *pflag.FlagSet
  • func (d Command) HelpText() string
  • func (d Command) Name() string
  • func (d Command) ParentName() string
  • func (d *Command) ParseFlags(args []string)
  • func (d *Command) Receive(plugins []core.Plugin)
  • func (d *Command) Run(ctx context.Context, root string, args []string) error
• type Initializer
• type Options

Variables

var ErrNoNameProvided = errors.New("the name for the new app is needed")

Types

type AfterInitializer

type AfterInitializer interface {
	// AfterInitialize receives the context and the root folder where
	// the application is being initialized.
	AfterInitialize(context.Context, Options) error
}

AfterInitializer is intended to initialize applications, things that should happen at the end of the application creation process.

type Command

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

Command to generate New applications.

func (*Command) AppName

func (d *Command) AppName(args []string) string

func (*Command) FindRoot

func (d *Command) FindRoot() string

func (*Command) Flags

func (d *Command) Flags() *pflag.FlagSet

func (Command) HelpText

func (d Command) HelpText() string

HelpText returns the help Text of build function

func (Command) Name

func (d Command) Name() string

func (Command) ParentName

func (d Command) ParentName() string

func (*Command) ParseFlags

func (d *Command) ParseFlags(args []string)

func (*Command) Receive

func (d *Command) Receive(plugins []core.Plugin)

Receive and store initializers

func (*Command) Run

func (d *Command) Run(ctx context.Context, root string, args []string) error

Run each of the initializers and afterinitializers to compose the initial ox application.

type Initializer

type Initializer interface {
	// Initialize receives the context and the root folder where
	// the application is being initialized.
	Initialize(context.Context, Options) error
}

Initializer is intended to initialize applications, things like generating files or running commands.

type Options

type Options struct {
	Folder string
	Name   string
	Module string
	Root   string

	Args []string
}

Options that may come handy for the initializers.