docs: add missing customAttributesAsComments option to prisma plugin
#387
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Contributor
WalkthroughThe documentation has been updated in two main files: Changes
Possibly related PRs
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/reference/plugins/prisma.md (1)
26-26: Consider adding a code example for better clarity.To help users better understand the impact of this option, consider adding a before/after example showing how the schema looks with and without
customAttributesAsCommentsenabled.Example addition:
### Example ```zmodel title='/schema.zmodel' plugin prisma { provider = '@core/prisma' output = './src/prisma/schema.prisma' }
Example Output
- With
customAttributesAsComments: false(default):- model Post {
- id Int @id
- title String
- @@Allow('create', true)
- }
- With
customAttributesAsComments: true:- model Post {
- id Int @id
- title String
- // @@Allow('create', true)
- }
</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 8bde97053da825dbc51d98c8214c3cf54945b65c and c78c49637e4053d76d3c4abae77ff5c535034c7f. </details> <details> <summary>📒 Files selected for processing (2)</summary> * `docs/guides/edge.md` (1 hunks) * `docs/reference/plugins/prisma.md` (1 hunks) </details> <details> <summary>🔇 Additional comments (2)</summary> <details> <summary>docs/reference/plugins/prisma.md (1)</summary> `26-26`: **Documentation looks good and aligns with PR objectives!** The new option is well-documented with clear description, type, and default value. </details> <details> <summary>docs/guides/edge.md (1)</summary> `126-126`: **LGTM! Good addition about Hono integration.** The added reference to Hono integration provides valuable information for users looking to build more sophisticated backends on Cloudflare Workers. </details> </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
PrismaClientusage.@core/prismaplugin documentation to include a new option,customAttributesAsComments, for generating non-Prisma attributes as comments in the Prisma schema.