fix: clarify --param flag description with key=value format example#2068
Closed
chengyixu wants to merge 1 commit intoasyncapi:masterfrom
Closed
fix: clarify --param flag description with key=value format example#2068chengyixu wants to merge 1 commit intoasyncapi:masterfrom
chengyixu wants to merge 1 commit intoasyncapi:masterfrom
Conversation
Closes asyncapi#1977 The --param flag description was vague, causing users to fail before discovering the required key=value format from the error message. Updated to include an example format in the help text so users succeed on their first try without needing to trigger an error first.
chengyixu
requested review from
AayushSaini101,
Amzani,
Shurtu-gal,
Souvikns and
asyncapi-bot-eve
as code owners
🦋 Changeset detectedLatest commit: 88e2455 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 |
|
Author
|
Hi @asyncapi/cli-maintainers! All CI checks are passing for this PR. Happy to make any adjustments needed for merge. Thanks! |
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.
Summary
Fixes #1977
The
--param/-pflag description in thegenerate fromTemplatecommand was vague (Additional param to pass to templates), offering no hint about the required format. Users had to fail first (trigger the errorIt must be in the format of --param name1=value1) to discover the correct syntax.Changes
Updated the flag description in
src/apps/cli/internal/flags/generate/sharedFlags.tsto include an inline example:Before:
After:
Why