files

Documentation

Index

• Constants
• func FindFile(name string, dir TypeDir) (string, fs.FS)
• func NormalizeForFS(in string) string
• func SetConfigDir(dir string)
• func Systems() []fs.FS
• type SystemDir
• type TypeDir

Constants

const (
	ConfigDir   SystemDir = "related"
	ProjectDir  SystemDir = ".related"
	TemplateDir TypeDir   = "templates"
	ScriptDir   TypeDir   = "scripts"
)

Functions

func FindFile

func FindFile(name string, dir TypeDir) (string, fs.FS)

FindFile finds a given template or script file within all available filesystems and returns the first result including the filesystem. Search order: project, user config, embedded.

func NormalizeForFS

func NormalizeForFS(in string) string

func SetConfigDir

func SetConfigDir(dir string)

func Systems

func Systems() []fs.FS

Types

type SystemDir

type SystemDir string

type TypeDir

type TypeDir string