report

Documentation

Index

• Variables
• type File
• type GenerateProgramFn
  • func WrapGen(reporter Reporter, title, language string, files []*syntax.File, ...) GenerateProgramFn
• type Language
• type Reporter
  • func New(name, version string) Reporter
• type Stats
• type Summary

Variables

var ExportTargetDir = env.String("CODEGEN_REPORT_DIR",
	"The directory to generate a codegen report in")

Types

type File

type File struct {
	Name string `json:"name,omitempty"`
	Body string `json:"body,omitempty"`
}

type GenerateProgramFn

type GenerateProgramFn func(*hcl2.Program) (map[string][]byte, hcl.Diagnostics, error)

func WrapGen

func WrapGen(reporter Reporter, title, language string, files []*syntax.File, f GenerateProgramFn) GenerateProgramFn

type Language

type Language struct {
	Stats

	// A mapping from Error:(title:occurrences)
	Warnings map[string]map[string]int `json:"warning,omitempty"`
	Errors   map[string]map[string]int `json:"errors,omitempty"`

	// A mapping from between titles and Go errors (as opposed to diag errors)
	GoErrors map[string]string `json:"goerrors,omitempty"`

	// A mapping from title:files
	Files map[string][]File `json:"files,omitempty"`
}

type Reporter

type Reporter interface {
	io.Closer
	// Report a call to GenerateProgram.
	Report(title, language string, files []*syntax.File, diags hcl.Diagnostics, err error)
	Summary() Summary
}

func New

func New(name, version string) Reporter

type Stats

type Stats struct {
	NumConversions int
	Successes      int
}

type Summary

type Summary struct {
	Stats
	Name          string               `json:"name"`
	Version       string               `json:"version"`
	ReportVersion string               `json:"reportVersion"`
	Languages     map[string]*Language `json:"languages"`
}