yagu

README

go-utils

Common golang utilities and helpers we use

Documentation

Index

• Constants
• Variables
• func Bash(script string) (string, error)
• func BillyCalcDirHash(dir string, FS billy.Filesystem) (string, error)
• func BillyCalcFileHash(filename string, FS billy.Filesystem) (string, error)
• func BillyCalcHash(FS billy.Filesystem) (string, error)
• func BillyFilenames(dir string, FS billy.Filesystem) ([]string, error)
• func BillyGlobCalcDirHash(dir string, FS billy.Filesystem, includes, excludes []string) (string, error)
• func BillyGlobCalcHash(FS billy.Filesystem, include, exclude []string) (string, error)
• func BillyGlobLoadFromZip(zReader *zip.Reader, FS billy.Filesystem, includes, excludes []string) error
• func BillyGlobWriteDirToOS(baseDir string, dir string, FS billy.Filesystem, includes, excludes []string) error
• func BillyLoadFromZip(zReader *zip.Reader, FS billy.Filesystem, trimFirstDir bool) error
• func BillyReadAll(filename string, FS billy.Filesystem) ([]byte, error)
• func BillyReadAllString(filename string, FS billy.Filesystem) (string, error)
• func BillyWriteDirToOS(baseDir string, dir string, FS billy.Filesystem) error
• func BillyWriteFileToOS(baseDir string, file string, FS billy.Filesystem) error
• func BuildRequest(url string) *gorequest.SuperAgent
• func CheckShouldInclude(filename string, includes, excludes []string) (bool, error)
• func CloneRepo(srcUrl, srcVer string) (string, error)
• func CopyDir(src string, dst string) error
• func CopyFile(src, dst string) error
• func Exec(args []string) (string, error)
• func FindIdFromName(basePath, name, listOutput string, res interface{}) (string, error)
• func GetHash(path string, hashAlgorithm string) (string, error)
• func Mkdir(dir string) error
• func NewHash(name *string) (hash.Hash, error)
• func PrintCueError(err error)
• func PrintCueInstance(i *cue.Instance) error
• func RenderDir(src string, dst string, data interface{}) error
• func RenderDirNameSub(src string, dst string, data interface{}) error
• func RenderFile(src, dst string, data interface{}) error
• func RenderFileNameSub(src, dst string, data interface{}) error
• func RenderString(template string, data interface{}) (string, error)
• func SendGaEvent(cfg GaConfig, evt GaEvent) (string, error)
• func SendGaEvents(cfg GaConfig, evts []GaEvent) (string, error)
• func SendRequest(host, queryTemplate string, vars interface{}) (interface{}, error)
• func SimpleGet(url string) (string, error)
• func SwapDelimits(content, fromLL, fromLR, fromSL, fromSR, toLL, toLR, toSL, toSR string) string
• func UserHomeDir() string
• type GaConfig
• type GaEvent
• type GaPageview

Constants

const (
	SHA1   = "sha1"
	SHA256 = "sha256"
	MD5    = "md5"
)

SHA1, SHA256, MD5

const HTTP2_GOAWAY_CHECK = "http2: server sent GOAWAY and closed the connection"

Variables

var (
	// Global cue runtime
	CueRuntime cue.Runtime
)

Functions

func Bash

func Bash(script string) (string, error)

func BillyCalcDirHash

func BillyCalcDirHash(dir string, FS billy.Filesystem) (string, error)

func BillyCalcFileHash

func BillyCalcFileHash(filename string, FS billy.Filesystem) (string, error)

func BillyCalcHash

func BillyCalcHash(FS billy.Filesystem) (string, error)

func BillyFilenames

func BillyFilenames(dir string, FS billy.Filesystem) ([]string, error)

func BillyGlobCalcDirHash

func BillyGlobCalcDirHash(dir string, FS billy.Filesystem, includes, excludes []string) (string, error)

func BillyGlobCalcHash

