cli

Documentation

Index

• func NewFlagSet(name string) *flag.FlagSet
• type Buffalo
  • func New(ctx context.Context) (*Buffalo, error)
  • func (b *Buffalo) Fix(ctx context.Context, args []string) error
  • func (b *Buffalo) Flags() *flag.FlagSet
  • func (b *Buffalo) Main(ctx context.Context, args []string) error
• type Fixer
• type Generator
• type Plugin
• type Plugins
  • func (plugs Plugins) Fix(ctx context.Context, args []string) error
  • func (plugs Plugins) Generate(ctx context.Context, args []string) error
  • func (plugs Plugins) Len() int
  • func (plugs Plugins) Less(i int, j int) bool
  • func (plugs Plugins) Swap(i int, j int)

Functions

func NewFlagSet

func NewFlagSet(name string) *flag.FlagSet

Types

type Buffalo

type Buffalo struct {
	context.Context

	Stdin   io.Reader
	Stdout  io.Writer
	Stderr  io.Writer
	Plugins Plugins
	// contains filtered or unexported fields
}

Buffalo represents the `buffalo` cli.

func New

func New(ctx context.Context) (*Buffalo, error)

func (*Buffalo) Fix

func (b *Buffalo) Fix(ctx context.Context, args []string) error

func (*Buffalo) Flags

func (b *Buffalo) Flags() *flag.FlagSet

func (*Buffalo) Main

func (b *Buffalo) Main(ctx context.Context, args []string) error

type Fixer

type Fixer interface {
	Fix(ctx context.Context, args []string) error
}

Fixer is an optional interface a plugin can implement to be run with `buffalo fix`. This should update the application to the current version of the plugin. The expectation is fixing of only one major revision.

type Generator

type Generator interface {
	Generate(ctx context.Context, args []string) error
}

Fixer is an optional interface a plugin can implement to be run with `buffalo fix`

type Plugin

type Plugin interface {
	// Name is the name of the plugin.
	// This will also be used for the cli sub-command
	// 	"pop" | "heroku" | "auth" | etc...
	Name() string
}

Plugin is the most basic interface a plugin can implement.

type Plugins

type Plugins []Plugin

func (Plugins) Fix

func (plugs Plugins) Fix(ctx context.Context, args []string) error

Fix runs any Fixers that are in the Plugins. If no arguments are provided it will run all fixers in the Plugins. Otherwise Fix will run the fixers for the arguments provided.

buffalo fix
buffalo fix plush pop
buffalo fix -h

func (Plugins) Generate

func (plugs Plugins) Generate(ctx context.Context, args []string) error

Generate will run the specified generator.

buffalo generate -h
buffalo generate pop ...

func (Plugins) Len

func (plugs Plugins) Len() int

Len is the number of elements in the collection.

func (Plugins) Less

func (plugs Plugins) Less(i int, j int) bool

Less reports whether the element with index i should sort before the element with index j.

func (Plugins) Swap

func (plugs Plugins) Swap(i int, j int)

Swap swaps the elements with indexes i and j.