chore: adopt standardized configuration directories #18
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
By following each platform's standard file paths, the user's home folder doesn't get cluttered with hidden files and moving configuration between systems becomes easier, as all config files are in one plcae. This change will make the pgrok client use the ~/.pgrok/pgrok.yml file, if available, for backwards compatibility. If this file does not exist, this change will make pgrok try the standardised application configuration path as configured by the user's preferences. What this standardised path is, depends on the user's operating system. [The underlying library's documentation](https://github.com/adrg/xdg/#xdg-base-directory) has details and examples for each operating system. In summary, the defaults are as follows: |Platform|Default directory | |--------|---------------------------------------------| |Linux |$XDG_CONFIG_HOME/pgrok/pgrok.yml | |macOS |~/Library/Application Support/pgrok/pgrok.yml| |Windows |%LOCALAPPDATA%\pgrok\pgrok.yml |
Karimsultan
approved these changes
Mar 18, 2023
unknwon
changed the title
|
https://github.com/pgrok/pgrok/releases/tag/v1.3.2 has been released for this merge. |
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.
By following each platform's standard file paths, the user's home folder doesn't get cluttered with hidden files and moving configuration between systems becomes easier, as all config files are in one plcae.
This change will make the pgrok client use the ~/.pgrok/pgrok.yml file, if available, for backwards compatibility. If this file does not exist, this change will make pgrok try the standardised application configuration path as configured by the user's preferences.
What this standardised path is, depends on the user's operating system. The underlying library's documentation has details and examples for each operating system.
In summary, the defaults are as follows:
For more information, I recommend the following links: