Validate script arguments #43
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
If a user provides unknown arguments to a script this is silently ignored. This can lead to time consuming typos, e.g. 'versoin' instead of 'version'. This change set ensures that no unknown arguments can be applied to a script. It also detects all errors before stopping execution so unknown arguments, missing required arguments and non-parsable arguments are reported in one go. $ shuttle --project examples/moon-base run required-arg b=1 d shuttle failed Arguments not valid: 'd' not <argument>=<value> 'a' not supplied but is required 'b' unknown Script 'required-arg' accepts the following arguments: a (required) Lastly acceptable arguments are printed on any of the above errors to help users detect their mistakes fast.
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.
If a user provides unknown arguments to a script this is silently ignored.
This can lead to time consuming typos, e.g.
versoininstead ofversion.This change set ensures that no unknown arguments can be applied to a script. It also detects all errors before stopping execution so unknown arguments, missing required arguments and non-parsable arguments are reported in one go.
Lastly acceptable arguments are printed on any of the above errors to help users detect their mistakes fast.
This closes #38