-
Notifications
You must be signed in to change notification settings - Fork 126
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Add support for swa-cli.config.json file #294
Merged
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
manekinekko
reviewed
Sep 17, 2021
manekinekko
requested changes
Sep 17, 2021
manekinekko
approved these changes
Sep 18, 2021
manekinekko
reviewed
Sep 20, 2021
manekinekko
approved these changes
Sep 25, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. cc @Reshmi-Sriram
sgollapudi77
approved these changes
Sep 27, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
pr: lgtm
A PR has been reviewed (CI is green) and is ready to be merged
scope: cli
Issues happened a the ./src/cli level
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.
Feature:
This feature works as described by @anthonychu in #20 (comment).
swa start
will use this configuration.swa start <config name>
to use a configuration. If<config name>
is not found in the config file, no config will be used.--config
option, which allows the user to specify a specific path to a config file to use.--print-config
options, which prints the picked up configuration. Useful for user debugging.I've updated the readme to document how to use a config file.
One thing to note: this feature can only either take options from the command line or the config file. It cannot merge or mix options. If a configuration from the config file is picked up and used no options passed in via command line will be respected.
This is a limitation of commander. More details at: tj/commander.js#1584
I've also created a JSON Schema for the swa-cli.config.json file.
Tests:
npm run e2e:config
Closes #20