-
Notifications
You must be signed in to change notification settings - Fork 870
docs: clarify Bun Prisma usage and Bun-specific config behavior #7407
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: clarify Bun Prisma usage and Bun-specific config behavior #7407
Conversation
WalkthroughThis PR updates Prisma CLI invocations across documentation to standardize Bun runtime usage by adding the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes This is a highly homogeneous set of changes: consistent pattern replacements across documentation files with no logic complexity or structural modifications. The updates are straightforward CLI syntax changes and configuration adjustments specific to Bun runtime behavior. Possibly related PRs
Pre-merge checks✅ Passed checks (3 passed)
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 |
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
🍈 Lychee Link Check Report
📊 Results Overview
Errors per inputErrors in 200-orm/800-more/350-ai-tools/100-cursor.mdx
Errors in 800-guides/380-vercel-app-deployment.mdx
|
Deploying docs with
|
| Latest commit: |
0b1d3e8
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://836da326.docs-51g.pages.dev |
| Branch Preview URL: | https://dr-6458-use-bun-bun-run-pris.docs-51g.pages.dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
content/200-orm/500-reference/325-prisma-config-reference.mdx (1)
747-775: Consider adding bunx command examples for completeness.The section heading mentions both
npx prismaandbunx --bun prisma, but all the examples (lines 760, 768, 775) only shownpxcommands. While the current approach is acceptable since the heading makes it clear the behavior applies to both, adding correspondingbunx --bunexamples would improve clarity.Optional: Add bunx examples alongside npx
For example, at line 760:
Example run from the project root: ```bash npx prisma validate +# or with Bun: +bunx --bun prisma validate # → Works as expectedAnd similarly for lines 768 and 775. </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between fc2b71945b99e4100f86ad37c18414ab7e0280b7 and 0b1d3e80590d33d7eb3db5aaa165cec9cce59e48. </details> <details> <summary>📒 Files selected for processing (4)</summary> * `content/200-orm/400-tools/05-prisma-cli.mdx` * `content/200-orm/500-reference/325-prisma-config-reference.mdx` * `content/800-guides/370-bun.mdx` * `content/800-guides/440-elysia.mdx` </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)</summary> * GitHub Check: Check internal links * GitHub Check: Cloudflare Pages </details> <details> <summary>🔇 Additional comments (5)</summary><blockquote> <details> <summary>content/800-guides/370-bun.mdx (3)</summary><blockquote> `60-67`: **LGTM! Consistent update with clear explanation.** The addition of the `--bun` flag to the `prisma init` command is correct, and the accompanying note clearly explains why it's necessary. This matches the guidance provided throughout the PR. --- `210-224`: **LGTM! Correct seed configuration for Bun.** The seed script configuration using `bun run prisma/seed.ts` is appropriate for the Bun runtime. The example correctly omits the `import 'dotenv/config'` line since Bun auto-loads environment variables, which aligns with the guidance in the note below. --- `227-231`: **LGTM! Helpful clarification for Bun users.** The note clearly explains that Bun auto-loads `.env` files and that the `dotenv/config` import (which `prisma init` generates) can be safely removed. This is valuable guidance that helps Bun users understand the difference from Node.js behavior. </blockquote></details> <details> <summary>content/200-orm/400-tools/05-prisma-cli.mdx (1)</summary><blockquote> `76-83`: **LGTM! Clean and consistent update.** The update to include the `--bun` flag in the Bun usage example is correct, and the accompanying note clearly explains the requirement. This change is consistent with the Bun-specific guidance throughout the PR. </blockquote></details> <details> <summary>content/800-guides/440-elysia.mdx (1)</summary><blockquote> `55-55`: **LGTM! Comprehensive and consistent updates across all Prisma commands.** All `bunx prisma` commands have been correctly updated to `bunx --bun prisma` throughout this guide: - Line 55: `init` command - Line 114: `migrate dev` command - Line 115: `generate` command - Line 166: `db seed` command - Line 172: `studio` command The changes are consistent with the Bun-specific guidance introduced in the other documentation files. While this guide doesn't include explanatory notes (unlike the Bun and reference guides), this is appropriate for an integration guide where readers are assumed to be familiar with the basic Bun setup. Also applies to: 114-115, 166-166, 172-172 </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.