doc: mark "output" option to-be-duplicated for core plugins

[ymc9]

Summary by CodeRabbit

• Documentation
  • Updated documentation for @core/enhancer and @core/zod plugins to reflect changes in configuration options.
  • Added deprecation notices for the output option, encouraging users to transition to the --output CLI option.
  • Changed the default value of preserveTsFiles from true to false.
  • Enhanced clarity with new examples for using the zenstack generate command and its options.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
zenstack-new-site	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 12, 2024 8:11pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request updates the documentation for the @core/enhancer and @core/zod plugins. It includes deprecation notices for the output option, which will be replaced by the --output CLI option in future releases. Additionally, the default value of the preserveTsFiles option has been changed from true to false for both plugins. New examples have been added to illustrate the usage of the zenstack generate command, enhancing user understanding of output directory and compilation behavior.

Changes

File	Change Summary
docs/reference/plugins/enhancer.md	Updated output option to indicate deprecation; changed preserveTsFiles default to false; added examples for --output and --no-compile.
docs/reference/plugins/zod.md	Updated output option to indicate deprecation; changed preserveTsFiles default to false; modified example usage to emphasize zenstack generate.

Possibly related PRs

• docs: v2.6.0 release #369: The changes in the @core/zod plugin documentation regarding the output option's deprecation and the default value for preserveTsFiles are directly related to the similar updates made in the main PR for both the @core/enhancer and @core/zod plugins.

---

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.