Load config from XDG config home #6895
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
8 tasks
|
The build seems to be failing. |
|
I don't understand why because the failures don't appear to be related to the code changes from what I can tell. I'm trying a rebuild since CircleCI had some issues recently. [EDIT]: Now I see the problem. Can't expand |
Users now have an additional place they can have their own config file, if they prefer to not have dotfiles inside their home directory. Based on initial work by @tejasbubane in #6682.
|
That fixed it. 😄 |
|
Thanks! |
FranklinYu
reviewed
May 9, 2019
| specification][xdg-basedir-spec]. | ||
|
|
||
| * `~/.rubocop.yml` | ||
| * `$XDG_HOME/rubocop/config.yml` (expands to `~/.config/rubocop/config.yml` if |
There was a problem hiding this comment.
-* `$XDG_HOME/rubocop/config.yml` (expands to `~/.config/rubocop/config.yml` if
+* `$XDG_CONFIG_HOME/rubocop/config.yml` (expands to `~/.config/rubocop/config.yml` ifThere was a problem hiding this comment.
🤦♂️
Should I do another PR?
There was a problem hiding this comment.
Opened it here: #7045.
bbatsov
pushed a commit
that referenced
this pull request
May 14, 2019
I made a mistake in #6895, which should be corrected to avoid confusion on how to use the XDG directory specification.
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.
Users now have an additional place they can have their own config file, if they prefer to not have dotfiles inside their home directory.
Based on initial work by @tejasbubane in #6682.
I chose
rubocop/config.ymlas the config file name since it seems to be the closes to how people use the specification currently.In order to make this non-controversial, I made the XDG file last in the prioritization order instead of in front of
$HOME. This could be changed if you prefer, or possibly changed later on (although that would then be a breaking change, while it would only be a minor bump doing it now).Documentation and changelog has been updated. I made the documentation pretty verbose, but I can dial it back if you wish. Hopefully having the algorithm spelled out in a clear example makes it easier for people to grasp how it works.
FileFinderlost theuse_homeoption as it now seems unrelated to traversing directories, and more to do with where the config files are located unless they are found by traversing the directories.The new private methods in
ConfigLoaderis written in a way to make the prioritization fairly clear and easy to change and relate to in the future.