fix(cli): Create custom Command type to support custom Usage docs #97
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.
Resolves: #93
Description
This PR implements a custom Click Command type called
TupleCompatibleCommand
, which has a custom usage string implementation which places the[OPTION]
metavar at the end of the usage string.Original
dbt-meshify split [OPTIONS] PROJECT_NAME
Updated
dbt-meshify split PROJECT_NAME [OPTIONS]
This is important from a UX perspective, since
--select
and other type-typed options will eat all subsequent strings that are not themselves options. For example,dbt-meshify split --select foo bar
will yield an error, since
bar
will be interpreted as part of the selector instead of as the project name.Now, if users follow the example, we will have the following correct usage:
dbt-meshify split bar --select foo