https://github.com/mdm-code/xdg
File discovery based on XDG Base Directory Specification for Go.
https://github.com/mdm-code/xdg
go golang golang-package unix xdg xdg-basedir xdg-compliance
Last synced: 5 months ago
JSON representation
File discovery based on XDG Base Directory Specification for Go.
- Host: GitHub
- URL: https://github.com/mdm-code/xdg
- Owner: mdm-code
- License: mit
- Created: 2022-02-02T11:39:48.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-25T20:48:13.000Z (over 2 years ago)
- Last Synced: 2024-01-25T21:41:29.042Z (over 2 years ago)
- Topics: go, golang, golang-package, unix, xdg, xdg-basedir, xdg-compliance
- Language: Go
- Homepage: https://pkg.go.dev/github.com/mdm-code/xdg
- Size: 228 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
The XDG Base Directory Specification implemented in Go.
The [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
) allows you specify directories where
runtime files, configurations, data and caches are kept. The file discovery
process is automatic and adheres to the XDG standard.
This package supports most Unix-based operating systems. It should work fine on
MacOS. I wrote this package for my personal needs: to deduplicate this kind of
functionality from my other programs, but it is very much a self-contained
implementation.
See [Usage](#usage) section below for examples. Package documentation is
available here: https://pkg.go.dev/github.com/mdm-code/xdg.
## Installation
```sh
go get github.com/mdm-code/xdg
```
## Default locations
The table shows default values for XDG environmental variables for Unix-like systems:
| ![]()
| ![]()
Unix-like
|
| :------------------------------------------------------------: | :----------------------------------------------------------------------------: |
| XDG_DATA_HOME | $HOME/.local/share |
| XDG_CONFIG_HOME | $HOME/.config |
| XDG_STATE_HOME | $HOME/.local/state |
| XDG_DATA_DIRS | /usr/local/share/:/usr/share/ |
| XDG_CONFIG_DIRS | /etc/xdg |
| XDG_CACHE_HOME | $HOME/.cache |
| XDG_RUNTIME_DIR | $TMPDIR |
## Usage
Here is an example of how to use the public API of the `xdg` package.
```go
package main
import (
"fmt"
"github.com/mdm-code/xdg"
)
func main() {
// XDG base directory paths.
dirs := []struct {
msg string
pth string
}{
{"Home data directory: ", xdg.DataHomeDir()},
{"Config home directory: ", xdg.CacheHomeDir()},
{"State home directory: ", xdg.StateHomeDir()},
{"Data directories: ", xdg.DataDirs()},
{"Config directories: ", xdg.ConfigDirs()},
{"Cache home directory: ", xdg.CacheHomeDir()},
{"Runtime home directory: ", xdg.RuntimeDir()},
}
for _, d := range dirs {
fmt.Println(d.msg, d.pth)
}
// Search for file in data XDG directories.
fpath := "/prog/file"
if f, ok := xdg.Find(xdg.Data, fpath); ok {
fmt.Println(f)
} else {
fmt.Printf("ERROR: couldn't find %s\n", fpath)
}
}
```
## Development
Consult [Makefile](Makefile) to see how to format, examine code with `go vet`,
run unit test, run code linter with `golint` get test coverage and check if the
package builds all right.
Remember to install `golint` before you try to run tests and test the build:
```sh
go install golang.org/x/lint/golint@latest
```
## License
Copyright (c) 2023 Michał Adamczyk.
This project is licensed under the [MIT license](https://opensource.org/licenses/MIT).
See [LICENSE](LICENSE) for more details.