docs: add missing bunFullstack option to fullstack dev server guide#834
docs: add missing bunFullstack option to fullstack dev server guide#834thebarbadev wants to merge 1 commit intoelysiajs:mainfrom
Conversation
WalkthroughThe pull request updates documentation for Elysia's Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 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)
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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/patterns/fullstack-dev-server.md`:
- Around line 50-54: Add documentation for the bunFullstack option to the Config
section of docs/plugins/static.md: describe the boolean bunFullstack flag, its
default value, that it must be set to true when using Bun's HTML bundler so
.tsx/.jsx referenced in HTML are compiled instead of served as raw text, and
show its usage example when calling staticPlugin({ ..., bunFullstack: true }).
Also mention the runtime effect (enables Bun's HTML bundler integration) and any
related caveats with staticPlugin().
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 649fcf8a-d3c7-4484-8747-7028ef6f6202
📒 Files selected for processing (1)
docs/patterns/fullstack-dev-server.md
| :::warning | ||
| You also need to pass `bunFullstack: true` option to `staticPlugin()` to enable Bun's HTML bundler. | ||
|
|
||
| Without it, `.tsx` files referenced in your HTML are served as raw text, causing the browser to throw `SyntaxError`. | ||
| ::: |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify whether static plugin docs mention bunFullstack/bundleHTML
rg -n -C2 'bunFullstack|bundleHTML|## Config|###' docs/plugins/static.md docs/patterns/fullstack-dev-server.mdRepository: elysiajs/documentation
Length of output: 2742
🏁 Script executed:
cat docs/plugins/static.md | head -120 | tail -80Repository: elysiajs/documentation
Length of output: 1813
🏁 Script executed:
rg -n 'bunFullstack|bundleHTML' docs/plugins/static.mdRepository: elysiajs/documentation
Length of output: 48
Update static.md to document the bunFullstack option, you careless reviewer~♡
The warning here is totally right, but you forgot to document bunFullstack in docs/plugins/static.md! The Config section lists assets, prefix, ignorePatterns, and all that boring stuff, but bunFullstack is conspicuously missing. Readers will look at the plugin docs and think this guide is full of it ♡
Add bunFullstack to the Config section in docs/plugins/static.md so people aren't left confused~
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/patterns/fullstack-dev-server.md` around lines 50 - 54, Add
documentation for the bunFullstack option to the Config section of
docs/plugins/static.md: describe the boolean bunFullstack flag, its default
value, that it must be set to true when using Bun's HTML bundler so .tsx/.jsx
referenced in HTML are compiled instead of served as raw text, and show its
usage example when calling staticPlugin({ ..., bunFullstack: true }). Also
mention the runtime effect (enables Bun's HTML bundler integration) and any
related caveats with staticPlugin().
Hi guys! Thank you for your good job with Elysia I'm really enjoying the framework, unfortunately i had an issue when testing the fullstack dev server. 2 days ago an option in @elysiajs/static was renamed from bundleHTML to bunFullstack and its default was changed from
truetofalse(elysiajs/elysia-static@a1d0dcf), and this is not reflected in the Elysia pattern docs. Since this option toggles Bun's HTML bundler, it must be explicitly set to true so.jsx/.tsxfiles are bundled correctly. Without it,.jsx/.tsxfiles are served as raw text and the browser throwsSyntaxError.With that said, i'd like to give a little help in maintaining the docs up to date.
Summary by CodeRabbit