generator

Documentation

Index

• type Generator
• type RunOptions
• type RunResult
• type RunValues
• type RunValuesApplication
• type RunValuesGolang

Types

type Generator

type Generator interface {
	Run(context.Context, RunOptions, RunValues) (RunResult, error)
}

Generator is the interface that we are exposing as main for writing plugins.

type RunOptions

type RunOptions struct {
	Override         bool
	WorkingDirectory string
}

RunOptions contains common options for generation process.

type RunResult

type RunResult []string

RunResult contains the slice of string representing list of generated directories and files.

type RunValues

type RunValues struct {
	Application RunValuesApplication
	Golang      RunValuesGolang
}

RunValues contains information for newly generated project such as RunValuesApplication and RunValuesGolang.

type RunValuesApplication

type RunValuesApplication struct {
	Name        string
	Description string
}

RunValuesApplication contains information about name and description of project.

type RunValuesGolang

type RunValuesGolang struct {
	Module  string
	Version string
}

RunValuesGolang contains information about go module name and used golang version.