docs: remove --use-new-generator flag from Generator docs#1910
Conversation
Jatin24062005
requested review from
Florence-Njeri,
asyncapi-bot-eve,
derberg,
jonaslagoni and
magicmatatjahu
as code owners
|
What reviewer looks at during PR reviewThe following are ideal points maintainers look for during review. Reviewing these points yourself beforehand can help streamline the review process and reduce time to merge.
|
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughRemoved Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@apps/generator/docs/usage.md`:
- Around line 84-85: The template specifier in the example contains an invalid
semver with a trailing dot; replace the malformed "@asyncapi/html-template@3.0."
token in the CLI example string with the correct semver
"@asyncapi/html-template@3.0.0" so the command reads e.g. asyncapi generate
fromTemplate test/docs/apiwithref.json `@asyncapi/html-template`@3.0.0 -o ./build/
--force-write --map-base-url https://schema.example.com/crm/:./test/docs/.
|
🚀 Docs preview deployed |
Adi-204
left a comment
Adi-204
left a comment
There was a problem hiding this comment.
hey @Jatin24062005 left few comments. You have some conflicts in package-lock.json file. I think again you are probably working on older version, pull changes from master branch of generator. The PR is related to docs, you should not have any changes in package-lock.json, revert the changes.
apps/generator/docs/versioning.md
Outdated
| ``` | ||
|
|
||
| > AsyncAPI CLI has multiple versions of the generator, and to use the latest version, you may need to pass the `--use-new-generator` flag. For more details you can also check [asyncapi generate fromTemplate ASYNCAPI TEMPLATE](https://www.asyncapi.com/docs/tools/cli/usage#asyncapi-generate-fromtemplate-asyncapi-template) | ||
| > AsyncAPI CLI has multiple versions of the generator. For more details you can also check [asyncapi generate fromTemplate ASYNCAPI TEMPLATE](https://www.asyncapi.com/docs/tools/cli/usage#asyncapi-generate-fromtemplate-asyncapi-template) |
There was a problem hiding this comment.
If cli has removed --use-new-generator than I don't think this point make sense and we need to remove point completely.
There was a problem hiding this comment.
If cli has removed
--use-new-generatorthan I don't think this point make sense and we need to remove point completely.
Completely Agree with you.
I recloned the repo but the Issue is Related to docs i think it will be better to remove |
Jatin24062005
force-pushed
the
Removing_(--use-new-generator)_flag
branch
from
73b7070 to
9f3e2ac
Compare
Jatin24062005
force-pushed
the
Removing_(--use-new-generator)_flag
branch
from
fcf529c to
8eeff12
Compare
derberg
left a comment
derberg
left a comment
There was a problem hiding this comment.
please also update any version info for html-template from 3.0.0 to 3.5.4
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/generator/docs/usage.md (1)
43-118:⚠️ Potential issue | 🟡 MinorFix incomplete version string at line 84.
Line 84 contains a malformed template version:
@asyncapi/html-template@3.0.— the version number is incomplete. This should be corrected to either@asyncapi/html-template@3.0.0or aligned with the other examples using@asyncapi/html-template@3.5.4.Example
# Current (line 84): asyncapi generate fromTemplate test/docs/apiwithref.json `@asyncapi/html-template`@3.0. -o ./build/ --force-write --map-base-url https://schema.example.com/crm/:./test/docs/ # Should be: asyncapi generate fromTemplate test/docs/apiwithref.json `@asyncapi/html-template`@3.5.4 -o ./build/ --force-write --map-base-url https://schema.example.com/crm/:./test/docs/
🧹 Nitpick comments (1)
apps/generator/docs/usage.md (1)
61-61: Remove spaces inside code span elements.The inline code has leading/trailing spaces inside the backticks. Per markdown best practices (MD038), remove the extra spaces.
📝 Proposed fix
-In the template you can use it like this: ` {{ params.title }}` +In the template you can use it like this: `{{ params.title }}`
Adi-204
left a comment
Adi-204
left a comment
There was a problem hiding this comment.
@Jatin24062005 I would suggest to run commands locally and make sure it is working.
|
@Adi-204 now i am done with Changes Please look into this again : ) |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/generator/docs/usage.md (1)
43-118:⚠️ Potential issue | 🟠 MajorConfirm
@asyncapi/html-template@3.5.4 is published to npm registry.Version 3.5.4 exists on GitHub but cannot be confirmed as available on npm; cached sources still show 3.3.1 as the latest published version, with 3.3.2 and 3.3.3 flagged as malicious (GMS-2025-701). If 3.5.4 is not yet published to npm, all CLI examples using this version will fail. Verify availability by running:
npm view `@asyncapi/html-template`@3.5.4 versionFix inline code spacing (MD038): Line 61 has a leading space in the code span. Change
` {{ params.title }}`to`{{ params.title }}`.
🤖 Fix all issues with AI agents
In `@apps/generator/docs/usage.md`:
- Line 61: The inline code span in docs/usage.md contains extra spaces (` {{
params.title }}`) which triggers markdownlint MD038; remove the leading and
trailing spaces so the inline code uses `{{ params.title }}` instead. Locate the
template example in the usage documentation (the line showing the template usage
with params.title) and update the code span to the trimmed form to satisfy the
linter.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/generator/docs/usage.md (1)
43-118:⚠️ Potential issue | 🔴 CriticalReplace all instances of
@asyncapi/html-template@3.5.4with@asyncapi/html-template@3.3.1.Version 3.5.4 does not exist in the npm registry or official GitHub releases. The latest available version is 3.3.1 (released 2025-07-15). Versions 3.3.2 and 3.3.3 contain malicious code and should not be recommended. All examples throughout lines 43-118 reference the non-existent version and must be corrected to use 3.3.1.
🧹 Nitpick comments (1)
apps/generator/docs/usage.md (1)
56-59: Minor: Extra space in command.Line 58 has a double space between the template version and the
-oflag.🔧 Suggested fix
-asyncapi generate fromTemplate asyncapi.yaml `@asyncapi/html-template`@3.5.4 -o ./docs -p title='Hello from param' +asyncapi generate fromTemplate asyncapi.yaml `@asyncapi/html-template`@3.5.4 -o ./docs -p title='Hello from param'
Adi-204
left a comment
Adi-204
left a comment
There was a problem hiding this comment.
@Jatin24062005 as I told last time please run the updated command and attach ss in the PR desc that it is working fine. Thanks!
|
Hi @Adi-204, |
@Jatin24062005 I told you to verify commands but how will I know? It thought it was obvious and you will understand. |
derberg
changed the title
--use-new-generator flag from Generator docs
|
|
/rtm |
4 participants
Description
This PR updates outdated documentation related to the --use-new-generator flag. The flag was previously mentioned in Version.md and usage.md, but has since been removed from the CLI. This PR removes those references to ensure the documentation is consistent with the current state of the repository.
There are some attached Screenshot Checked Locally :
And Other CMD are working well too.
Related issue(s)
#1872
Summary by CodeRabbit