config

Documentation

Index

• Variables
• type Config
  • func Load(dir string) (*Config, error)
  • func LoadSingle(reader io.Reader) (*Config, error)
• type Generator
  • func (g Generator) Code() string
  • func (g Generator) GetParam(key string) (string, bool)
  • func (g Generator) HasPostproc() bool
  • func (g Generator) IsProtoc() bool
  • func (g Generator) OutPath(packageDir string) string
  • func (g Generator) ParamString() string
  • func (g Generator) ParamStringWithOut(packageDir string) string
• type KeyValue

Variables

var ProtocBuiltinLanguages = map[string]bool{
	"cpp":    true,
	"java":   true,
	"python": true,
	"php":    true,
	"ruby":   true,
	"csharp": true,
	"objc":   true,
	"js":     true,
}

from https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/compiler/main.cc hardcode what languages are built-in in protoc, rest must have their own generator binary

Types

type Config

type Config struct {
	Dir           string
	Out           string
	ImportPath    string
	ProtocPath    string
	ProtocVersion string
	Generators    []Generator
}

func Load

func Load(dir string) (*Config, error)

Load will attempt to find the .gunkconfig in the 'dir', working its way up to each parent looking for a .gunkconfig. Currently, Load will only stop when it is unable to go any further up the directory structure or until it finds a 'go.mod' file, or a '.git' file or folder.

Passing in an empty 'dir' will tell Load to look in the current working directory.

func LoadSingle

func LoadSingle(reader io.Reader) (*Config, error)

type Generator

type Generator struct {
	ProtocGen     string // The type of protoc generator that should be run; js, python, etc.
	Command       string
	PluginVersion string // we can pin a protoc-gen-XX version
	Params        []KeyValue
	ConfigDir     string
	Out           string
	JSONPostProc  bool
	FixPaths      bool
	Shortened     bool // only for `gunk vet`
}

func (Generator) Code

func (g Generator) Code() string

func (Generator) GetParam

func (g Generator) GetParam(key string) (string, bool)

func (Generator) HasPostproc

func (g Generator) HasPostproc() bool

func (Generator) IsProtoc

func (g Generator) IsProtoc() bool

func (Generator) OutPath

func (g Generator) OutPath(packageDir string) string

OutPath determines the path for a generator to write generated files to. It will use 'packageDir' if no 'out' key was set in the config.

func (Generator) ParamString

func (g Generator) ParamString() string

func (Generator) ParamStringWithOut

func (g Generator) ParamStringWithOut(packageDir string) string

ParamStringWithOut will return the generator paramaters formatted for protoc, including where protoc should output the generated files. It will use 'packageDir' if no 'out' key was set in the config.

type KeyValue

type KeyValue struct {
	Key   string
	Value string
}