Refactor pry_wrapper.rb to be XDG compliant #962
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 XDG Base Directory Specification (which is currently used by FOSS projects such as Git, Tmux, Pry, Rspec) provides a default location for various file formats, including config/rc/history files. This comment refactors pry_wrapper.rb to load GUARD_RC and HISTORY_FILE from XDG_CONFIG_HOME and XDG_DATA_HOME respectively if they are both set and the corresponding files exist within the guard subdirectory within the XDG locations. To maintain backwards compatibility it defaults back to ~/.guardrc and ~/.guard_history if the respective XDG environment variable does not exist or there is no corresponding file.
Codecov Report
@@ Coverage Diff @@
## master #962 +/- ##
==========================================
- Coverage 88.77% 88.69% -0.08%
==========================================
Files 58 58
Lines 2004 2008 +4
==========================================
+ Hits 1779 1781 +2
- Misses 225 227 +2
Continue to review full report at Codecov.
|
|
@quintrino Thank you, looks good to me! ☀️ 🚀 |
rymai
pushed a commit
that referenced
this pull request
May 13, 2021
The XDG Base Directory Specification (which is currently used by FOSS projects such as Git, Tmux, Pry, Rspec) provides a default location for various file formats, including config/rc/history files. This comment refactors pry_wrapper.rb to load GUARD_RC and HISTORY_FILE from XDG_CONFIG_HOME and XDG_DATA_HOME respectively if they are both set and the corresponding files exist within the guard subdirectory within the XDG locations. To maintain backwards compatibility it defaults back to ~/.guardrc and ~/.guard_history if the respective XDG environment variable does not exist or there is no corresponding file.
This was referenced May 13, 2021
Closed
Merged
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.
The XDG Base Directory Specification (which is currently used by
FOSS projects such as Git, Tmux, Pry, Rspec) provides a default
location for various file formats, including config/rc/history files.
This comment refactors pry_wrapper.rb to load GUARD_RC and
HISTORY_FILE from XDG_CONFIG_HOME and XDG_DATA_HOME
respectively if they are both set and the corresponding files exist
within the guard subdirectory within the XDG locations.
To maintain backwards compatibility it defaults back to ~/.guardrc
and ~/.guard_history if the respective XDG environment variable does
not exist or there is no corresponding file.