ollie/util/doc.go

21 lines
624 B
Go

// Package util provides common utilities for ollie.
//
// # Path Helpers
//
// - CfgDir: returns $XDG_CONFIG_HOME/ollie
// - DataDir: returns $XDG_DATA_HOME/ollie
// - RuntimeDir: returns $XDG_RUNTIME_DIR or /run/user/UID
// - ExpandHome: expands ~ to home directory
// - IsGitRepo: checks if directory contains .git
//
// # UUID Generation
//
// - NewUUID: generates a random UUIDv4 string
//
// # Environment
//
// The package follows XDG Base Directory Specification for locating
// configuration and data files. Environment variables take precedence;
// standard fallbacks are used when unset.
package util