grapicmd

Documentation

Index

• Variables
• func ProvideExecer(c *Ctx) exec.Interface
• func ProvideFS(c *Ctx) afero.Fs
• func ProvideIO(c *Ctx) *cli.IO
• func ProvideProtocConfig(c *Ctx) *protoc.Config
• func ProvideRootDir(c *Ctx) cli.RootDir
• func ProvideViper(c *Ctx) *viper.Viper
• type BuildConfig
  • func ProvideBuildConfig(c *Ctx) *BuildConfig
• type Config
  • func ProvideConfig(c *Ctx) *Config
• type Ctx
  • func (c *Ctx) Init() error
  • func (c *Ctx) IsInsideApp() bool

Variables

var CtxSet = wire.NewSet(
	ProvideFS,
	ProvideViper,
	ProvideExecer,
	ProvideIO,
	ProvideRootDir,
	ProvideConfig,
	ProvideBuildConfig,
	ProvideProtocConfig,
)

CtxSet is a provider set that includes modules contained in Ctx.

Functions

func ProvideExecer

func ProvideExecer(c *Ctx) exec.Interface

func ProvideFS

func ProvideFS(c *Ctx) afero.Fs

func ProvideIO

func ProvideIO(c *Ctx) *cli.IO

func ProvideProtocConfig

func ProvideProtocConfig(c *Ctx) *protoc.Config

func ProvideRootDir

func ProvideRootDir(c *Ctx) cli.RootDir

func ProvideViper

func ProvideViper(c *Ctx) *viper.Viper

Types

type BuildConfig

type BuildConfig struct {
	AppName   string
	Version   string
	Revision  string
	BuildDate string
	Prebuilt  bool
}

BuildConfig contains the build metadata.

func ProvideBuildConfig

func ProvideBuildConfig(c *Ctx) *BuildConfig

type Config

type Config struct {
	Package string
	Grapi   struct {
		ServerDir string
	}
}

Config stores general setting params and provides accessors for them.

func ProvideConfig

func ProvideConfig(c *Ctx) *Config

type Ctx

type Ctx struct {
	FS     afero.Fs
	Viper  *viper.Viper
	Execer exec.Interface
	IO     *cli.IO

	RootDir cli.RootDir

	Config       Config
	Build        BuildConfig
	ProtocConfig protoc.Config
	// contains filtered or unexported fields
}

Ctx contains the runtime context of grpai.

func (*Ctx) Init

func (c *Ctx) Init() error

Init initializes the runtime context.

func (*Ctx) IsInsideApp

func (c *Ctx) IsInsideApp() bool

IsInsideApp returns true if the current working directory is inside a grapi project.