mageutil

Documentation

Overview

Package mageutil provides utility functions for building AK

Index

• func BuildTypeScript(baseDir, srcDir, destDir string) error
• func CopyFiles(paths map[string]string) error
• func CopyInDir(destDir, srcDir string, files ...string) error
• func CopyRecursively(destDir, srcDir string) error
• func DirGlob(dir, glob string) ([]string, error)
• func GoProto(dest, src, out, include, opt string) error
• func GoProtosInDir(dir, include, opt string) error
• func HasExec(cmds ...string) error
• func HasFiles(files ...string) error
• func Mkdir(path string) error
• func Newer(paths map[string]string) (bool, error)
• func SyncDirBasic(srcDir, destDir string) error
• func TSProtosInDir(destDir, srcDir, node_modules_dir string) error
• func TinyGoProto(dstPath string, srcPath string, includeDir string) error
• func TinyGoWASM(srcDir, outfile string) error
• func VerboseF(tmpl string, args ...any)
• func ZipDir(inPath, outPath string) error
• func ZipFiles(out string, files map[string]string) error

Functions

func BuildTypeScript

func BuildTypeScript(baseDir, srcDir, destDir string) error

BuildTypeScript builds all .ts files in srcDir to .js files in destDir, as needed

func CopyFiles

func CopyFiles(paths map[string]string) error

CopyFiles paths with keys as source and values as destinations

func CopyInDir

func CopyInDir(destDir, srcDir string, files ...string) error

CopyInDir copies files from srcDir to destDir

func CopyRecursively

func CopyRecursively(destDir, srcDir string) error

CopyRecursively recursively copies srcDir to destDir

func DirGlob

func DirGlob(dir, glob string) ([]string, error)

DirGlob performs a glob operation on dir. The returned matches do not have dir as a prefix.

func GoProto

func GoProto(dest, src, out, include, opt string) error

GoProto builds .pb.go code from a .proto

func GoProtosInDir

func GoProtosInDir(dir, include, opt string) error

GoProtosInDir calls GoProto on all .proto files in dir

func HasExec

func HasExec(cmds ...string) error

HasExec returns an error if any of cmds don't satisfy exec.LookPath

func HasFiles

func HasFiles(files ...string) error

HasFiles returns an error if any of files don't exist

func Mkdir

func Mkdir(path string) error

Mkdir calls os.MkdirAll as needed to ensure a directory exists

func Newer

func Newer(paths map[string]string) (bool, error)

Newer considers paths as a map of file path keys to file path values. It returns true if any key path is newer than its corresponding value path.

func SyncDirBasic

func SyncDirBasic(srcDir, destDir string) error

SyncDirBasic sync the contents of srcDir to destDir, creating destDir as needed. When a file or directory exists in destDir but not srcDir it is deleted from srcDir. If the size of a file from source matches the size of the corresponding file in dest and the mod time of the dest file is the same or newer than the src file, the file is not copied. SyncDirBasic handles only files and directories, doesn't set timestamps or file permissions

func TSProtosInDir

func TSProtosInDir(destDir, srcDir, node_modules_dir string) error

TSProtosInDir creates _pb.js files in destDir for all .proto files in srcDir

func TinyGoProto

func TinyGoProto(
	dstPath string,
	srcPath string,
	includeDir string,
) error

func TinyGoWASM

func TinyGoWASM(srcDir, outfile string) error

func VerboseF

func VerboseF(tmpl string, args ...any)

VerboseF prints a message to stdout if mage is set to Verbose

func ZipDir

func ZipDir(inPath, outPath string) error

ZipDir writes a zip file containing all the files in inPath

func ZipFiles

func ZipFiles(out string, files map[string]string) error

ZipFiles creates a zip file including files where the keys are paths to files to include and values are how they should be named in the zip.