util

Documentation

Index

• Constants
• Variables
• func CheckWorkspace()
• func CopyDirRecursively(sourceDir, destDir string) error
• func CopyFile(sourceFile, destFile string)
• func CutPrefix(str string, prefix string) (string, bool)
• func DirExists(dir string) bool
• func EnsureManagedDir(dir string)
• func FileExists(file string) bool
• func GetModuleRoot() string
• func GetModuleRootForPath(p string) string
• func GetWorkingDir() string
• func GetWorkspaceRoot() string
• func MkdirAll(p string)
• func ReadFile(filePath string) []byte
• func ReadJson(filePath string, v interface{})
• func ReadYaml(filePath string, v interface{})
• func RemoveDir(p string)
• func Version() string
• func VersionTriplet() [3]uint
• func WalkSymlink(root string, walkFn filepath.WalkFunc) error
• func WriteFile(filePath string, data []byte)
• func WriteJson(filePath string, v interface{})
• func WriteYaml(filePath string, v interface{})

Constants

const (
	ModuleFileName      = "MODULE"
	ModuleSyntaxVersion = 3

	BuildDirName = "BUILD"
	// DepsDirName is directory that dependencies are stored in.
	DepsDirName     = "DEPS"
	WarningFileName = "WARNING.readme.txt"
)

ModuleFileName is the name of the file describing each module.

Variables

var FlagNoWorkspaceChecks = false

Functions

func CheckWorkspace

func CheckWorkspace()

func CopyDirRecursively

func CopyDirRecursively(sourceDir, destDir string) error

Copies a directory recursing into its inner directories

func CopyFile

func CopyFile(sourceFile, destFile string)

func CutPrefix

func CutPrefix(str string, prefix string) (string, bool)

Reimplementation of CutPrefix for backwards compatibility with versions < 1.20

func DirExists

func DirExists(dir string) bool

DirExists checks whether some directory exists.

func EnsureManagedDir

func EnsureManagedDir(dir string)

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 MkdirAll

func MkdirAll(p string)

MkdirAll creates directory `p` and all parent directories.

func ReadFile

func ReadFile(filePath string) []byte

func ReadJson

func ReadJson(filePath string, v interface{})

func ReadYaml

func ReadYaml(filePath string, v interface{})

func RemoveDir

func RemoveDir(p string)

RemoveDir removes a directory and all of its content.

func Version

func Version() string

func VersionTriplet

func VersionTriplet() [3]uint

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)

func WriteJson

func WriteJson(filePath string, v interface{})

func WriteYaml

func WriteYaml(filePath string, v interface{})