README
¶
xdg-go 
Quickstart
If you just want OS-sensible paths.
configDirs := xdg.ConfigDirs()
dataPath := xdg.DataHome()
cachePath := xdg.CacheHome()
Alternatively you can create a context that would determine full paths for your application files.
app := xdg.App{Name: "someApp"}
configFile := app.ConfigPath("someApp.toml")
dataFile := app.DataPath("data.json")
Supported path types
This is a KISS implementation of the XDG Base Directory Specification. As of now it handles the following path types:
- Data (
XDG_DATA_*) for application-wide or user-wide data. - Config (
XDG_CONFIG_*) for application-wide or user-wide config. - Cache (
XDG_CACHE_*)for application-wide or user-wide cached data.
Multi-OS
The specification is Linux centric but this implementation targets more: Linux, OSX and Windows. Default values has been chosen regarding both the specification and the OS conventions. Note than you can override these values with the corresponding environment variables.
There are a lot of OSes missing but supporting them implies a good knowledge of these conventions and philosophies, contributors maybe?
Documentation
¶
Index ¶
- func CacheHome() string
- func CachePath(file string) string
- func ConfigDirs() []string
- func ConfigHome() string
- func ConfigPath(file string) string
- func DataDirs() []string
- func DataHome() string
- func DataPath(file string) string
- func SetName(name string)
- func SystemConfigPaths(file string) []string
- func SystemDataPaths(file string) []string
- type App
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConfigDirs ¶
func ConfigDirs() []string
func ConfigHome ¶
func ConfigHome() string
func ConfigPath ¶
ConfigPath determines the full path of a data file.
func SetName ¶
func SetName(name string)
SetName for the default application. Used for package-wide functions.
func SystemConfigPaths ¶
SystemConfigPaths determines system-wide possible paths for a config file.
func SystemDataPaths ¶
SystemDataPaths determines system-wide possible paths for a data file.
Types ¶
type App ¶
type App struct {
Name string
}
App is an aggregation of XDG information for a named application. Useful to propagate app configuration.
func (App) ConfigPath ¶
ConfigPath determines the full path of a data file.
func (App) SystemConfigPaths ¶
SystemConfigPaths determines system-wide possible paths for a config file.
func (App) SystemDataPaths ¶
SystemDataPaths determines system-wide possible paths for a data file.
Source Files