generator

README

Generator

Usage

Put a gommon.yml in folder, gommon will traverse folders and generate go file based on instruction

Supported generators

• logger, generate methods to match log.LoggableStruct interface
• go template, render template using text/template
• shell, call external commands like protoc

loggers:
  - struct: "*Server"
    receiver: srv
gotmpls:
    - src: abc.go.tmpl
      dst: abc.go
      data:
        foo: bar

NOTE

• remember to quote string with * in YAML, *Foo means reference while "*Foo" is a normal string

TODO

logger

• use assert in test
• generate interface check
• return error in Render, better error handling
• write to buffer and then run go format like https://github.com/dyweb/Ayi/blob/master/cmd/gotmpl.go

gotmpl

• replace Ayi's gotmpl

shell

• support using sh -c

Documentation

Overview

Package generator render go template, call external commands, generate gommon specific methods based on gommon.yml

Index

• func DefaultIgnores() *fsutil.Ignores
• func Generate(root string) error
• func GenerateSingle(file string) error
• func Header(generator string, template string) string
• type Config
  • func NewConfig(pkg string, file string) *Config
  • func (c *Config) RenderGoTemplate(root string) error
  • func (c *Config) RenderGommon() ([]byte, error)
  • func (c *Config) RenderShell(root string) error
• type GoTemplateConfig
  • func (c *GoTemplateConfig) Render(root string) error
• type LoggerConfig
  • func (c *LoggerConfig) RenderTo(w io.Writer) error
• type ShellConfig
  • func (c *ShellConfig) Render(root string) error

Functions

func DefaultIgnores

func DefaultIgnores() *fsutil.Ignores

func Generate

func Generate(root string) error

func GenerateSingle

func GenerateSingle(file string) error

func Header

func Header(generator string, template string) string

Types

type Config

type Config struct {
	Loggers     []LoggerConfig     `yaml:"loggers"`
	GoTemplates []GoTemplateConfig `yaml:"gotmpls"`
	Shells      []ShellConfig      `yaml:"shells"`
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig(pkg string, file string) *Config

func (*Config) RenderGoTemplate

func (c *Config) RenderGoTemplate(root string) error

func (*Config) RenderGommon

func (c *Config) RenderGommon() ([]byte, error)

func (*Config) RenderShell

func (c *Config) RenderShell(root string) error

type GoTemplateConfig

type GoTemplateConfig struct {
	Src  string      `yaml:"src"`
	Dst  string      `yaml:"dst"`
	Go   bool        `yaml:"go"`
	Data interface{} `yaml:"data"`
}

func (*GoTemplateConfig) Render

func (c *GoTemplateConfig) Render(root string) error

type LoggerConfig

type LoggerConfig struct {
	Struct   string `yaml:"struct"`
	Receiver string `yaml:"receiver"`
}

func (*LoggerConfig) RenderTo

func (c *LoggerConfig) RenderTo(w io.Writer) error

type ShellConfig

type ShellConfig struct {
	Code  string `yaml:"code"`
	Shell bool   `yaml:"shell"`
	Cd    bool   `yaml:"cd"`
}

https://github.com/dyweb/gommon/issues/53

func (*ShellConfig) Render

func (c *ShellConfig) Render(root string) error