fix: add format hint to --param flag description (fixes #1977)#2175
Closed
gavin913427-hash wants to merge 1 commit into
Closed
fix: add format hint to --param flag description (fixes #1977)#2175gavin913427-hash wants to merge 1 commit into
gavin913427-hash wants to merge 1 commit into
Conversation
gavin913427-hash
requested review from
AayushSaini101,
Amzani,
Shurtu-gal,
Souvikns and
asyncapi-bot-eve
as code owners
🦋 Changeset detectedLatest commit: 4f2c4bf The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What does this PR do?
Improves the
--paramflag description to include the expected format, so users don't have to fail first to discover the correct syntax (fixes #1977)Changes
Updated the
--paramflag description insrc/apps/cli/internal/flags/generate/sharedFlags.ts:Before:
Additional param to pass to templatesAfter:
Additional param to pass to templates (format: name=value)This matches the format shown in the error message from
parseParams.ts:Why this matters
Users trying common formats like
--param name:valueor--param name:valuewill now see the correct format in--helpbefore encountering an error, improving the CLI's UX.Related issue(s)
Fixes #1977
Checklist