📘 docs: add Nitro preset requirement

[runyasak]

Overview

This PR updates the Nuxt integration documentation to include the required Nitro configuration with Bun preset.
The documentation now clearly states that nitro.preset: 'Bun' is required in the Nuxt config for Elysia to run properly.

Scope of work

added nitro.preset: 'Bun' configuration to the Nuxt config example and tips

Related Issues

#552 (comment)

Summary by CodeRabbit

• Documentation
  • Updated Nuxt integration guide with Bun server runtime configuration requirements
  • Added clarification on setting up Bun compatibility for Nuxt projects
  • Included example API endpoint code for reference

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation update to the Nuxt integration guide adding Bun runtime configuration (nitro.preset: 'Bun'), an explanatory tip for users, and a sample API route example to illustrate endpoint implementation.

Changes

Cohort / File(s)	Summary
Documentation: Nuxt Integration docs/integrations/nuxt.md	Added Bun runtime preset configuration to Nitro settings in Nuxt config example; included user-facing tip explaining why nitro.preset: 'Bun' is required for Elysia compatibility; added sample GET route returning a hello message.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A little guide grows clearer now,
With Bun runtime, we take a bow—
Config, tips, and routes so bright,
Nuxt meets Elysia, pure delight! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: adding documentation for the Nitro preset requirement in Nuxt configuration for Elysia.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0fa92ee and 37813be.

📒 Files selected for processing (1)

• docs/integrations/nuxt.md (1 hunks)

🔇 Additional comments (3)

docs/integrations/nuxt.md (3)

31-38: LGTM!

The Nuxt config example correctly introduces the nitro configuration with preset: 'Bun' alongside the module setup. Formatting and structure are accurate.

---

41-43: LGTM!

The tip clearly explains the rationale behind the nitro.preset: 'Bun' requirement, addressing the gap identified in the discussion. The explanation helps users understand why this configuration is necessary rather than treating it as arbitrary boilerplate.

---

47-50: LGTM!

The api.ts example provides a minimal but complete working example. The default export correctly returns an Elysia instance with a sample GET route, demonstrating the basic pattern users need to implement their own endpoints.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}