Add customization point for command usage text #400
Merged
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.
Description
This adds a
usage
property toCommandConfiguration
that lets tool authors customize their command's usage string.Detailed Design
The
CommandConfiguration
type now has ausage
property that defaults to anil
string. When non-nil
, this string is used instead of the auto-generated usage string.Documentation Plan
Symbol documentation is included, but the Help article should be updated to show this additional API.
Test Plan
Unit tests cover the new feature.
Source Impact
This is an additive change, and requires a new initializer for
CommandConfiguration
. Since the new property has a default value, most existing source should not be affected. Source that references the old initializer (instead of just calling it) will receive a deprecation warning.Checklist