fs

Documentation

Index

• func Basename() string
• func CheckExists(path string) bool
• func Contains(path string, keyword string) bool
• func Copy(source string, destination string)
• func EmptyDir(dir string) error
• func HomeDir() string
• func IsProjectRoot(path string) bool
• func Mkdir(path string)
• func ProjectRoot() string
• func Remove(path string)
• func RemoveAll(path string)
• func Rename(orginal, new string) error
• func Replace(path string, body []byte)
• func ScanUp(path string) string
• func TouchByteArray(path string, body []byte) error
• func TouchEmpty(path string) error
• func TouchOrReplace(path string, body []byte)
• func WaitForSync(file string, retries int) (err error)
• func WorkDir() string
• func Writable(path string) bool

Functions

func Basename

func Basename() string

Basename - Return the name of the directory the binary is being run in

func CheckExists

func CheckExists(path string) bool

CheckExists - Check if a file exists or not

func Contains

func Contains(path string, keyword string) bool

Contains ...

func Copy

func Copy(source string, destination string)

Copy ...

func EmptyDir

func EmptyDir(dir string) error

EmptyDir removes all files from a dir

func HomeDir

func HomeDir() string

HomeDir - Return the users' $HOME dir

func IsProjectRoot

func IsProjectRoot(path string) bool

IsProjectRoot ...

func Mkdir

func Mkdir(path string)

Mkdir - Check existence of folder and create if it doesn't exist

func ProjectRoot

func ProjectRoot() string

ProjectRoot - Find the root directory path for the project

func Remove

func Remove(path string)

Remove - `rm` on a file/dir

func RemoveAll

func RemoveAll(path string)

RemoveAll - `rm -rf` on a dir

func Rename

func Rename(orginal, new string) error

Rename - os Rename function

func Replace

func Replace(path string, body []byte)

Replace ...

func ScanUp

func ScanUp(path string) string

ScanUp ...

func TouchByteArray

func TouchByteArray(path string, body []byte) error

TouchByteArray ...

func TouchEmpty

func TouchEmpty(path string) error

TouchEmpty ...

func TouchOrReplace

func TouchOrReplace(path string, body []byte)

TouchOrReplace ...

func WaitForSync

func WaitForSync(file string, retries int) (err error)

WaitForSync polls the specified file path locally until it appears this is used to wait for sync from tokaido to local environments to complete.

func WorkDir

func WorkDir() string

WorkDir - Return the current working directory

func Writable

func Writable(path string) bool

Writable - Check if a file/folder is writable