Option to specify config file with environment variable #255
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
|
Oh hold up, just realized this might be redundant with #119.... EDIT: on a closer reading of 119, I realized that that PR is about putting config data directly into the environment variable, rather than putting a path in the variable (as is the case here). |
`unsetenv` isn't supported on all platforms
adrienverge
reviewed
Apr 27, 2020
There was a problem hiding this comment.
Thanks @wbadart, it looks good.
About the name YAMLLINTRC I agree it's old fashioned, I think the usage of suffix "rc" dates back to before Unix :)
yamllint -h mentions --config-file and --config-data:
-c CONFIG_FILE, --config-file CONFIG_FILE
path to a custom configuration
-d CONFIG_DATA, --config-data CONFIG_DATA
custom configuration (as YAML source)
... so what about YAMLLINT_CONFIG_FILE? (and YAMLLINT_CONFIG_DATA in #119)
Drops the ancient rc-file convention in favor of YAMLLINT_CONFIG_FILE to be more consistent with the rest of the documentation. Uses the `tempfile` module's `NamedTemporaryFile` context manager to handle the creation and cleanup of temp files (`NamedTemporaryFile` has a `delete` option, true by default, which removes the file once it's closed).
|
I took your advice and grepped through some of the other tests to see how they're structured. 8657838 should make the new test here much more consistent with those! |
adrienverge
approved these changes
Apr 28, 2020
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.
Hey team-
This PR instructs the CLI to check the
YAMLLINTRCenvironment variable for a global config path. For most intents and purposes, this can be achieved with the-cflag, but I found a corner case where the environment variable is useful: I'd like to point my editor and my CI server at the same config file, and it's much easier to specify the variable once in something like a.envfile than tweaking how both systems invokeyamllintindividually.I'm not married to the name "
YAMLLINTRC"; please let me know if there's a better name (I've been working with pylint lately, so I think I subconsciously borrowed their convention). Also, please let me know if this is PR is the right place to make the corresponding update to the docs.Thanks!