Feature - Config Loading Improvements #36
Merged
Conversation
This file contains 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
- The flags will now receive and be able to display the default values. - The config file is now searched across multiple paths: - One that respects the XDG Base Directory Specification. - The old default of `~/.define.conf.json`, for fallback.
We now check for a user's XDG config home path, then the old default path, and then finally the more "system" level XDG config dirs.
Config merging now handles private values.
Rican7
deleted the
feature/config-improvement-and-xdg-basedir-spec-compliance
branch
Rican7
added a commit
that referenced
this pull request
Mar 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds support for loading config files in multiple locations, based on the OS and environment that the app is running on, and adheres to the XDG Base Directory Specification for the locations that it searches for in *nix/Unix-like environments.
It also tweaks configuration fallback-order/precedence to use the more common ordering of:
Finally, in order to help with the environment-dependent config loading pattern (that makes static documentation more challenging), this PR adds a
--debug-configflag to have the application self-document and describe it's config file loading status and print the paths that are searched for config files.