platform

Documentation

Index

• Constants
• func CleanAbs(raw string) (string, error)
• func InsideDir(base, target string) (bool, error)
• func LinkOrCopy(src, dst string, preferSymlink bool) (mode string, err error)
• func RelForDisplay(base, target string) string
• func ResolveHome(override string) (string, error)

Constants

const (
	// InstallModeSymlink records a target installed as a symlink.
	InstallModeSymlink = "symlink"
	// InstallModeCopy records a target installed as a copied file or directory.
	InstallModeCopy = "copy"
)

const (
	// EnvHome is the environment variable used to override the ContextCart home.
	EnvHome = "CONTEXTCART_HOME"
)

Functions

func CleanAbs

func CleanAbs(raw string) (string, error)

CleanAbs returns an absolute, cleaned path.

func InsideDir

func InsideDir(base, target string) (bool, error)

InsideDir reports whether target is base itself or contained inside base.

func LinkOrCopy

func LinkOrCopy(src, dst string, preferSymlink bool) (mode string, err error)

LinkOrCopy places src at dst by symlink when requested and possible, otherwise by copying. It never overwrites an existing target.

func RelForDisplay

func RelForDisplay(base, target string) string

RelForDisplay returns target relative to base when possible, using slash separators for stable CLI output.

func ResolveHome

func ResolveHome(override string) (string, error)

ResolveHome returns the ContextCart home directory.

Precedence is explicit override, CONTEXTCART_HOME, then the OS user home plus ".contextcart". The returned path is absolute and cleaned.