fix: don't use package name starting with dot

[ymc9]

fixes #1687

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request modifies the plugin-utils.ts file by rearranging import statements and updating the ensureDefaultOutputFolder function. The name property of the pkgJson object changes from '.zenstack' to 'zenstack-generated', and the version property now dynamically calls getVersion(), defaulting to '1.0.0' if undefined. These changes enhance the organization of imports and the way package metadata is defined, while maintaining the existing control flow and error handling.

Changes

File Path	Change Summary
packages/schema/src/plugins/plugin-utils.ts	- Rearranged import statements, moving PluginGlobalOptions to the end. - Added import for getVersion from ../utils/version-utils. - Updated name from '.zenstack' to 'zenstack-generated' in ensureDefaultOutputFolder. - Updated version to call getVersion() with a fallback to '1.0.0'.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure typing information is available for enhance after running zenstack generate (#1687)	❌	The changes do not address the issue of missing typing information for the enhance function.

Possibly related PRs

• fix: avoid importing prisma-related code into language server #1441: Changes to import statements related to @zenstackhq/sdk, possibly connecting to the modifications in import organization.
• fix(zod): generated schemas fail to compile when a delegate discrimin ator field has default value #1705: Addresses issues with schema generation, potentially relevant to changes in package metadata.
• fix: generated code fails to compile when prisma's output path overlaps with zenstack #1765: Modifies import paths and enhances logic for determining paths, related to import statement changes.
• fix(delegate): discriminator fields should be removed from unchecked create/update input types #1804: Focuses on handling discriminator fields in input types, which may relate to changes in the ensureDefaultOutputFolder function.
• fix(json): false error when using typed json in multi-file schemas #1836: Addresses issues with JSON typing in schemas, potentially connecting to changes in package metadata and function logic.

---

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 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

packages/schema/src/plugins/plugin-utils.ts (1)

Line range hint 36-83: Consider documenting the package name change in migration guides

This change in package naming convention could affect existing projects using ZenStack. Consider:

1. Adding a note in the changelog
2. Updating documentation to reflect the new package name
3. Adding migration instructions for existing projects

The change is architecturally sound and should resolve the module resolution issues while maintaining backward compatibility through the exports configuration.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3134f0d and 8f47b37.

📒 Files selected for processing (1)

• packages/schema/src/plugins/plugin-utils.ts (2 hunks)

🔇 Additional comments (3)

packages/schema/src/plugins/plugin-utils.ts (3)

1-8: LGTM: Clean import organization

The import statements are well-organized and the addition of getVersion is necessary for the dynamic version handling.

---

38-38: Verify getVersion implementation and behavior

The dynamic version handling with fallback looks good, but let's verify the implementation of getVersion().

#!/bin/bash
# Check the implementation of getVersion
rg -A 10 "export function getVersion" "src/utils/version-utils.ts"

# Check if getVersion is used consistently across the codebase
rg "getVersion\(\)"

---

37-37: Package name change looks good and addresses the core issue

The change from '.zenstack' to 'zenstack-generated' fixes the dot-prefix package naming issue which could have been causing module resolution problems.

Let's verify existing imports aren't broken: