Initialize config defaults independent of CLI usage #274
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
chore(refactor): Move config related things unrelated to CLI specifics into config.js module. Make it easier to spot differences between external user config schema and runtime config schema.
This reverts commit cf9a64d.
about-code
force-pushed
the
fix-no-config-defaults-when-using-api
branch
from
5e6ac4b
to
87221f4
Compare
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 should not be a breaking change.
The tool is advertised as a command-line tool not as a library package, so API usage is neither advertised nor recommended by any docs. But some API was exported, technically, mostly to integrate with other tools.
Potential users of
run(conf)API function were more likely to run into errors when not providing config options which would have been initialized when using the CLI. API users which faced those errors are likely to have adapted by providing necessary values as part of a user configuration. With this change the API behaves like the CLI and initializes default values the same way as the CLI but user configuration values continue to win. So users who have already adapted to the old situation should not see any differences while new users could now pass the same minimal configuration torun(conf)as they could via CLI.