 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- func CheckRulesJson(file string, bytes []byte) error
- func CompareContentWithFile(sourceBytes []byte, target string) (bool, error)
- func New(opts Options) (*generator, error)
- func NewOutputWriter() *fsWriter
- func ReadRulesDoc(filename string) (*spec.RulesDoc, error)
- func RenderString(s string, ctx any) (string, error)
- type GeneratorStats
- type MockOutput
- type Options
- type OutputWriter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckRulesJson ¶ added in v0.8.0
func CompareContentWithFile ¶
func NewOutputWriter ¶ added in v0.35.0
func NewOutputWriter() *fsWriter
func ReadRulesDoc ¶ added in v0.8.0
ReadRulesDoc reads rules from a file.
Types ¶
type GeneratorStats ¶ added in v0.8.0
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 ¶ added in v0.8.0
func (g *GeneratorStats) Start()
func (*GeneratorStats) Stop ¶ added in v0.8.0
func (g *GeneratorStats) Stop()
func (*GeneratorStats) TotalFiles ¶ added in v0.8.0
func (s *GeneratorStats) TotalFiles() int
type MockOutput ¶ added in v0.20.0
type MockOutput struct {
	Writes   map[string]string
	Copies   map[string]string
	Compares map[string]bool
}
    func NewMockOutput ¶ added in v0.20.0
func NewMockOutput() *MockOutput
func (*MockOutput) Compare ¶ added in v0.20.0
func (m *MockOutput) Compare(input []byte, target string) (bool, error)
func (*MockOutput) Copy ¶ added in v0.20.0
func (m *MockOutput) Copy(source, target string) error
type Options ¶ added in v0.35.0
type Options 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
	// Features is a list of features defined by user
	Features []string
	// Force forces overwrite of existing files
	Force 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
}
     Click to show internal directories. 
   Click to hide internal directories.