Rewrite option, env, and config handling #282
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
pbrisbin
changed the title
This completely replaces our options, environment, and configuration
handling with the off-the-shelf library `opt-env-conf`.
All settings are now normalized and parsed through the three sources, we
have a much richer help and man-page output, and we dropped a massive
amount of code.
It's hard to say what users were relying on, so we aimed to be somewhat
compatible, but not completely. Options and configuration are backwards
completely compatible because we know users rely on the latter and
`actions/run` uses the former. We gave ourselves more liberties with
environment variables, in the interest of normalization and simplicity.
Here is a possibly-not-exhaustive summary of changes:
* Options (backwards-compatible)
* Added `--config-file`
* Added `--{also,}exclude`
* Added `--ignore-{authors,branches,labels}`
* Added `--restylers-version`
* Added `--host-directory`
* Added `--restyler-{restricted,net-none,cpu-shares,memory}`
* Every switch has both `--x` and `--no-x`.
* Environment (backwards-compatible)
* Added `CONFIG_FILE`
* Added `FAIL_ON_DIFFERENCES`
* Added `{ALSO_,}EXCLUDE`
* Added `IGNORE_{AUTHORS,BRANCHES,LABELS}`
* Added `RESTYLERS_VERSION`
* Environment (**not** backwards-compatible)
* Changed `NO_IMAGE_CLEANUP` to `IMAGE_CLEANUP=False`
* Changed `NO_PULL` to `PULL=False`
* Changed `NO_COMMIT` to `COMMIT=False`
* Changed `NO_CLEAN` to `CLEAN=False`
* Changed `UNRESTRICTED` to `RESTYLER_RESTRICTED=False`
* Config (backwards-compatible)
* Added `logging.*`
* Added `dry_run`
* Added `fail_on_differences`
* Added `restylers_manifest`
* Added `docker.*`
* Added `git.*`
* Added `ignore.*` (`ignore_*` is still supported)
pbrisbin
force-pushed
the
pb/option-values
branch
from
14fd50a to
862816b
Compare
pbrisbin
changed the title
Because `LOG_*` variables are parsed outside and before we parse our `opt-env-conf` settings, they are always overridden by the fact that we use the config file to specify our defaults. If we also parse those variables ourselves, we can ensure they are respected on top of our defaults if given. This works perfectly with `LOG_COLOR` since we parse the same structure and can just read it at its name, but `LOG_LEVEL` has a caveat: it will be respected when set, no matter what. That's because we are parsing boolean switches so we can't fold that into parsing the levels value at the same time and we must do one or the other via `(<|>)`. In other words, ```console LOG_COLOR=always restyle --color=never ``` Works as you expect, but ```console LOG_LEVEL=debug restyle --trace ``` Does not. I think this is acceptable.
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 completely replaces our options, environment, and configuration
handling with the off-the-shelf library
opt-env-conf.All settings are now normalized and parsed through the three sources, we
have a much richer help and man-page output, and we dropped a massive
amount of code.
It's hard to say what users were relying on, so we aimed to be somewhat
compatible, but not completely. Options and configuration are backwards
completely compatible because we know users rely on the latter and
actions/runuses the former. We gave ourselves more liberties withenvironment variables, in the interest of normalization and simplicity.
Here is a possibly-not-exhaustive summary of changes:
--config-file--{also,}exclude--ignore-{authors,branches,labels}--restylers-version--host-directory--restyler-{restricted,net-none,cpu-shares,memory}--xand--no-x.CONFIG_FILEFAIL_ON_DIFFERENCES{ALSO_,}EXCLUDEIGNORE_{AUTHORS,BRANCHES,LABELS}RESTYLERS_VERSIONNO_IMAGE_CLEANUPtoIMAGE_CLEANUP=FalseNO_PULLtoPULL=FalseNO_COMMITtoCOMMIT=FalseNO_CLEANtoCLEAN=FalseUNRESTRICTEDtoRESTYLER_RESTRICTED=Falselogging.*dry_runfail_on_differencesrestylers_manifestdocker.*git.*ignore.*(ignore_*is still supported)For complete details, see the complete reference and the updated
config/defaults.yaml