path

Documentation

Index

• func ExpandHomeDir(path string) (string, error)
• func ExpandPath(p string) string
• func IsWithin(p, dir string) bool
• func RelativeTo(p, baseDir string) string
• func ShortenHome(p string) string
• func ShortenHomeDir(p, homeDir string) string
• func ValidatePathInDirectory(path, allowedDir string) (string, error)

Functions

func ExpandHomeDir

func ExpandHomeDir(path string) (string, error)

ExpandHomeDir expands a leading home-directory reference in a path. It expands "~", "~/...", and "~\\..." on Windows. Other tilde forms, such as "~user/...", are returned unchanged.

func ExpandPath

func ExpandPath(p string) string

ExpandPath expands shell-like patterns in a file path:

• ~ or ~/ at the start is replaced with the user's home directory
• Environment variables like ${HOME} or $HOME are expanded

func IsWithin

func IsWithin(p, dir string) bool

IsWithin reports whether p is equal to dir or contained by dir.

func RelativeTo

func RelativeTo(p, baseDir string) string

RelativeTo returns p relative to baseDir when both paths are absolute and filepath.Rel can compute a relative path. Otherwise it returns p cleaned.

func ShortenHome

func ShortenHome(p string) string

ShortenHome replaces the current user's home directory prefix with "~".

func ShortenHomeDir

func ShortenHomeDir(p, homeDir string) string

ShortenHomeDir replaces a leading homeDir prefix with "~".

func ValidatePathInDirectory

func ValidatePathInDirectory(path, allowedDir string) (string, error)