fix(cli): pass through --help flag for tasks that receive args #3046
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.
A common use case for tasks is to act as proxies to other CLIs/tools (e.g. pip, poetry, etc). The current behavior of displaying projen's own help document for the
--help
flag for tasks prevents the proper passthrough of--help
flags that are intended for the downstream tool (whenreceiveArgs
is true).The help document shown for tasks is fairly generic and can't be customized for tasks anyway.
I considered adding an option to the task itself (e.g.
disableHelp: boolean
) to control this behavior, but this current implementation makes more sense to me sincereceiveArgs
should really mean all args. I realize that--inspect
will still be captured by projen, but that one actually does make sense since a) it's not a standard flag on most tools and b) the return value is useful for understanding the task.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.