-
-
Notifications
You must be signed in to change notification settings - Fork 1
fix(deps): declare missing dependencies #26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
The types import `@typescript-eslint/utils` and `type-fest`. These dependencies were missing from `package.json`.
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the WalkthroughAdded two dependencies to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Important
Looks good to me! 👍
Reviewed everything up to a9b4905 in 1 minute and 4 seconds. Click for details.
- Reviewed
16
lines of code in1
files - Skipped
1
files when reviewing. - Skipped posting
3
draft comments. View those below. - Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. package.json:54
- Draft comment:
Added dependency '@typescript-eslint/utils'. Confirm if it should be in dependencies (runtime) or devDependencies (type-only). - Reason this comment was not posted:
Confidence changes required:33%
<= threshold50%
None
2. package.json:57
- Draft comment:
Added missing dependency 'type-fest'. Validate its placement based on how its types are used. - Reason this comment was not posted:
Confidence changes required:33%
<= threshold50%
None
3. package.json:56
- Draft comment:
Comma added to 'stable-hash-x' for valid JSON formatting. Confirm consistency with the rest of the file. - Reason this comment was not posted:
Confidence changes required:33%
<= threshold50%
None
Workflow ID: wflow_Z2kybVsOseDN2Z4d
You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
package.json (1)
53-58
: Consider movingtype-fest
todevDependencies
.
type-fest
is a type-only package; after transpilation no runtimerequire()
call is emitted, so it will never be loaded in production. Moving it todevDependencies
keeps the runtime install footprint minimal and avoids consumers of this library pulling an unnecessary package."dependencies": { "@typescript-eslint/utils": "^8.34.0", "get-tsconfig": "^4.10.1", "stable-hash-x": "^0.2.0", - "type-fest": "^4.39.1" +}, +"devDependencies": { + "type-fest": "^4.39.1",(Adjust surrounding commas/indentation accordingly.)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lock
is excluded by!**/yarn.lock
,!**/*.lock
📒 Files selected for processing (1)
package.json
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Socket Security: Pull Request Alerts
🔇 Additional comments (1)
package.json (1)
53-55
: Double-check version compatibility between@typescript-eslint/utils
and ESLint 9.The repo now depends on
eslint@^9.29.0
(dev) while@typescript-eslint/utils@^8.34.0
historically aligned with ESLint 8. Recent releases of@typescript-eslint/*
may already declare compatibility with ESLint 9, but the major is still 8. Please confirm no peer-dependency warnings are produced.If incompatibilities appear, bumping to the latest
@typescript-eslint
version that explicitly supports ESLint 9 will prevent runtime failures when rules use the utils package.
This is a workaround for un-ts/eslint-import-context#26.
Sorry I didn't notice this PR, but I'm also unusre should we mark types as |
If you intend to support TypeScript, you should make sure the types work without type errors. That means that if the imports end up in the published declaration files, they should be declared in the package dependencies. The alternative is to not publish type definitions and leave that to DefinitelyTyped. But knowing you and considering this project is written in TypeScript, I don’t think that’s what you want. |
The types import
@typescript-eslint/utils
andtype-fest
. These dependencies were missing frompackage.json
.Important
Add missing dependencies
@typescript-eslint/utils
andtype-fest
topackage.json
.@typescript-eslint/utils
version^8.34.0
todependencies
inpackage.json
.type-fest
version^4.39.1
todependencies
inpackage.json
.This description was created by
for a9b4905. You can customize this summary. It will automatically update as commits are pushed.
Summary by CodeRabbit
@typescript-eslint/utils
andtype-fest
.