func BillyGlobCalcHash(FS billy.Filesystem, include, exclude []string) (string, error)

func BillyGlobLoadFromZip

func BillyGlobLoadFromZip(zReader *zip.Reader, FS billy.Filesystem, includes, excludes []string) error

Loads an initialized zip.Reader into an initialize billy.Filesystem

func BillyGlobWriteDirToOS

func BillyGlobWriteDirToOS(baseDir string, dir string, FS billy.Filesystem, includes, excludes []string) error

Write dir in FS onto the os filesystem at baseDir

func BillyLoadFromZip

func BillyLoadFromZip(zReader *zip.Reader, FS billy.Filesystem, trimFirstDir bool) error

func BillyReadAll

func BillyReadAll(filename string, FS billy.Filesystem) ([]byte, error)

func BillyReadAllString

func BillyReadAllString(filename string, FS billy.Filesystem) (string, error)

func BillyWriteDirToOS

func BillyWriteDirToOS(baseDir string, dir string, FS billy.Filesystem) error

Writes dir in FS onto the os filesystem at baseDir

func BillyWriteFileToOS

func BillyWriteFileToOS(baseDir string, file string, FS billy.Filesystem) error

Writes file in FS onto the os filesystem at baseDir

func BuildRequest

func BuildRequest(url string) *gorequest.SuperAgent

func CheckShouldInclude

func CheckShouldInclude(filename string, includes, excludes []string) (bool, error)

func CloneRepo

func CloneRepo(srcUrl, srcVer string) (string, error)

func CopyDir

func CopyDir(src string, dst string) error

Dir copies a whole directory recursively

func CopyFile

func CopyFile(src, dst string) error

File copies a single file from src to dst

func Exec

func Exec(args []string) (string, error)

func FindIdFromName

func FindIdFromName(basePath, name, listOutput string, res interface{}) (string, error)

func GetHash

func GetHash(path string, hashAlgorithm string) (string, error)

Create hash value with local path and a hash algorithm

func Mkdir

func Mkdir(dir string) error

func NewHash

func NewHash(name *string) (hash.Hash, error)

NewHash create an instance of specific hash algorithm

func PrintCueError

func PrintCueError(err error)

func PrintCueInstance

func PrintCueInstance(i *cue.Instance) error

func RenderDir

func RenderDir(src string, dst string, data interface{}) error

Dir copies a whole directory recursively

func RenderDirNameSub

func RenderDirNameSub(src string, dst string, data interface{}) error

Dir copies a whole directory recursively

func RenderFile

func RenderFile(src, dst string, data interface{}) error

File copies a single file from src to dst

func RenderFileNameSub

func RenderFileNameSub(src, dst string, data interface{}) error

func RenderString

func RenderString(template string, data interface{}) (string, error)

func SendGaEvent

func SendGaEvent(cfg GaConfig, evt GaEvent) (string, error)

func SendGaEvents

func SendGaEvents(cfg GaConfig, evts []GaEvent) (string, error)

func SendRequest

func SendRequest(host, queryTemplate string, vars interface{}) (interface{}, error)

func SimpleGet

func SimpleGet(url string) (string, error)

func SwapDelimits

func SwapDelimits(content, fromLL, fromLR, fromSL, fromSR, toLL, toLR, toSL, toSR string) string

func UserHomeDir

func UserHomeDir() string

Types

type GaConfig

type GaConfig struct {
	TID string
	CID string
	IP  string
	UA  string

	CN string
	CS string
	CM string
}

type GaEvent

type GaEvent struct {
	Type     string
	Source   string
	Category string
	Action   string
	Label    string
	Value    int
}

type GaPageview

type GaPageview struct {
	Type     string
	Source   string
	Category string
	Action   string
	Label    string
	Value    int
}

TODO... make this accurate, add a second function, make both funcs specialized XXX see if we can find the API spec and reverse it into gocode