Removing depictLiteral
#2698
Removing depictLiteral
#2698
Conversation
WalkthroughThe changes remove the custom Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocumentationHelpers
participant Zod
User->>DocumentationHelpers: Request literal schema depiction
DocumentationHelpers->>Zod: Delegate depiction to Zod (>=3.25.49)
Zod-->>DocumentationHelpers: Return depicted literal schema
DocumentationHelpers-->>User: Return depicted schema
Possibly related PRs
Suggested labels
Poem
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
package.json (1)
51-51: Approve zod dependency bump
ThezoddevDependency has been correctly updated from^3.25.48to^3.25.49to leverage native literal schema support and remove the customdepictLiteralhelper.
Remember to commit the updated lockfile to ensure reproducible builds.CHANGELOG.md (1)
9-10: ℹ️ Suggestion: Document the Zod version bump explicitly.You’ve linked the fix for literal depiction to Zod v3.25.49, but it may be helpful to callers to see a standalone note that the project’s Zod peer dependency has been updated to
^3.25.49. For example:- Updated Zod peer dependency to ^3.25.49
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
express-zod-api/tests/__snapshots__/documentation-helpers.spec.ts.snapis excluded by!**/*.snapexpress-zod-api/tests/__snapshots__/endpoint.spec.ts.snapis excluded by!**/*.snapexpress-zod-api/tests/__snapshots__/sse.spec.ts.snapis excluded by!**/*.snapyarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (4)
CHANGELOG.md(1 hunks)express-zod-api/src/documentation-helpers.ts(0 hunks)express-zod-api/tests/documentation-helpers.spec.ts(0 hunks)package.json(1 hunks)
💤 Files with no reviewable changes (2)
- express-zod-api/tests/documentation-helpers.spec.ts
- express-zod-api/src/documentation-helpers.ts
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: build (24.x)
- GitHub Check: build (20.9.0)
- GitHub Check: build (22.x)
- GitHub Check: build (22.0.0)
🔇 Additional comments (1)
CHANGELOG.md (1)
8-8: ✅ Approved: Enum override removal documented clearly.The entry correctly references the improved implementation in Zod v3.25.45 for the enum depiction override.
…rd compatibility (#2699) Partially reverts #2697 and #2698 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated changelog entry to clarify that the documentation generator now prioritizes Zod's native depiction for enums and literals. - **New Features** - Improved handling of enums and literals in generated documentation, ensuring more accurate type representation. - **Tests** - Added new test cases to validate the depiction of enums and literals in the documentation output. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Summary by CodeRabbit
Documentation
Chores
Tests