generator

Documentation

Index

• Constants
• Variables
• func AddCobraCommands(parent *cobra.Command, generators []Generator)
• func ExecuteTemplate(content string, data interface{}) (string, error)
• func WriteFile(file *CodeFile, overwrite bool) (bool, error)
• func WriteFiles(files []CodeFile, overwrite bool, processedFile ProcessedFileCallback) error
• type Arg
• type CodeFile
• type Config
• type Generator
• type GeneratorArg
• type GeneratorArgsValues
• type GeneratorFunc
• type ProcessedFileCallback
• type Sources
  • func NewSources() *Sources
  • func (sources *Sources) AddGenerated(files ...*CodeFile)
  • func (sources *Sources) AddGeneratedAll(files []CodeFile)
  • func (sources *Sources) AddScaffolded(files ...*CodeFile)
  • func (sources *Sources) AddScaffoldedAll(files []CodeFile)
  • func (sources *Sources) Write(overwriteAll bool, processedFile ProcessedFileCallback) error
• type Writer
  • func NewWriter(config Config) Writer

Constants

const Client = "client"

const ClientDescription = "client HTTP library"

const ClientTitle = "Client library"

const GeneratePath = "generate-path"

const GeneratePathDescription = "path to generate source code into"

const GeneratePathTitle = "Generate path"

const Jsonlib = "jsonlib"

const JsonlibDescription = "json serialization/deserialization library"

const JsonlibTitle = "JSON library"

const Jsonmode = "jsonmode"

const JsonmodeDescription = "json serialization/deserialization mode"

const JsonmodeTitle = "JSON mode"

const ModuleName = "module-name"

const ModuleNameDescription = "module name"

const ModuleNameTitle = "Module name"

const OutFile = "out-file"

const OutFileDescription = "path to output file"

const OutFileTitle = "Output file path"

const PackageName = "package-name"

const PackageNameDescription = "package name"

const PackageNameTitle = "Package name"

const Server = "server"

const ServerDescription = "server HTTP library/framework"

const ServerTitle = "Server library"

const ServicesPath = "services-path"

const ServicesPathDescription = "path to scaffold services code"

const ServicesPathTitle = "Services path"

const SpecFile = "spec-file"

const SpecFileDescription = "path to specification file"

const SpecFileTitle = "Spec file path"

const SwaggerPath = "swagger-path"

const SwaggerPathDescription = "path of generated OpenAPI (Swagger) specification file"

const SwaggerPathTitle = "Swagger path"

const Validation = "validation"

const ValidationDescription = "type validation library"

const ValidationTitle = "Type validation library"

Variables

var ArgClient = Arg{Client, ClientTitle, ClientDescription}

var ArgGeneratePath = Arg{GeneratePath, GeneratePathTitle, GeneratePathDescription}

var ArgJsonlib = Arg{Jsonlib, JsonlibTitle, JsonlibDescription}

var ArgJsonmode = Arg{Jsonmode, JsonmodeTitle, JsonmodeDescription}

var ArgModuleName = Arg{ModuleName, ModuleNameTitle, ModuleNameDescription}

var ArgOutFile = Arg{OutFile, OutFileTitle, OutFileDescription}

var ArgPackageName = Arg{PackageName, PackageNameTitle, PackageNameDescription}

var ArgServer = Arg{Server, ServerTitle, ServerDescription}

var ArgServicesPath = Arg{ServicesPath, ServicesPathTitle, ServicesPathDescription}

var ArgSpecFile = Arg{SpecFile, SpecFileTitle, SpecFileDescription}

var ArgSwaggerPath = Arg{SwaggerPath, SwaggerPathTitle, SwaggerPathDescription}

var ArgValidation = Arg{Validation, ValidationTitle, ValidationDescription}

Functions

func AddCobraCommands

func AddCobraCommands(parent *cobra.Command, generators []Generator)

func ExecuteTemplate

func ExecuteTemplate(content string, data interface{}) (string, error)

func WriteFile

func WriteFile(file *CodeFile, overwrite bool) (bool, error)

func WriteFiles

func WriteFiles(files []CodeFile, overwrite bool, processedFile ProcessedFileCallback) error

Types

type Arg

type Arg struct {
	Name        string
	Title       string
	Description string
}

type CodeFile

type CodeFile struct {
	Path    string
	Content string
}

type Config

type Config struct {
	IndentationStr            string
	LeadSpacesIndentationSize int
	Substitutions             map[string]string
}

type Generator

type Generator struct {
	Name      string
	Title     string
	Usage     string
	Args      []GeneratorArg
	Generator GeneratorFunc
}

type GeneratorArg

type GeneratorArg struct {
	Arg
	Values   []string
	Required bool
	Default  string
}

type GeneratorArgsValues

type GeneratorArgsValues map[Arg]string

type GeneratorFunc

type GeneratorFunc func(specification *spec.Spec, params GeneratorArgsValues) *Sources

type ProcessedFileCallback

type ProcessedFileCallback func(wrote bool, fullpath string)

type Sources

type Sources struct {
	Generated  []CodeFile
	Scaffolded []CodeFile
}

func NewSources

func NewSources() *Sources

func (*Sources) AddGenerated

func (sources *Sources) AddGenerated(files ...*CodeFile)

func (*Sources) AddGeneratedAll

func (sources *Sources) AddGeneratedAll(files []CodeFile)

func (*Sources) AddScaffolded

func (sources *Sources) AddScaffolded(files ...*CodeFile)

func (*Sources) AddScaffoldedAll

func (sources *Sources) AddScaffoldedAll(files []CodeFile)

func (*Sources) Write

func (sources *Sources) Write(overwriteAll bool, processedFile ProcessedFileCallback) error

type Writer

type Writer interface {
	Line(format string, args ...interface{})
	Lines(format string)
	Template(data map[string]string, content string)
	EmptyLine()
	LineAligned(format string, args ...interface{})
	Indent()
	Unindent()
	IndentWith(size int)
	UnindentWith(size int)
	Indented() Writer
	IndentedWith(size int) Writer
	String() string
	Code() []string
}

func NewWriter

func NewWriter(config Config) Writer