AsyncAPI VS Code Preview Goes Web: Now Available in Your Browser 🚀 #4484
Conversation
Ruchip16
requested review from
Mayaleeeee,
TRohit20,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg,
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. |
|
We require all PRs to follow Conventional Commits specification. |
![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.
WalkthroughTwo files are added: a TypeScript declaration file for Next.js type references and a new blog post announcing web browser compatibility for the AsyncAPI VS Code Preview extension. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes The TypeScript declaration file is trivial boilerplate. The blog post requires straightforward content review for clarity and accuracy, with no code logic to evaluate. Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ 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 #4484 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ 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-4484--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: 2
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
next-env.d.ts(1 hunks)pages/blog/asyncapi-vs-code-preview-goes-web-now-available-in-your-browser-.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
pages/blog/asyncapi-vs-code-preview-goes-web-now-available-in-your-browser-.md
[uncategorized] ~20-~20: The official name of this software platform is spelled with a capital “H”.
Context: ...Open any GitHub repo in vscode.dev or github.dev, and you can instantly preview As...
(GITHUB)
[grammar] ~21-~21: There might be a mistake here.
Context: ...your browser and an internet connection. 🔄 **Works consistently across desktop a...
(QB_NEW_EN)
[grammar] ~22-~22: There might be a mistake here.
Context: ..., providing the same preview experience. ## What Changed Under the Hood? Making the...
(QB_NEW_EN)
[style] ~30-~30: Consider using “incompatible” to avoid wordiness.
Context: ...Removed EDAVisualizer* (unmaintained, not compatible with webmode) - **Updated VS Code depen...
(NOT_ABLE_PREMIUM)
[grammar] ~37-~37: There might be a mistake here.
Context: ...lone repos locally just to preview files 🚀 **Teams adopting AsyncAPI in cloud-fi...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...rkflows** - Work entirely in the browser 💡 New users experimenting without n...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...ing** without needing to install VS Code This is a huge usability improvement...
(QB_NEW_EN)
[grammar] ~48-~48: There might be a mistake here.
Context: ...ll render beautifully in your browser 🚀 ## See It in Action *[Video demo section -...
(QB_NEW_EN)
[style] ~74-~74: For conciseness, consider replacing this expression with an adverb.
Context: ...ity - No new major features are planned at the moment - Community contributions for bug fixes...
(AT_THE_MOMENT)
| @@ -0,0 +1,85 @@ | |||
| --- | |||
| title: AsyncAPI VS Code Preview Goes Web: Now Available in Your Browser 🚀 | |||
| date: 2025-10-14T3:45:29+05:30 | |||
There was a problem hiding this comment.
Fix ISO-8601 timestamp formatting
The hour in the date field needs two digits (e.g., T03 instead of T3). Without the leading zero, the timestamp is invalid ISO-8601 and risks breaking date parsing in the site build pipeline. Please pad the hour with a zero.
🤖 Prompt for AI Agents
In
pages/blog/asyncapi-vs-code-preview-goes-web-now-available-in-your-browser-.md
around line 3, the ISO-8601 timestamp in the date field uses a single-digit hour
("T3") which is invalid; update the timestamp to pad the hour to two digits
(e.g., change T3 to T03) so the date reads like 2025-10-14T03:45:29+05:30.
| *[Video demo section - placeholder for showcasing the web extension in action]* | ||
|
|
||
| <!-- TODO: Add video demo showing: | ||
| - Opening a GitHub repo in vscode.dev | ||
| - Installing the AsyncAPI Preview extension | ||
| - Previewing an AsyncAPI file in the browser | ||
| - Highlighting the seamless experience --> |
There was a problem hiding this comment.
Remove placeholder + TODO before publishing
The published article currently shows “[Video demo section - placeholder…]” alongside an inline TODO block. Ship-ready content shouldn’t expose placeholders/TODOs to readers. Please either add the actual video content now or remove the section entirely.
🤖 Prompt for AI Agents
In
pages/blog/asyncapi-vs-code-preview-goes-web-now-available-in-your-browser-.md
around lines 52 to 58, remove the placeholder line "*[Video demo section -
placeholder for showcasing the web extension in action]*" and the HTML TODO
block; if you have the demo video ready, replace that whole block with the
embedded video or a linked thumbnail and a short caption describing the steps
shown (opening a GitHub repo in vscode.dev, installing the AsyncAPI Preview
extension, previewing a file, highlighting the experience); otherwise delete the
section entirely so no placeholders or TODOs remain in the published article.
|
|
||
| - **Removed Node.js-specific modules** like `fs`, `path`, and external dependencies that are incompatible with browsers | ||
| - **Introduced lightweight browser utilities** (`pathUtils`) for cross-platform file handling | ||
| - **Removed EDAVisualizer** (unmaintained, not compatible with webmode) |
There was a problem hiding this comment.
replace with:
- Removed EDAVisualizer integration (unmaintained, not compatible with webmode)
because the integration is what is unmaintained
|
|
||
| ## See It in Action | ||
|
|
||
| *[Video demo section - placeholder for showcasing the web extension in action]* |
There was a problem hiding this comment.
you need to add this section before aproving
|
4 participants
Description
Related issue(s)
Fixes #4450
Summary by CodeRabbit