ospath

Documentation

Index

• func Child(dir string, file string) (string, bool)
• func FileDisplayName(baseDirs []string, f string) string
• func FileListDisplayNames(baseDirs []string, files []string) []string
• func FormatFileChangeList(changedFiles []string) string
• func IsBrokenSymlink(path string) (bool, error)
• func IsChild(dir string, file string) bool
• func IsChildOfOne(dirs []string, file string) bool
• func IsDir(path string) bool
• func IsRegularFile(path string) bool
• func MustAbs(path string) string
• func RealAbs(path string) (string, error)
• func RealChild(dir string, file string) (string, bool, error)
• func Realwd() (string, error)
• func TryAsCwdChildren(absPaths []string) []string

Functions

func Child

func Child(dir string, file string) (string, bool)

Given absolute paths `dir` and `file`, returns the relative path of `file` relative to `dir`.

Returns true if successful. If `file` is not under `dir`, returns false.

TODO(nick): Should we have an assertion that dir and file are absolute? This is a common mistake when using this API. It won't work correctly with relative paths.

func FileDisplayName

func FileDisplayName(baseDirs []string, f string) string

Calculate a display name for a file by figuring it out what basedir it's relative to and trimming the basedir prefix off the front

func FileListDisplayNames

func FileListDisplayNames(baseDirs []string, files []string) []string

Calculate display name for list of files.

func FormatFileChangeList

func FormatFileChangeList(changedFiles []string) string

func IsBrokenSymlink

func IsBrokenSymlink(path string) (bool, error)

func IsChild

func IsChild(dir string, file string) bool

IsChild returns true if the given file is a child of the given directory

func IsChildOfOne

func IsChildOfOne(dirs []string, file string) bool

IsChildOfOne returns true if the given file is a child of (at least) one of the given directories.

func IsDir

func IsDir(path string) bool

func IsRegularFile

func IsRegularFile(path string) bool

func MustAbs

func MustAbs(path string) string

filepath.Abs for testing

func RealAbs

func RealAbs(path string) (string, error)

Returns the absolute version of this path, resolving all symlinks.

func RealChild

func RealChild(dir string, file string) (string, bool, error)

func Realwd

func Realwd() (string, error)

Like os.Getwd, but with all symlinks resolved.

func TryAsCwdChildren

func TryAsCwdChildren(absPaths []string) []string

TryAsCwdChildren converts the given absolute paths to children of the CWD, if possible (otherwise, leaves them as absolute paths).