Skip to content
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

feat: add eslint peer dependency #106

Merged
merged 5 commits into from
Sep 27, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/compat/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@
"rollup": "^4.16.2",
"typescript": "^5.4.5"
},
"peerDependencies": {
"@types/eslint": "^9.6.0"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that the eslint package itself publishes its own types (eslint/eslint#18854), @types/eslint is no longer necessary in general. I'd assumed the plan was to turn it into a stub type definition per normal DefinitelyTyped practices. Should this be switched to "eslint", along with the meta lower on?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd assumed the plan was to turn it into a stub type definition per normal DefinitelyTyped practices.

We don't know normal DefiniteTyped practices. 😄 Can you open an issue somewhere for this task explaining what it is?

Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg Sep 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, per eslint/eslint#18928 (comment) I'll mark this as needing to switch from @types/eslint to eslint. Thanks @snitin315!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

switched to eslint ^9.10.0 (first version with bundled typings)
@nzakas @JoshuaKGoldberg Question: Should the "optional" be removed? (Can this package be used without eslint?)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think optional can stay. This package doesn't use eslint at runtime, only at dev time to validate types. @JoshuaKGoldberg?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

},
"peerDependenciesMeta": {
"@types/eslint": {
"optional": true
}
},
"engines": {
"node": "^18.18.0 || ^20.9.0 || >=21.1.0"
}
Expand Down