lib

Documentation

Index

• Variables
• func ExpandHome(home string) func(string) string
• func NormaliseTestFiles(config SetupConfig, files []string) (validFiles []string, invalidFiles []string)
• func ParseFromFile[A any](file string) A
• func Setup(config SetupConfig)
• func StringifyToFile[A any](m A, file string)
• func Teardown(config SetupConfig)
• func TestFiles(config SetupConfig, files []string)
• type DottyTarget
• type DottyTargets
  • func GetDottyEnv() DottyTargets
• type FileTree
  • func (ft FileTree) Debug() string
  • func (ft FileTree) Filter(predicate func(dir string, file string) bool) FileTree
  • func (ft FileTree) Walk(vistor FileTreeVisitor)
• type FileTreeVisitor
• type Flags
• type ImplicitConfig
  • func GetImplicitConfig() ImplicitConfig
• type Matcher
  • func GetAllIgnoredPatterns(config SetupConfig) []Matcher
• type Matchers
  • func (ignores Matchers) Matches(path string) bool
• type SetupConfig
  • func BuildSetupConfig(flags Flags, implicitConfig ImplicitConfig, target DottyTarget) SetupConfig

Variables

var DryRun bool

Flag cli arg

var Ignores []string

Functions

func ExpandHome

func ExpandHome(home string) func(string) string

func NormaliseTestFiles

func NormaliseTestFiles(config SetupConfig, files []string) (validFiles []string, invalidFiles []string)

func ParseFromFile

func ParseFromFile[A any](file string) A

func Setup

func Setup(config SetupConfig)

func StringifyToFile

func StringifyToFile[A any](m A, file string)

func Teardown

func Teardown(config SetupConfig)

func TestFiles

func TestFiles(config SetupConfig, files []string)

Types

type DottyTarget

type DottyTarget struct {
	From string
	To   string
}

type DottyTargets

type DottyTargets struct {
	Targets []DottyTarget
}

func GetDottyEnv

func GetDottyEnv() DottyTargets

type FileTree

type FileTree struct {
	Dir   string
	Files []string
	Dirs  []FileTree
}

func (FileTree) Debug

func (ft FileTree) Debug() string

func (FileTree) Filter

func (ft FileTree) Filter(predicate func(dir string, file string) bool) FileTree

func (FileTree) Walk

func (ft FileTree) Walk(vistor FileTreeVisitor)

type FileTreeVisitor

type FileTreeVisitor struct {
	File func(dir string, file string)
	Dir  func(string)
}

type Flags

type Flags struct {
	DryRun  bool
	Ignores *[]string
}

type ImplicitConfig

type ImplicitConfig struct {
	Home           string
	ConfigLocation string
}

func GetImplicitConfig

func GetImplicitConfig() ImplicitConfig

GetImplicitConfig gathers config information based on user's system, these are assumed as defaults if not overridden

type Matcher

type Matcher interface {
	MatchString(f string) bool
}

func GetAllIgnoredPatterns

func GetAllIgnoredPatterns(config SetupConfig) []Matcher

type Matchers

type Matchers []Matcher

func (Matchers) Matches

func (ignores Matchers) Matches(path string) bool

type SetupConfig

type SetupConfig struct {
	DryRun bool
	From   string
	To     string

	HistoryFile string
	ImplicitConfig
	// contains filtered or unexported fields
}

func BuildSetupConfig

func BuildSetupConfig(flags Flags, implicitConfig ImplicitConfig, target DottyTarget) SetupConfig