Enhancement (config): Change dryRun config option to a boolean integer#142
Merged
leojonathanoh merged 1 commit intomasterfrom Nov 8, 2022
Conversation
bb91353 to
8d34fab
Compare
Previously, `dryRun` config option used integer values `1` and `2`, in order to mirror other non-boolean config options. While it may not be a problem for non-technical users, technical users may find that it makes no sense to have `$dryRun = 1` do an actual conversion, and `$dryRun = 2` do a dry run. It has become apparent that `dryRun` is not more intuitive being an integer. Now, `dryRun` is changed to a boolean (`0` or `1`). Retaining its integer type keeps it easy to use, rather than using actual boolean values `$true` and `$false` which are difficult to type and error prone. This keeps the `dryRun` config options easy to use for both non-technical users and technical users by not violating the principle of least astonishment. Simply set `$dryRun = 0` to disable dry run, and `$dryRun = 1` to enable dry run.
8d34fab to
5258b08
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Previously,
dryRunconfig option used integer values1and2, in order to mirror other non-boolean config options. While it may not be a problem for non-technical users, technical users may find that it makes no sense to have$dryRun = 1do an actual conversion, and$dryRun = 2do a dry run. It has become apparent thatdryRunis not more intuitive being an integer.Now,
dryRunis changed to a boolean (0or1). Retaining its integer type keeps it easy to use, rather than using actual boolean values$trueand$falsewhich are difficult to type and error prone. This keeps thedryRunconfig options easy to use for both non-technical users and technical users by not violating the principle of least astonishment. Simply set$dryRun = 0to disable dry run, and$dryRun = 1to enable dry run.