util

Documentation

Index

• func CanonicalPath(path string, basePath string) (string, error)
• func CanonicalPaths(paths []string, basePath string) ([]string, error)
• func CreateLogger(prefix string) *log.Logger
• func FileExists(path string) bool
• func GetPathRelativeTo(path string, basePath string) (string, error)
• func Grep(regex *regexp.Regexp, glob string) (bool, error)
• func ListContainsElement(list []string, element string) bool
• func ReadFileAsString(path string) (string, error)
• func RemoveElementFromList(list []string, element string) []string

Functions

func CanonicalPath

func CanonicalPath(path string, basePath string) (string, error)

Return the canonical version of the given path, relative to the given base path. That is, if the given path is a relative path, assume it is relative to the given base path. A canonical path is an absolute path with all relative components (e.g. "../") fully resolved, which makes it safe to compare paths as strings.

func CanonicalPaths

func CanonicalPaths(paths []string, basePath string) ([]string, error)

Return the canonical version of the given paths, relative to the given base path. That is, if a given path is a relative path, assume it is relative to the given base path. A canonical path is an absolute path with all relative components (e.g. "../") fully resolved, which makes it safe to compare paths as strings.

func CreateLogger

func CreateLogger(prefix string) *log.Logger

Create a logger with the given prefix

func FileExists

func FileExists(path string) bool

Return true if the given file exists

func GetPathRelativeTo

func GetPathRelativeTo(path string, basePath string) (string, error)

Return the relative path you would have to take to get from basePath to path

func Grep

func Grep(regex *regexp.Regexp, glob string) (bool, error)

Returns true if the given regex can be found in any of the files matched by the given glob

func ListContainsElement

func ListContainsElement(list []string, element string) bool

Return true if the given list contains the given element

func ReadFileAsString

func ReadFileAsString(path string) (string, error)

Return the contents of the file at the given path as a string

func RemoveElementFromList

func RemoveElementFromList(list []string, element string) []string

Return a copy of the given list with all instances of the given element removed