uselagoon / uselagoon/lagoon-cli
Lagoon CLI config files in unexpected location
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 28
- Forks
- 14
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 1
Description
Describe the bug
~/.lagoon.yml and ~/.lagoon.update is non-standard and makes it difficult to find lagoon-cli configuration files.
To Reproduce
Steps to reproduce the behavior:
- Run lagoon-cli.
- See
~/.lagoon.ymland~/.lagoon.updateappear.
Expected behavior
According to the XDG Base Directory Spec.:
.lagoon.ymlshould be in e.g.$XDG_CONFIG_HOME/lagoon/config.yml.lagoon.updateshould be in e.g.$XDG_STATE_HOME/lagoon/update
It would be nice if lagoon-cli followed this convention 🙂
Screenshots
n/a
Desktop (please complete the following information):
- OS: Debian Linux
Additional context
There's a nice library that takes care of this in a cross platform way here.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating lagoon-cli's handling of the ~/.lagoon.yml and ~/.lagoon.update paths, then reproduce the behavior on Debian Linux. Compare the implementation with the XDG Base Directory Spec and the linked adrg/xdg library. Done means configuration uses $XDG_CONFIG_HOME/lagoon/config.yml and update state uses $XDG_STATE_HOME/lagoon/update.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100