confgen

Documentation

Index

• Constants
• func AppVersion() string
• func GetMergerImporters(primaryWorkbookPath, sheetName string, merger []string) ([]importer.Importer, error)
• func NewSheetExporter(outputDir string, output *options.OutputConfOption) *sheetExporter
• func NewSheetParser(protoPackage, locationName string, opts *tableaupb.WorksheetOptions) *sheetParser
• func ParseFileOptions(fd protoreflect.FileDescriptor) (string, *tableaupb.WorkbookOptions)
• func ParseMessage(parser *sheetParser, protomsg proto.Message, sheetName string, ...) error
• func ParseMessageOptions(md protoreflect.MessageDescriptor) (string, *tableaupb.WorksheetOptions)
• func PrintPerfStats(gen *Generator)
• type Field
• type Generator
  • func NewGenerator(protoPackage, indir, outdir string, setters ...options.Option) *Generator
  • func NewGeneratorWithOptions(protoPackage, indir, outdir string, opts *options.Options) *Generator
  • func (gen *Generator) GenAll() error
  • func (gen *Generator) GenOneWorkbook(relWorkbookPath string, worksheetName string) (err error)
  • func (gen *Generator) GenWorkbook(relWorkbookPaths ...string) error
  • func (gen *Generator) Generate(relWorkbookPaths ...string) (err error)

Constants

const (
	App     = "confgen"
	Version = "0.4.1"
)

Functions

func AppVersion

func AppVersion() string

func GetMergerImporters

func GetMergerImporters(primaryWorkbookPath, sheetName string, merger []string) ([]importer.Importer, error)

GetMergerImporters gathers all merger importers.

1. support Glob pattern, refer https://pkg.go.dev/path/filepath#Glob
2. exclude self

func NewSheetExporter

func NewSheetExporter(outputDir string, output *options.OutputConfOption) *sheetExporter

func NewSheetParser

func NewSheetParser(protoPackage, locationName string, opts *tableaupb.WorksheetOptions) *sheetParser

func ParseFileOptions

func ParseFileOptions(fd protoreflect.FileDescriptor) (string, *tableaupb.WorkbookOptions)

ParseFileOptions parse the options of a protobuf definition file.

func ParseMessage

func ParseMessage(parser *sheetParser, protomsg proto.Message, sheetName string, importers ...importer.Importer) error

func ParseMessageOptions

func ParseMessageOptions(md protoreflect.MessageDescriptor) (string, *tableaupb.WorksheetOptions)

ParseMessageOptions parse the options of a protobuf message.

func PrintPerfStats

func PrintPerfStats(gen *Generator)

Types

type Field

type Field struct {
	// contains filtered or unexported fields
}

type Generator

type Generator struct {
	ProtoPackage string // protobuf package name.
	InputDir     string // input dir of workbooks.
	OutputDir    string // output dir of generated files.

	LocationName string                    // TZ location name.
	InputOpt     *options.InputConfOption  // Input settings.
	OutputOpt    *options.OutputConfOption // output settings.

	// Performace stats
	PerfStats sync.Map
}

func NewGenerator

func NewGenerator(protoPackage, indir, outdir string, setters ...options.Option) *Generator

func NewGeneratorWithOptions

func NewGeneratorWithOptions(protoPackage, indir, outdir string, opts *options.Options) *Generator

func (*Generator) GenAll

func (gen *Generator) GenAll() error

func (*Generator) GenOneWorkbook

func (gen *Generator) GenOneWorkbook(relWorkbookPath string, worksheetName string) (err error)

func (*Generator) GenWorkbook

func (gen *Generator) GenWorkbook(relWorkbookPaths ...string) error

func (*Generator) Generate

func (gen *Generator) Generate(relWorkbookPaths ...string) (err error)