feat(config): allows user to read the cookiecutterrc file from various locations #1483
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
…s locations
This allows the ``cookiecutterrc`` file to be read from multiple places:
1) Environ variable ``${COOKIECUTTER_USER_CONFIG_PATH}``
2) ``${XDG_CONFIG_HOME}/cookiecutter/cookiecutterc``
3) ``${XDG_CONFIG_HOME}/cookiecutterrc``
4) ``${HOME}/.cookiecutterrc``
This allows the program to be more conform with the XDG standard.
Related: See also cookiecutter#1355, which has similar ideas for the cache
(``cookiecutters`` and ``cookiecutter_replay`` folders)
jensens
requested changes
Mar 25, 2024
There was a problem hiding this comment.
This is useful!
- See my comment
- add documentation to https://github.com/cookiecutter/cookiecutter/blob/main/docs/advanced/user_config.rst
- test for
_find_first_pathwould be good as well.
| return None | ||
|
|
||
|
|
||
| USER_CONFIG_PATH = _find_first_path( |
There was a problem hiding this comment.
Personally, I do not like execution of slightly more complex code on initialization time. This function should be called in merge_configs below.
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 allows the
cookiecutterrcfile to be read from multiple places:${COOKIECUTTER_USER_CONFIG_PATH}${XDG_CONFIG_HOME}/cookiecutter/cookiecutterc${XDG_CONFIG_HOME}/cookiecutterrc${HOME}/.cookiecutterrcThis allows the program to be more conform with the XDG standard.
Related: See also #1355, which has similar ideas for the cache (
cookiecuttersandcookiecutter_replayfolders)