docs: removing --use-new-generator flag refference#5065
docs: removing --use-new-generator flag refference#5065Jatin24062005 wants to merge 1 commit intoasyncapi:masterfrom
Conversation
Jatin24062005
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
princerajpoot20,
sambhavgupta0705 and
thulieblack
as code owners
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
📝 WalkthroughWalkthroughThe changes remove the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 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)
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #5065 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 796 796
Branches 146 146
=========================================
Hits 796 796 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5065--asyncapi-website.netlify.app/ |
![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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
markdown/docs/tools/generator/versioning.md (1)
18-31:⚠️ Potential issue | 🟡 MinorUpdate pinned versions to current releases and add context for legacy examples.
The versions
@asyncapi/cli@0.20.0and@asyncapi/html-template@0.7.0do exist on npm and are not officially deprecated, but they are 4–6 years old (from June 2022 and May 2020 respectively). Current safe releases are@asyncapi/cli@5.0.7+or@asyncapi/cli@6.0.0(released Feb 1, 2026) and@asyncapi/html-template@3.5.4.The second code example mixes an old generator workflow without explanation. Either update both examples to current versions or clearly mark the second example as legacy/compatibility-testing documentation.
🤖 Fix all issues with AI agents
In `@markdown/docs/tools/generator/usage.md`:
- Around line 60-61: The inline code span shown in the template usage contains
an extra leading space (" {{ params.title }}") which violates MD038; edit the
markdown so the inline code has no inner spaces—change the snippet to use `{{
params.title }}` (remove the leading/trailing space inside the code span)
wherever the template example appears to satisfy the lint rule.
🧹 Nitpick comments (1)
components/GeneratorInstallation.tsx (1)
24-27: Remove the trailing space in the default params string.This space is interpolated into generated npm and Docker commands (lines 57 and 65), resulting in trailing whitespace in command examples shown to users.
♻️ Proposed fix
- const [params, setParams] = useState<string>('-o example '); + const [params, setParams] = useState<string>('-o example');
|
|
||
| In the template you can use it like this: ` {{ params.title }}` |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, check if the file exists and read lines around 60-61
wc -l markdown/docs/tools/generator/usage.mdRepository: asyncapi/website
Length of output: 102
🏁 Script executed:
# Read the relevant section of the file with context
sed -n '55,65p' markdown/docs/tools/generator/usage.md | cat -nRepository: asyncapi/website
Length of output: 529
🏁 Script executed:
# Run markdownlint to check for violations in this file
npx markdownlint-cli2 markdown/docs/tools/generator/usage.md 2>&1Repository: asyncapi/website
Length of output: 4885
🏁 Script executed:
# Create a test version with the proposed fix and verify it resolves MD038
sed '61s/` {{ params.title }}`/`{{ params.title }}`/' markdown/docs/tools/generator/usage.md > /tmp/usage_fixed.md
# Run markdownlint on the fixed version and filter for MD038 on line 61
npx markdownlint-cli2 /tmp/usage_fixed.md 2>&1 | grep -E "61.*MD038" || echo "No MD038 error on line 61 after fix"Repository: asyncapi/website
Length of output: 95
Remove inner space in inline code to satisfy MD038.
Line 61 has spaces inside a code span, which violates the MD038 linting rule. Remove the leading space to fix.
✏️ Proposed fix
-In the template you can use it like this: ` {{ params.title }}`
+In the template you can use it like this: `{{ params.title }}`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| In the template you can use it like this: ` {{ params.title }}` | |
| In the template you can use it like this: `{{ params.title }}` |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 61-61: Spaces inside code span elements
(MD038, no-space-in-code)
🤖 Prompt for AI Agents
In `@markdown/docs/tools/generator/usage.md` around lines 60 - 61, The inline code
span shown in the template usage contains an extra leading space (" {{
params.title }}") which violates MD038; edit the markdown so the inline code has
no inner spaces—change the snippet to use `{{ params.title }}` (remove the
leading/trailing space inside the code span) wherever the template example
appears to satisfy the lint rule.
2 participants
Description
This PR removes outdated references to the --use-new-generator flag from the project website. The flag was deprecated and removed from the CLI, but the website still mentioned it. This update ensures consistency between the website and the Generator Library documentation.
Related issue(s)
asyncapi/generator#1872
Summary by CodeRabbit
Documentation
Bug Fixes