fix: generated zod schemas fail to compile when outputting to a custom dir

[ymc9]

Fixes #1610

[coderabbitai]

Walkthrough

Walkthrough

This update modifies the EnhancerGenerator and output handling in the plugin's logic, introducing flexibility in output path configurations while ensuring the integrity of schema loading through regression tests. The changes also include a directive to suppress ESLint warnings for specific imports. These modifications aim to resolve issues with generated schemas and enhance the overall functionality of the Prisma client integration.

Changes

Files	Change Summary
packages/schema/src/plugins/enhancer/enhance/index.ts	Added /* eslint-disable */ comment directive to suppress linting warnings for imports from @zenstackhq/runtime.
packages/schema/src/plugins/enhancer/index.ts	Modified output path handling logic to accommodate both options.output and globalOptions?.output. Updated path variable for Prisma client types.
tests/regression/tests/issue-1610.test.ts	Introduced regression tests for issue #1610, validating Prisma client behavior with various schema configurations.

Assessment against linked issues

Objective	Addressed	Explanation
Generated zod schemas compile correctly with custom output (1610)	✅
Ensure logical Prisma client handles default values correctly (1610)	✅

Possibly related issues

• adding plugin @core/enhancer breaks validation checks for @core/zod plugin #1562: The changes may indirectly address validation issues with the zod plugin when integrating with the enhancer plugin, as adjustments to how outputs are handled could resolve conflicts affecting validation checks.

---

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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 17fe8c3 and 5b2a4c6.

Files selected for processing (3)

• packages/schema/src/plugins/enhancer/enhance/index.ts (1 hunks)
• packages/schema/src/plugins/enhancer/index.ts (1 hunks)
• tests/regression/tests/issue-1610.test.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• packages/schema/src/plugins/enhancer/enhance/index.ts

Additional comments not posted (5)

tests/regression/tests/issue-1610.test.ts (3)

1-19: Test case for regular Prisma client looks good.

The test case correctly specifies a custom output directory and verifies schema loading.

---

21-37: Test case for logical Prisma client looks good.

The test case correctly specifies a custom output directory and verifies schema loading. The default value for authorId is handled appropriately.

---

39-55: Test case for no custom output looks good.

The test case correctly specifies the preservation of TypeScript files and verifies schema loading.

packages/schema/src/plugins/enhancer/index.ts (2)

27-28: Enhanced flexibility in output path handling looks good.

The condition now accommodates scenarios where the output might be defined in either options or globalOptions.

---

31-31: Update to construct absolute path for Prisma client types looks good.

The change ensures that the output directory is determined correctly and enhances the configurability of the function.