grift

Documentation

Index

• type Command
  • func (c Command) FindRoot() string
  • func (c Command) HelpText() string
  • func (c Command) Name() string
  • func (c Command) ParentName() string
  • func (c *Command) Run(ctx context.Context, root string, args []string) error
• type Generator
  • func (g Generator) Generate(ctx context.Context, root string, args []string) error
  • func (g Generator) InvocationName() string
  • func (g Generator) Name() string
• type Initializer
  • func (i Initializer) Initialize(ctx context.Context, options new.Options) error
  • func (i Initializer) Name() string

Types

type Command

type Command struct{}

Grift command is a root command to run tasks usage is ox task [name]. If no name is passed this will list the tasks

func (Command) FindRoot

func (c Command) FindRoot() string

func (Command) HelpText

func (c Command) HelpText() string

func (Command) Name

func (c Command) Name() string

func (Command) ParentName

func (c Command) ParentName() string

func (*Command) Run

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

type Generator

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

func (Generator) Generate

func (g Generator) Generate(ctx context.Context, root string, args []string) error

func (Generator) InvocationName

func (g Generator) InvocationName() string

InvocationName is used to identify the generator when the generate command is called.

func (Generator) Name

func (g Generator) Name() string

Name returns the name of the plugin

type Initializer

type Initializer struct{}

func (Initializer) Initialize

func (i Initializer) Initialize(ctx context.Context, options new.Options) error

func (Initializer) Name

func (i Initializer) Name() string