fix: preserve custom attributes as comments in logical prisma schema

[ymc9]

fixes #1909

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request includes updates to two files. The build.gradle.kts file for the JetBrains plugin has its version number incremented from 2.10.0 to 2.10.1. In the index.ts file, several modifications are made to the EnhancerGenerator class, including the addition of a parameter to the generateLogicalPrisma method and updates to the transformTypeAlias and fixDefaultAuthType methods to enhance logical Prisma schema generation and type handling.

Changes

File Path	Change Summary
packages/ide/jetbrains/build.gradle.kts	Version updated from 2.10.0 to 2.10.1.
packages/schema/src/plugins/enhancer/enhance/index.ts	Updated generateLogicalPrisma method to include customAttributesAsComments parameter; modified transformTypeAlias and fixDefaultAuthType methods for better schema handling.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure customAttributesAsComments flag affects schema comments (#1909)	✅

Possibly related PRs

• chore: bump version #1459: This PR also involves a version bump in the build.gradle.kts file for the JetBrains plugin, updating the version from 2.1.1 to 2.1.2.
• chore: bump version #1481: Similar to the main PR, this PR updates the version number in the build.gradle.kts file from 2.1.2 to 2.2.0.
• chore: bump version #1729: This PR reflects a version increment in the build.gradle.kts file, changing the version from 2.5.2 to 2.6.0.
• chore: bump version #1778: This PR updates the version in the build.gradle.kts file from 2.6.2 to 2.7.0, maintaining the same file structure.
• chore: bump version #1788: This PR also involves a version update in the build.gradle.kts file, changing the version from 2.7.0 to 2.7.1.

---

📜 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 8d6a710 and d54d175.

⛔ Files ignored due to path filters (13)

• package.json is excluded by !**/*.json
• packages/ide/jetbrains/package.json is excluded by !**/*.json
• packages/language/package.json is excluded by !**/*.json
• packages/misc/redwood/package.json is excluded by !**/*.json
• packages/plugins/openapi/package.json is excluded by !**/*.json
• packages/plugins/swr/package.json is excluded by !**/*.json
• packages/plugins/tanstack-query/package.json is excluded by !**/*.json
• packages/plugins/trpc/package.json is excluded by !**/*.json
• packages/runtime/package.json is excluded by !**/*.json
• packages/schema/package.json is excluded by !**/*.json
• packages/sdk/package.json is excluded by !**/*.json
• packages/server/package.json is excluded by !**/*.json
• packages/testtools/package.json is excluded by !**/*.json

📒 Files selected for processing (2)

• packages/ide/jetbrains/build.gradle.kts (1 hunks)
• packages/schema/src/plugins/enhancer/enhance/index.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• packages/ide/jetbrains/build.gradle.kts

🔇 Additional comments (1)

packages/schema/src/plugins/enhancer/enhance/index.ts (1)

286-286: Verify prismaGenerator.generate supports customAttributesAsComments option

The addition of customAttributesAsComments: true to the prismaGenerator.generate() call depends on this parameter being supported. Please ensure that the PrismaSchemaGenerator class has the generate method updated to accept and properly handle the customAttributesAsComments parameter.

Run the following script to confirm that PrismaSchemaGenerator.generate accepts customAttributesAsComments as a parameter:

✅ Verification successful

customAttributesAsComments option is properly supported by PrismaSchemaGenerator

The verification shows that:

• PrismaSchemaGenerator class has a private field customAttributesAsComments
• The generate method accepts this option through its parameters and validates it
• The option is used in multiple test cases, indicating it's a supported feature
• The implementation includes proper type checking and error handling for this option

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that 'PrismaSchemaGenerator.generate' method supports 'customAttributesAsComments' parameter.

# Find the definition of 'PrismaSchemaGenerator' class and check for 'generate' method with 'customAttributesAsComments'
rg -A 10 'class PrismaSchemaGenerator' | rg 'async generate\([^)]*customAttributesAsComments[^)]*\)'

Length of output: 102

---

Script:

#!/bin/bash
# Let's try a broader search to find the PrismaSchemaGenerator class definition and its generate method
rg -A 20 "class PrismaSchemaGenerator"

# Also search for any interface or type definitions that might define the generate method parameters
rg "interface.*PrismaSchemaGenerator|type.*PrismaSchemaGenerator"

# Search for any usage of customAttributesAsComments in the codebase
rg "customAttributesAsComments"

Length of output: 3701

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.