gola

Documentation

Index

• Variables
• type BhTest
• type BhTestCollection
• type CodeContent
• type CodeFileName
• type GeneratedPage
• type Operator
• type OperatorName
• type PsCaseEntry
• type SignatureCounts
• type SignatureCountsBySource
• type SignatureResult
• type SourceCodeContainer
  • func NewSourceCodeContainer(vfs storage.VirtualFS, absolutePath string, templatesSubPath string) *SourceCodeContainer
  • func (d *SourceCodeContainer) AnyMissing() bool
  • func (d *SourceCodeContainer) ForEach(fn func(entry *SourceCodeData))
  • func (d *SourceCodeContainer) ForEachUntil(fn func(entry *SourceCodeData) bool) bool
  • func (d *SourceCodeContainer) Generator(doWrite bool) *SourceCodeGenerator
  • func (d *SourceCodeContainer) Signature() (*SignatureResult, error)
  • func (d *SourceCodeContainer) Verify(fn func(entry *SourceCodeData))
• type SourceCodeData
  • func (d *SourceCodeData) FullPath() string
  • func (d *SourceCodeData) OutputFileName() string
• type SourceCodeGenerator
  • func (g *SourceCodeGenerator) Run() (*SignatureResult, error)
• type TestCaseEntry
• type TypeNameID
• type TypeSpec

Variables

var (

	//go:embed signature.GO-HASH.txt
	RegisteredHash string
)

Types

type BhTest

type BhTest struct {
	First  string
	Second string
	Assign string
	Entry  TestCaseEntry
}

type BhTestCollection

type BhTestCollection map[string]*BhTest

type CodeContent

type CodeContent = collections.OrderedKeysMap[CodeFileName, string]

CodeContent can be used for multiple purposes. The key thing is that each code file can have some content associated with. What that content is can vary depending on context.

type CodeFileName

type CodeFileName string

type GeneratedPage

type GeneratedPage interface {
	Name() CodeFileName
	Content() string
}

type Operator

type Operator struct {
	Name          OperatorName
	Documentation string
}

type OperatorName

type OperatorName string

type PsCaseEntry

type PsCaseEntry struct {
	AssertFn string
}

type SignatureCounts

type SignatureCounts struct {
	Type int
	Func int
}

type SignatureCountsBySource

type SignatureCountsBySource = collections.OrderedKeysMap[CodeFileName, *SignatureCounts]

type SignatureResult

type SignatureResult struct {
	Totals   *SignatureCounts
	Counters SignatureCountsBySource
	Status   string
	Hash     string
	Output   string
}

type SourceCodeContainer

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

func NewSourceCodeContainer

func NewSourceCodeContainer(
	vfs storage.VirtualFS,
	absolutePath string,
	templatesSubPath string,
) *SourceCodeContainer

func (*SourceCodeContainer) AnyMissing

func (d *SourceCodeContainer) AnyMissing() bool

func (*SourceCodeContainer) ForEach

func (d *SourceCodeContainer) ForEach(fn func(entry *SourceCodeData))

func (*SourceCodeContainer) ForEachUntil

func (d *SourceCodeContainer) ForEachUntil(fn func(entry *SourceCodeData) bool) bool

ForEachUntil returns true if exit's early, false otherwise

func (*SourceCodeContainer) Generator

func (d *SourceCodeContainer) Generator(
	doWrite bool,
) *SourceCodeGenerator

func (*SourceCodeContainer) Signature

func (d *SourceCodeContainer) Signature() (*SignatureResult, error)

Signature used to compose the SHA256 hash of pre-generated source code.

func (*SourceCodeContainer) Verify

func (d *SourceCodeContainer) Verify(fn func(entry *SourceCodeData))

type SourceCodeData

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

func (*SourceCodeData) FullPath

func (d *SourceCodeData) FullPath() string

func (*SourceCodeData) OutputFileName

func (d *SourceCodeData) OutputFileName() string

type SourceCodeGenerator

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

func (*SourceCodeGenerator) Run

func (g *SourceCodeGenerator) Run() (*SignatureResult, error)

type TestCaseEntry

type TestCaseEntry struct {
	DoesContain    []string
	DoesNotContain []string
	Below          []string
	EqualLo        []string
	Inside         []string
	EqualHi        []string
	Above          []string
}

type TypeNameID

type TypeNameID = string

type TypeSpec

type TypeSpec struct {
	TypeName           string
	GoType             string
	DisplayType        string
	UnderlyingTypeName string
	FlagName           string
	Short              string
	Def                any
	Assign             string
	Setup              string
	BindTo             string
	Assert             string
	QuoteExpect        bool
	Equate             string
	Validatable        bool
	ForeignValidatorFn bool
	GenerateSlice      bool
	SliceFlagName      string
	SliceShort         string
	DefSliceVal        string
	ExpectSlice        string
	SliceValue         string
	IsOptionLess       bool
	OptionValue        string
	QuoteOptionValue   bool
	CommandLineValue   string
	TcEntry            *PsCaseEntry
	Comparable         bool
	BindDoc            string
	BindValidatedDoc   string
	Containable        bool
	BhParent           string
	CastLiteralsAs     string
	BhTests            BhTestCollection
}