gen

README

Generator package

The generator takes

Documentation

Index

• func CheckRulesJson(file string, bytes []byte) error
• func CompareContentWithFile(sourceBytes []byte, target string) (bool, error)
• func New(o GeneratorOptions) (*generator, error)
• func ReadRulesDoc(filename string) (*spec.RulesDoc, error)
• type FileOutput
  • func (f *FileOutput) Compare(input []byte, target string) (bool, error)
  • func (f *FileOutput) Copy(source, target string, force bool) error
  • func (f *FileOutput) Write(input []byte, target string, force bool) error
• type GeneratorOptions
• type GeneratorStats
  • func (g *GeneratorStats) Start()
  • func (g *GeneratorStats) Stop()
  • func (s *GeneratorStats) TotalFiles() int
• type MockOutput
  • func NewMockOutput() *MockOutput
  • func (m *MockOutput) Compare(input []byte, target string) (bool, error)
  • func (m *MockOutput) Copy(source, target string, force bool) error
  • func (m *MockOutput) Write(input []byte, target string, force bool) error
• type OutputWriter

Functions

func CheckRulesJson

func CheckRulesJson(file string, bytes []byte) error

func CompareContentWithFile

func CompareContentWithFile(sourceBytes []byte, target string) (bool, error)

func New

func New(o GeneratorOptions) (*generator, error)

func ReadRulesDoc

func ReadRulesDoc(filename string) (*spec.RulesDoc, error)

ReadRulesDoc reads rules from a file.

Types

type FileOutput

type FileOutput struct {
}

func (*FileOutput) Compare

func (f *FileOutput) Compare(input []byte, target string) (bool, error)

func (*FileOutput) Copy

func (f *FileOutput) Copy(source, target string, force bool) error

func (*FileOutput) Write

func (f *FileOutput) Write(input []byte, target string, force bool) error

type GeneratorOptions

type GeneratorOptions struct {
	// OutputDir is the directory where files are written
	OutputDir string
	// TemplatesDir is the directory where templates are located
	TemplatesDir string
	// System is the root system model
	System *model.System
	// UserFeatures is a list of features defined by user
	UserFeatures []string
	// UserForce forces overwrite of existing files
	UserForce bool
	// Output is the output writer
	Output OutputWriter
	// DryRun does not write files
	DryRun bool
	// Meta is a map of metadata
	Meta map[string]any
}

type GeneratorStats

type GeneratorStats struct {
	FilesWritten int           `json:"files_written"`
	FilesSkipped int           `json:"files_skipped"`
	FilesCopied  int           `json:"files_copied"`
	FilesTouched []string      `json:"files_touched"`
	RunStart     time.Time     `json:"run_start"`
	RunEnd       time.Time     `json:"run_end"`
	Duration     time.Duration `json:"duration"`
}

func (*GeneratorStats) Start

func (g *GeneratorStats) Start()

func (*GeneratorStats) Stop

func (g *GeneratorStats) Stop()

func (*GeneratorStats) TotalFiles

func (s *GeneratorStats) TotalFiles() int

type MockOutput

type MockOutput struct {
	Writes   map[string]string
	Copies   map[string]string
	Compares map[string]bool
}

func NewMockOutput

func NewMockOutput() *MockOutput

func (*MockOutput) Compare

func (m *MockOutput) Compare(input []byte, target string) (bool, error)

func (*MockOutput) Copy

func (m *MockOutput) Copy(source, target string, force bool) error

func (*MockOutput) Write

func (m *MockOutput) Write(input []byte, target string, force bool) error

type OutputWriter

type OutputWriter interface {
	Write(input []byte, target string, force bool) error
	Copy(source, target string, force bool) error
	Compare(input []byte, target string) (bool, error)
}