Added XDG support#57
Open
glymphie wants to merge 4 commits into
Open
Conversation
Added a new default for where the .cntb.yaml lives. New default is `$XDG_CONFIG_HOME/cntb/.cntb.yaml`, with backwards support for `$HOME/.cntb.yaml` files.
Added XDG support for how the `token` is stored in cache. New default is `$XDG_CACHE_HOME/cntb/token`. Which resolves to `$HOME/.cache/cntb/token` if `$XDG_CACHE_HOME` isn't declared.
Clarified how the xdg default works.
Corrected help text to reflect xdg support: The first checked config is `$XDG_CONFIG_HOME/cntb/.cntb.yaml`.
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the default configuration and cache paths to follow the XDG Base Directory specification.
Changes
Config file location
$XDG_CONFIG_HOME/cntb/.cntb.yaml(if$XDG_CONFIG_HOMEis set)$HOME/.cntb.yamlfor backwards compatibilityCache / token storage
$XDG_CACHE_HOME/cntb/$HOME/.cache/cntb/if$XDG_CACHE_HOMEis not setNotes
$HOME/.cntb.yamlwill continue to work without any changesRelated
Closes #39