command

package

v0.0.0-...-63ab0d9 Latest Latest Go to latest Published: Sep 10, 2015 License: MPL-2.0 Imports: 10 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/PolkaBand/polka

Links

Open Source Insights

Documentation ¶

Overview ¶

Package command provides all the commands that can be executed by polka. There is a 1:1 mapping between "polka command" and command.go existing in this package.

Index ¶

func CreateAppRootDir(name string) error
func CreateChildDirs(appDir string)
func CreateNewApp(rootDir string, name string)
func DocArchitecture()
func DocEndpoints()
func DocIntegrations()
func DocResources()
func FindAndExecuteTemplate(currentDir string, templateName string, concept Concept) error
func GetAppDir() (string, error)
func GetEndpoints() []string
func MakeAllEndpoints(currentDir string, conceptName string)
func MakeEndpointDir(currentDir string, concept Concept) (string, error)
func NotInAppDirectoryMessage() string
type Concept
type ConfigCommand
- func (c *ConfigCommand) Help() string
- func (c *ConfigCommand) Run(args []string) int
- func (c *ConfigCommand) Synopsis() string
type DeployCommand
- func (c *DeployCommand) Help() string
- func (c *DeployCommand) Run(args []string) int
- func (c *DeployCommand) Synopsis() string
type DestroyCommand
- func (c *DestroyCommand) Help() string
- func (c *DestroyCommand) Run(args []string) int
- func (c *DestroyCommand) Synopsis() string
type DocCommand
- func (c *DocCommand) Help() string
- func (c *DocCommand) Run(args []string) int
- func (c *DocCommand) Synopsis() string
type GenerateCommand
- func (c *GenerateCommand) Help() string
- func (c *GenerateCommand) Run(args []string) int
- func (c *GenerateCommand) Synopsis() string
type NewCommand
- func (c *NewCommand) Help() string
- func (c *NewCommand) Run(args []string) int
- func (c *NewCommand) Synopsis() string
type PolkaDir
- func (d *PolkaDir) Create() error
type VersionCommand
- func (c *VersionCommand) Help() string
- func (c *VersionCommand) Run(_ []string) int
- func (c *VersionCommand) Synopsis() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CreateAppRootDir ¶

func CreateAppRootDir(name string) error

Create a new app in the absolute location specified by name eg it should be ""/Users/fb3/code/todo" not "todo"

func CreateChildDirs ¶

func CreateChildDirs(appDir string)

func CreateNewApp ¶

func CreateNewApp(rootDir string, name string)

func DocArchitecture ¶

func DocArchitecture()

func DocEndpoints ¶

func DocEndpoints()

func DocIntegrations ¶

func DocIntegrations()

func DocResources ¶

func DocResources()

DocResources emits a summary table

func FindAndExecuteTemplate ¶

func FindAndExecuteTemplate(currentDir string, templateName string, concept Concept) error

func GetAppDir ¶

func GetAppDir() (string, error)

func GetEndpoints ¶

func GetEndpoints() []string

func MakeAllEndpoints ¶

func MakeAllEndpoints(currentDir string, conceptName string)

func MakeEndpointDir ¶

func MakeEndpointDir(currentDir string, concept Concept) (string, error)

func NotInAppDirectoryMessage ¶

func NotInAppDirectoryMessage() string

Types ¶

type Concept ¶

type Concept struct {
	Name string
}

The Concept type contains all the information needed to generate/destroy/etc a given Concept during a command execution.

type ConfigCommand ¶

type ConfigCommand struct {
	Name string
	Ui   cli.Ui
}

func (*ConfigCommand) Help ¶

func (c *ConfigCommand) Help() string

func (*ConfigCommand) Run ¶

func (c *ConfigCommand) Run(args []string) int

func (*ConfigCommand) Synopsis ¶

func (c *ConfigCommand) Synopsis() string

type DeployCommand ¶

type DeployCommand struct {
	Name string
	Ui   cli.Ui
}

func (*DeployCommand) Help ¶

func (c *DeployCommand) Help() string

func (*DeployCommand) Run ¶

func (c *DeployCommand) Run(args []string) int

func (*DeployCommand) Synopsis ¶

func (c *DeployCommand) Synopsis() string

type DestroyCommand ¶

type DestroyCommand struct {
	Name string
	Ui   cli.Ui
}

func (*DestroyCommand) Help ¶

func (c *DestroyCommand) Help() string

func (*DestroyCommand) Run ¶

func (c *DestroyCommand) Run(args []string) int

func (*DestroyCommand) Synopsis ¶

func (c *DestroyCommand) Synopsis() string

type DocCommand ¶

type DocCommand struct {
	Name string
	Ui   cli.Ui
}

func (*DocCommand) Help ¶

func (c *DocCommand) Help() string

func (*DocCommand) Run ¶

func (c *DocCommand) Run(args []string) int

func (*DocCommand) Synopsis ¶

func (c *DocCommand) Synopsis() string

type GenerateCommand ¶

type GenerateCommand struct {
	Name string
	Ui   cli.Ui
}

func (*GenerateCommand) Help ¶

func (c *GenerateCommand) Help() string

func (*GenerateCommand) Run ¶

func (c *GenerateCommand) Run(args []string) int

func (*GenerateCommand) Synopsis ¶

func (c *GenerateCommand) Synopsis() string

type NewCommand ¶

type NewCommand struct {
	Name string
	Ui   cli.Ui
}

func (*NewCommand) Help ¶

func (c *NewCommand) Help() string

func (*NewCommand) Run ¶

func (c *NewCommand) Run(args []string) int

func (*NewCommand) Synopsis ¶

func (c *NewCommand) Synopsis() string

type PolkaDir ¶

type PolkaDir struct {
	RootDir string //root dir absolute path e.g. /Users/fb3/code/todo_app
	DirName string //relative name to RootDir, e.g. app, test, config
}

func (*PolkaDir) Create ¶

func (d *PolkaDir) Create() error

type VersionCommand ¶

type VersionCommand struct {
	Revision          string
	Version           string
	VersionPrerelease string
	Ui                cli.Ui
}

VersionCommand is a Command implementation prints the version.

func (*VersionCommand) Help ¶

func (c *VersionCommand) Help() string

func (*VersionCommand) Run ¶

func (c *VersionCommand) Run(_ []string) int

func (*VersionCommand) Synopsis ¶

func (c *VersionCommand) Synopsis() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL