chore: release v1.0.1#8
Conversation
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughRelease prep for v1.0.1: bumped package version, upgraded uWebSockets.js and dev tooling (TypeScript, Jest, types), expanded supported Node.js versions, adjusted tsconfig to Node16 module semantics and scoped types, updated ignore files, and consolidated/refactored CI workflow. Changes
Sequence Diagram(s)sequenceDiagram
participant PR as Pull Request
participant GH as GitHub Actions Runner
participant Checkout as actions/checkout@v6
participant SetupNode as actions/setup-node@v6
participant Npm as npm (scripts)
PR->>GH: push / PR event
GH->>Checkout: checkout repository (v6)
GH->>SetupNode: read node-version-file from package.json (v6)
GH->>Npm: run format check -> lint -> test (npm scripts)
Npm-->>GH: test results
GH-->>PR: status checks (format, eslint, test)
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CHANGELOG.md`:
- Line 23: Fix the typographical error in the changelog entry by replacing the
incorrect word "tyoes" with "types" in the changelog line that reads "Include
Jest tyoes in tsconfig.json" so the entry reads "Include Jest types in
tsconfig.json".
In `@package.json`:
- Around line 86-91: The package.json declares "ts-jest": "^29.0.0" which is
incompatible with "jest": "^30.0.0"; update the ts-jest dependency to a
Jest-30-compatible release (e.g., "ts-jest": "^30.0.0" or the latest 30.x), then
reinstall dependencies and regenerate the lockfile so peer-deps align and run
the test suite to verify compatibility; make the change in package.json where
the "ts-jest" entry appears.
In `@README.md`:
- Around line 56-58: The README currently states "NestJS >= 11.0.0" which
contradicts package.json's peerDependencies entry "@nestjs/common": "^9.0.0 ||
^10.0.0 || ^11.0.0"; choose one: either update package.json's peerDependencies
to "@nestjs/common": "^11.0.0" to match the README, or change the README's line
"NestJS >= 11.0.0" to list supported versions (e.g. "NestJS 9, 10, or 11") so it
matches the existing peerDependencies; modify whichever file contains the
mismatch (README and/or the peerDependencies object) and ensure the text and the
peerDependencies entry for `@nestjs/common` are aligned.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: ccfac418-9323-403b-abee-3842e5c1827e
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (6)
.gitignore.npmignoreCHANGELOG.mdREADME.mdpackage.jsontsconfig.json
| "jest": "^30.0.0", | ||
| "lint-staged": "^16.0.0", | ||
| "prettier": "^3.0.0", | ||
| "reflect-metadata": "^0.2.0", | ||
| "rxjs": "^7.8.1", | ||
| "ts-jest": "^29.0.0", |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Is ts-jest version 29 compatible with Jest 30?
💡 Result:
No—ts-jest v29 is not officially compatible with Jest 30.
ts-jest@29.x declares peerDependencies on jest, @jest/types, and @jest/transform as ^29.0.0, so installing it alongside Jest 30 will produce a peer-dependency mismatch (and may break at runtime). (app.unpkg.com)
ts-jest’s docs also note that using incompatible Jest versions will trigger compatibility warnings (now based on peerDependencies). (kulshekhar.github.io)
Citations:
- 1: https://app.unpkg.com/ts-jest%4029.2.2/files/package.json?utm_source=openai
- 2: https://kulshekhar.github.io/ts-jest/docs/getting-started/version-checking/?utm_source=openai
Upgrade ts-jest to a version compatible with Jest 30.
ts-jest@29 declares peer dependencies on jest@^29.0.0, making it incompatible with Jest 30. Installing both will trigger a peer-dependency mismatch and likely cause runtime failures. Update ts-jest to version 30 or later.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@package.json` around lines 86 - 91, The package.json declares "ts-jest":
"^29.0.0" which is incompatible with "jest": "^30.0.0"; update the ts-jest
dependency to a Jest-30-compatible release (e.g., "ts-jest": "^30.0.0" or the
latest 30.x), then reinstall dependencies and regenerate the lockfile so
peer-deps align and run the test suite to verify compatibility; make the change
in package.json where the "ts-jest" entry appears.
| - Node.js 20, 22, 24, or 25 | ||
| - NestJS >= 11.0.0 | ||
| - TypeScript >= 6.0.0 |
There was a problem hiding this comment.
NestJS version requirement contradicts peerDependencies.
The README states NestJS >= 11.0.0 but package.json (lines 62-63) declares peerDependencies as "@nestjs/common": "^9.0.0 || ^10.0.0 || ^11.0.0". This mismatch means consumers on NestJS 9.x or 10.x won't receive npm install-time warnings despite the documented incompatibility.
Either update peerDependencies to ^11.0.0 only, or revert the README to reflect continued support for NestJS 9.x and 10.x.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 56 - 58, The README currently states "NestJS >=
11.0.0" which contradicts package.json's peerDependencies entry
"@nestjs/common": "^9.0.0 || ^10.0.0 || ^11.0.0"; choose one: either update
package.json's peerDependencies to "@nestjs/common": "^11.0.0" to match the
README, or change the README's line "NestJS >= 11.0.0" to list supported
versions (e.g. "NestJS 9, 10, or 11") so it matches the existing
peerDependencies; modify whichever file contains the mismatch (README and/or the
peerDependencies object) and ensure the text and the peerDependencies entry for
`@nestjs/common` are aligned.
…t, upgrade dependencies
20.60.0Summary by CodeRabbit
New Features
Changed
Documentation
Chores