feat(docs): update prismaExtension for new mode functionality in 4.1.1 #2690
Conversation
|
WalkthroughDocumentation across three files was updated to reflect a new mode-centric architecture for prismaExtension. The primary file, prismaExtension.mdx, was significantly restructured to explicitly document three modes (legacy, engine-only, modern) with decision trees, feature matrices, use-case guidance, and comprehensive examples. The changes include migration paths, configuration options, schema support details, and deployment guidance. Secondary files (frameworks/prisma.mdx and manual-setup.mdx) were updated to include the required mode parameter in configuration examples. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 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 |
![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
🧹 Nitpick comments (1)
docs/config/extensions/prismaExtension.mdx (1)
189-195: Standardize on "prebuild" or "pre-build" terminology.The document mixes variants: "prebuild" appears in line 190 (
"prebuild": "prisma generate"), while "pre-build" appears in line 341 ("configure a pre-build command"). Choose one variant consistently.Recommendation: Use
prebuild(npm script convention) for code and "pre-build" for descriptive text discussing the build process, or standardize on one throughout. Thepackage.jsonscripts convention favorsprebuildas the script name.-configure a pre-build command +configure a prebuild commandAlso applies to: 341-341
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/images/pre-build-command-prisma-generate.pngis excluded by!**/*.png
📒 Files selected for processing (3)
docs/config/extensions/prismaExtension.mdx(1 hunks)docs/guides/frameworks/prisma.mdx(1 hunks)docs/manual-setup.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/config/extensions/prismaExtension.mdx
[grammar] ~16-~16: Use a hyphen to join words.
Context: ... from previous versions ### Before (pre 4.1.1) ```ts import { prismaExtension }...
(QB_NEW_EN_HYPHEN)
[uncategorized] ~325-~325: The official name of this software platform is spelled with a capital “H”.
Context: ...lf before deploying your project. #### Github Actions If you are deploying your proj...
(GITHUB)
[uncategorized] ~339-~339: The official name of this software platform is spelled with a capital “H”.
Context: ...R_ACCESS_TOKEN }} ``` #### Trigger.dev Github integration If you are using the [Trig...
(GITHUB)
[uncategorized] ~341-~341: The official name of this software platform is spelled with a capital “H”.
Context: ...tion If you are using the Trigger.dev Github integration, you ...
(GITHUB)
[uncategorized] ~341-~341: Do not mix variants of the same word (‘pre-build’ and ‘prebuild’) within a single text.
Context: ...ithub-integration), you can configure a pre-build command to run prisma generate before...
(EN_WORD_COHERENCY)
[uncategorized] ~341-~341: Do not mix variants of the same word (‘pre-build’ and ‘prebuild’) within a single text.
Context: ...oject's settings page and configure the pre-build command to run prisma generate, for e...
(EN_WORD_COHERENCY)
⏰ 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). (1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (8)
docs/manual-setup.mdx (1)
314-323: Correctly documents mode parameter addition.The addition of
mode: "legacy"aligns with the broader PR changes and example usage across other files. The configuration is clear and properly integrated.docs/guides/frameworks/prisma.mdx (1)
87-105: Clear documentation of mode parameter requirement.The example properly shows
mode: "legacy"with helpful documentation directing users to the full Prisma extension documentation. This provides appropriate context for users in the frameworks guide.docs/config/extensions/prismaExtension.mdx (6)
14-45: Migration guide clearly documents the required mode parameter.The Before/After examples effectively show the transition path for existing users. The mode requirement is prominently highlighted and examples are consistent across the file.
47-70: Decision tree provides good UX for mode selection.The mermaid flowchart is clear and helps users quickly identify which mode fits their use case. The color coding and feature bullets reinforce the decision logic.
74-284: Comprehensive per-mode documentation with appropriate examples.Each mode section clearly documents use cases, features, schema configurations, and tested versions. The documentation provides sufficient detail for users to implement each mode correctly.
347-356: Version compatibility matrix is helpful and clear.The matrix effectively summarizes which mode to use for each Prisma version range, with appropriate notes about requirements and features. This is valuable reference material.
590-687: Troubleshooting section covers the main error scenarios.The section addresses common issues (missing schema, version detection, binary targets, TypedSQL, config file errors) with clear diagnostic steps and solutions. This will be helpful for users encountering problems.
691-1005: Five complete examples cover all major use cases.The examples are well-organized (standard setup, multi-file schema, config file, custom output path, Prisma 7 beta) and include realistic configurations with supporting files (package.json, prisma files, TypeScript). Each example is syntactically correct and shows the recommended patterns.
| You can use it for a simple Prisma setup like this: | ||
| ## Migration from previous versions | ||
|
|
||
| ### Before (pre 4.1.1) |
There was a problem hiding this comment.
Hyphenate compound modifier "pre-4.1.1".
"Pre 4.1.1" should use a hyphen when modifying a noun: "pre-4.1.1".
-### Before (pre 4.1.1)
+### Before (pre-4.1.1)📝 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.
| ### Before (pre 4.1.1) | |
| ### Before (pre-4.1.1) |
🧰 Tools
🪛 LanguageTool
[grammar] ~16-~16: Use a hyphen to join words.
Context: ... from previous versions ### Before (pre 4.1.1) ```ts import { prismaExtension }...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In docs/config/extensions/prismaExtension.mdx around line 16, the phrase "Before
(pre 4.1.1)" should hyphenate the compound modifier; update the text to "Before
(pre-4.1.1)" (or otherwise hyphenate any "pre 4.1.1" occurrences on that line)
so the prefix "pre-" correctly modifies the version number.
|
|
||
| When using `modern` and `engine-only` modes, you'll need to ensure that you run `prisma generate` yourself before deploying your project. | ||
|
|
||
| #### Github Actions |
There was a problem hiding this comment.
Capitalize "GitHub" consistently throughout the document.
The platform is officially "GitHub" (not "Github"). This appears in three locations:
- Line 325: "#### Github Actions"
- Line 339: "#### Trigger.dev Github integration"
- Line 341: "[Trigger.dev Github integration]"
-#### Github Actions
+#### GitHub Actions
-#### Trigger.dev Github integration
+#### Trigger.dev GitHub integration
-[Trigger.dev Github integration]
+[Trigger.dev GitHub integration]Also applies to: 339-339, 341-341
🧰 Tools
🪛 LanguageTool
[uncategorized] ~325-~325: The official name of this software platform is spelled with a capital “H”.
Context: ...lf before deploying your project. #### Github Actions If you are deploying your proj...
(GITHUB)
🤖 Prompt for AI Agents
In docs/config/extensions/prismaExtension.mdx around lines 325, 339, and 341,
replace the incorrect "Github" casing with the official "GitHub" in the headings
and link text; update "#### Github Actions" to "#### GitHub Actions", "####
Trigger.dev Github integration" to "#### Trigger.dev GitHub integration", and
change the link text "[Trigger.dev Github integration]" to "[Trigger.dev GitHub
integration]", ensuring all other occurrences in this file use the same "GitHub"
capitalization for consistency.
No description provided.