module

Documentation

Index

• type Command
• type CommandFactory
• type CommandGenerator
• type Generator
• type ProjectGenerator
• type Script
• type ScriptLoader
• type ServiceGenerationConfig
• type ServiceGenerator
• type UI

Types

type Command

type Command interface {
	SetDir(dir string) Command
	AddEnv(key, value string) Command
	ConnectIO() Command
	Exec() ([]byte, error)
}

Command is an interface of executable and configurable command object.

type CommandFactory

type CommandFactory interface {
	Create(nameAndArgs []string) Command
}

CommandFactory is an interface for executing commands.

type CommandGenerator

type CommandGenerator interface {
	GenerateCommand(name string) error
	DestroyCommand(name string) error
}

CommandGenerator is an interface to create or destroy user-defined command tempates.

type Generator

type Generator interface {
	ProjectGenerator
	ServiceGenerator
	CommandGenerator
}

Generator creates files from templates and given params.

type ProjectGenerator

type ProjectGenerator interface {
	GenerateProject(rootDir string, useHead bool) error
}

ProjectGenerator is an interface to build a new project.

type Script

type Script interface {
	Name() string
	Build(args ...string) error
	Run(args ...string) error
}

Script represents an user-defined command.

type ScriptLoader

type ScriptLoader interface {
	Load(dir string) error
	Get(name string) (script Script, ok bool)
	Names() []string
}

ScriptLoader is a factory object for creating Script objects.

type ServiceGenerationConfig

type ServiceGenerationConfig struct {
	ResourceName string
	Methods      []string
	SkipTest     bool
}

ServiceGenerationConfig contains configurations for generating a new service.

type ServiceGenerator

type ServiceGenerator interface {
	GenerateService(name string, cfg ServiceGenerationConfig) error
	ScaffoldService(name string, cfg ServiceGenerationConfig) error
	DestroyService(name string) error
}

ServiceGenerator is an interface to create or destroy gRPC services and implementations.

type UI

type UI interface {
	Output(msg string)
	Section(msg string)
	Subsection(msg string)
	Warn(msg string)
	Error(msg string)
	ItemSuccess(msg string)
	ItemSkipped(msg string)
	ItemFailure(msg string)
	Confirm(msg string) (bool, error)
}

UI is an interface for intaracting with the terminal.