Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blakewilliams/go-xdg
Tools for working with XDG directories in Go
https://github.com/blakewilliams/go-xdg
Last synced: 16 days ago
JSON representation
Tools for working with XDG directories in Go
- Host: GitHub
- URL: https://github.com/blakewilliams/go-xdg
- Owner: BlakeWilliams
- License: mit
- Created: 2024-10-12T16:53:33.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-13T16:26:29.000Z (3 months ago)
- Last Synced: 2024-12-15T14:57:11.009Z (19 days ago)
- Language: Go
- Size: 7.81 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-XDG
This package implements (a subset of) the XDG Base Directory Specification in
Go. It uses the user expected directories as defined by the XDG Base Directory
Specification for Linux/Unix/macOS and (soon) Windows.
### Linux/macOS directories
- Config - `$XDG_CONFIG_HOME` or `$HOME/.config`
- Data - `$XDG_DATA_HOME` or `$HOME/.local/share`
- Cache - `$XDG_CACHE_HOME` or `$HOME/.cache`
- State - `$XDG_STATE_HOME` or `$HOME/.local/state`
### Windows directories
**Windows support has not been tested yet**. Assistance/contributions very welcome here.
First, it checks the following environment variables if the `XDG_*_HOME`
variable is not set:
- Config - `%APPDATA%`
- Data - `%APPDATA%`
- Cache - `%LOCALAPPDATA%`
- State - `%LOCALAPPDATA%`
If the environment variables are not set, it falls back to the following:
- Config - `%USERPROFILE%\AppData\Local`
- Data - `%USERPROFILE%\AppData\Local`
- Cache - `%USERPROFILE%\AppData\Local\Temp`
- State - `%USERPROFILE%\AppData\Local`
## Installation
```sh
go get github.com/blakewilliams/go-xdg
```
## Usage
The API is relatively simple. Each directory has a function that returns the
path to the directory or an error (e.g. if $HOME is not set in macOS/Linux).
```go
import "github.com/blakewilliams/go-xdg"
// Get the config directory
configDir, err := xdg.ConfigHome()
// Get the data directory
dataDir, err := xdg.DataHome()
// Get the cache directory
cacheDir, err := xdg.CacheHome()
// Get the state directory
stateDir, err := xdg.StateHome()
```
This package also has support for finding files. It will return the path to the
file if it is found, otherwise it returns an `ErrNoFile` error.
```go
import "github.com/blakewilliams/go-xdg"
// Find `myapp/config.yaml` in the config directory
configFilePath, err := xdg.FindConfigFile("myapp", "config.yaml")
// Find `myapp/data.json` in the data directory
dataFilePath, err := xdg.FindDataFile("myapp", "data.json")
// Find `myapp/cache.db` in the cache directory
dataFilePath, err := xdg.FindCacheFile("myapp", "cache.db")
// Find `myapp/state.db` in the state directory
stateFilePath, err := xdg.FindStateFile("myapp", "state.db")
```
## Contributions welcome!
If you'd like to contribute, please create an issue with a proposal for your
change before opening a PR if you'd like to ensure it will be accepted.