-
-
Notifications
You must be signed in to change notification settings - Fork 742
📚 Fix Prisma Extension Docs for Common Misconfigurations (#2167) #2203
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
base: main
Are you sure you want to change the base?
Conversation
…prismaextension-configuration docs: clarify prismaExtension usage
|
WalkthroughThe documentation for the 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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)
docs/config/extensions/prismaExtension.mdx (1)
68-69
: Minor phrasing improvement for clarityThe sentence “which will prevent other generators from being generated” is a bit clunky. Consider:
- ...the `clientGenerator` option to specify the `prisma-client-js` generator, which will prevent other generators from being generated. + ...the `clientGenerator` option to specify the `prisma-client-js` generator and prevent the other generators from running.Pure wording tweak—feel free to ignore if style guidelines prefer the current phrasing.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
đź“’ Files selected for processing (1)
docs/config/extensions/prismaExtension.mdx
(3 hunks)
đź§° Additional context used
đź§ Learnings (1)
docs/config/extensions/prismaExtension.mdx (8)
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-24T08:07:10.028Z
Learning: Build extensions in 'trigger.config.ts' allow customization of the build process, such as copying files, including packages, installing system dependencies, and enabling TypeScript features.
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/webapp.mdc:0-0
Timestamp: 2025-06-24T08:06:34.164Z
Learning: The Prisma client (from @trigger.dev/database) is set up in db.server.ts and should be used for all PostgreSQL access in the webapp.
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-24T08:07:10.028Z
Learning: Incorrect implementation of Trigger.dev tasks (wrong imports, missing exports, deprecated patterns) will break production, fail deployment, and fail to run locally.
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-24T08:07:10.028Z
Learning: When implementing Trigger.dev tasks in files under '**/trigger/**/*.{ts,tsx,js,jsx}', always import from '@trigger.dev/sdk/v3' and export every task, including subtasks, to ensure correct discovery and execution.
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-24T08:07:10.028Z
Learning: Before generating any Trigger.dev task code, always verify: (1) imports are from '@trigger.dev/sdk/v3', (2) every task is exported, and (3) no deprecated code patterns are present.
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-24T08:07:10.028Z
Learning: The 'trigger.config.ts' file configures the Trigger.dev project, specifying task directories, retry settings, telemetry, runtime, machine settings, log level, max duration, and build extensions.
Learnt from: nicktrn
PR: triggerdotdev/trigger.dev#2195
File: hosting/k8s/helm/values.yaml:22-51
Timestamp: 2025-06-25T13:20:17.174Z
Learning: In the Trigger.dev Helm chart values.yaml, the maintainer prefers to use explicit comprehensive warnings for security-sensitive default values rather than implementing secure-by-default behavior that would fail installation. The project uses deterministic default secrets with clear "TESTING ONLY" warnings and instructions for production deployment.
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-06-24T08:07:10.028Z
Learning: The deprecated 'client.defineJob' pattern must never be used in Trigger.dev tasks; always use the 'task' function from '@trigger.dev/sdk/v3' for defining tasks.
…tion-for-prismaextension-configuration Revert "docs: clarify prismaExtension usage"
@saisharan0103 you seem to have reverted all the changes. The first commit looked good to me. |
📚 Fix Prisma Extension Docs for Common Misconfigurations (#2167)
This PR improves the documentation for the
prismaExtension
config intrigger.dev
, addressing confusion around:✅ What’s Fixed
Clarified
schema
usageschema
must point to a.prisma
file, not a folderprismaSchemaFolder
which doesn’t exist in the extension APIExplained
clientGenerator
clearlyclientGenerator
should be the generator ID (e.g.'client'
), not the provider (e.g.'prisma-client-js'
)client
+json
🚨 Added FAQ / Troubleshooting section
📌 Related Issue
Fixes #2167
Credit to @lucafaggianelli for reporting the gaps and sharing reproducible context.
🤝 Contributor Notes
Let me know if you'd like this split into smaller commits or want to adjust anything before merge 🙌