Closed ymc9 closed 1 month ago
vercel[bot]
commented
1 month ago 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 | Sep 6, 2024 11:32pm |
coderabbitai[bot]
commented
1 month ago The documentation for ZenStack has been updated to clarify limitations regarding API compatibility with edge runtime environments, enhance guidance for using tRPC with different versions, introduce a new command for schema validation in the CLI, and provide details on integrating ZenStack with Prisma Pulse. Additionally, improvements have been made to the @@validate attribute documentation, and new configuration options for the tRPC code generator have been added.
| Files | Change Summary |
|---|---|
| docs/guides/check-permission.md | Added a limitation regarding API compatibility with edge runtime environments (e.g., Cloudflare Workers, Vercel Edge). |
| docs/guides/edge.md | Modified wording to emphasize the importance of importing enhance from @zenstackhq/runtime/edge. |
| docs/guides/prisma-pulse.md | Introduced documentation for integrating ZenStack with Prisma Pulse, detailing the stream() API for real-time data change subscriptions and access policy enforcement. |
| docs/guides/trpc.mdx | Enhanced documentation for tRPC with ZenStack, detailing configuration differences between tRPC v10 and v11, including new import statements and example configurations. |
| docs/reference/cli.md | Added a new check command for schema validation, replacing the info command, and updated options for specifying schema files. |
| docs/reference/plugins/trpc.md | Added new configuration options for the tRPC code generator, including version, importCreateRouter, and importProcedure. |
| docs/reference/prisma-client-ext.md | Added a warning about the limitations of a new API in PrismaClient regarding edge runtime environments. |
| docs/reference/zmodel-language.md | Enhanced documentation for the @@validate attribute, adding optional parameters message and path for improved validation customization. |
docs/guides/trpc.mdx
[style] ~158-~158: Consider using a more formal and expressive alternative to ‘awesome’. Context: ...he ZenStack trpc plugin is based on the awesome work by [Omar Dulaimi](https://github.c... (AWESOME)
docs/reference/plugins/trpc.md
29-29: Expected: 5; Actual: 11; Too many cells, extra data will be missing Table column count (MD056, table-column-count)docs/reference/zmodel-language.md
1648-1648: null Fenced code blocks should have a language specified (MD040, fenced-code-language)
docs/reference/prisma-client-ext.md (1)
`17-19`: **Clear and informative warning note.** The warning note effectively communicates the API's limitations in edge runtime environments. This is crucial for users deploying in such environments to avoid unexpected runtime errors.docs/guides/prisma-pulse.md (1)
`6-46`: **Well-structured and informative documentation.** The documentation provides a clear introduction to using ZenStack with Prisma Pulse. The examples are well-chosen and effectively demonstrate the integration of ZenStack's access policies with the `stream()` API. This will help users understand how to use these features in their real-time applications.docs/guides/trpc.mdx (1)
`7-8`: **Comprehensive and clear documentation for tRPC configurations.** The documentation effectively differentiates between tRPC versions 10 and 11, providing clear examples and necessary import statements for each version. This will greatly assist users in configuring their projects correctly and understanding the changes in tRPC v11. Also applies to: 38-90, 123-156docs/reference/plugins/trpc.md (2)
`27-27`: **Approved: Addition of the `version` configuration option.** This new field allows users to specify the tRPC version they wish to target, enhancing flexibility and forward compatibility. --- `28-29`: **Approved: Addition of `importCreateRouter` and `importProcedure` configuration options.** These fields are correctly marked as required when the `version` is set to "v11". It might be beneficial to clarify in the documentation that these fields are not used when the version is "v10".Tools
Markdownlint
29-29: Expected: 5; Actual: 11; Too many cells, extra data will be missing Table column count (MD056, table-column-count)docs/reference/cli.md (2)
`28-28`: **Approved: Addition of the `check` command.** The new `check` command enhances the CLI by providing a functionality to verify ZenStack schema files for syntax or semantic errors. This is a valuable addition for developers to ensure their schema files are correct before deployment. Also applies to: 238-250 --- `34-47`: **Verify: Removal of the `info` command.** The removal of the `info` command and its replacement with the `check` command needs further verification. If the `info` command provided unique functionality not covered by the `check` command, consider maintaining it or providing an alternative method to access the same information.docs/guides/check-permission.md (1)
`191-191`: **Approved: Addition of the limitation regarding API compatibility with edge runtime environments.** The documentation now clearly states that the API is not supported on platforms like Cloudflare Workers or Vercel Edge, which is crucial for users to be aware of the operational boundaries.
Summary by CodeRabbit
New Features
checkcommand to the CLI for schema validation.Documentation Updates
@@validateattribute documentation with new parameters for better error handling.