util

Documentation

Index

• Constants
• func CopyFile(sourceFile, destFile string)
• func DirExists(dir string) bool
• func FileExists(file string) bool
• func GetModuleRoot() string
• func GetModuleRootForPath(p string) string
• func GetWorkingDir() string
• func GetWorkspaceRoot() string
• func ReadFile(filePath string) []byte
• func RemoveDir(p string)
• func WalkSymlink(root string, walkFn filepath.WalkFunc) error
• func WriteFile(filePath string, data []byte)

Constants

const DepsDirName = "DEPS"

DepsDirName is directory that dependencies are stored in.

const DirMode = 0775

DirMode is the default FileMode used when creating directories.

const FileMode = 0664

FileMode is the default FileMode used when creating files.

const ModuleFileName = "MODULE"

ModuleFileName is the name of the file describing each module.

Functions

func CopyFile

func CopyFile(sourceFile, destFile string)

func DirExists

func DirExists(dir string) bool

DirExists checks whether some directory exists.

func FileExists

func FileExists(file string) bool

FileExists checks whether some file exists.

func GetModuleRoot

func GetModuleRoot() string

GetModuleRoot returns the root directory of the current module.

func GetModuleRootForPath

func GetModuleRootForPath(p string) string

func GetWorkingDir

func GetWorkingDir() string

GetWorkingDir returns the current working directory.

func GetWorkspaceRoot

func GetWorkspaceRoot() string

GetWorkspaceRoot returns the root directory of the current workspace (i.e., top-level module).

func ReadFile

func ReadFile(filePath string) []byte

func RemoveDir

func RemoveDir(p string)

RemoveDir removes a directory and all of its content.

func WalkSymlink

func WalkSymlink(root string, walkFn filepath.WalkFunc) error

WalkSymlink works like filepath.Walk but also accepts symbolic links as `root`.

func WriteFile

func WriteFile(filePath string, data []byte)