-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
react: fix to classify @types/react
as a peer dependency
#2281
Conversation
Since `react` is a peerDependency, so should it’s matching type definitions be. However, in order not to bother people not using TypeScript, it’s made optional.
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Codecov ReportAll modified lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #2281 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 23 23
Lines 2499 2499
Branches 4 4
=========================================
Hits 2499 2499 ☔ View full report in Codecov by Sentry. |
I think this will break several setups: https://github.com/orgs/mdx-js/discussions/2238#discussioncomment-5455250. |
If this is done, it should not be done to only react? |
This would only break for users who have relied on This should be done for all frameworks that don’t ship their own types. By coincidence this is only |
You are completely right that that’s what should happen in npm. It is also theoretically better. But it depends on a a recent undocumented change in npm. I am unsure about this change because we operate at a large scale with this very popular package. There are several things that cause my hesitation:
This makes me quite cautious about such changes at a large scale. |
Given a package
A libary for a framework should have a peer dependency on the framework. This the same for framework types. If a user uses Optional peer dependencies continues on the concept of peer dependencies. It means a I’m pretty adamant I also think I can remove the |
I don’t think whether someone uses TS or not can be inferred from |
No, it can’t. Unfortunately npm and other package managers don’t have the concept of optional dependencies based on context. An optional peer dependency basically means the package manager will show a warning or error if a non-matching version is installed alongside the package. It’s kind of similar to the |
Signed-off-by: Titus <tituswormer@gmail.com>
@types/react
as a peerDependency
@types/react
as a peerDependency@types/react
as a peer dependency
Thank you! |
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@mdx-js/loader](https://mdxjs.com) ([source](https://github.com/mdx-js/mdx)) | [`2.3.0` -> `3.0.0`](https://renovatebot.com/diffs/npm/@mdx-js%2floader/2.3.0/3.0.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@mdx-js%2floader/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@mdx-js%2floader/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@mdx-js%2floader/2.3.0/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@mdx-js%2floader/2.3.0/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [@mdx-js/react](https://mdxjs.com) ([source](https://github.com/mdx-js/mdx)) | [`2.3.0` -> `3.0.0`](https://renovatebot.com/diffs/npm/@mdx-js%2freact/2.3.0/3.0.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@mdx-js%2freact/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@mdx-js%2freact/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@mdx-js%2freact/2.3.0/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@mdx-js%2freact/2.3.0/3.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mdx-js/mdx (@​mdx-js/loader)</summary> ### [`v3.0.0`](https://github.com/mdx-js/mdx/releases/tag/3.0.0) [Compare Source](https://github.com/mdx-js/mdx/compare/2.3.0...3.0.0) (see <https://mdxjs.com/migrating/v3/> on how to migrate) ##### Change - [`e08b759`](https://github.com/mdx-js/mdx/commit/e08b7596) [`5afa48e`](https://github.com/mdx-js/mdx/commit/5afa48e6) Change to require Node 16 - [`5a13d73`](https://github.com/mdx-js/mdx/commit/5a13d73b) Change to use export maps - [`cbc2822`](https://github.com/mdx-js/mdx/commit/cbc2822f) Update `unified`, types, plugins, etc - [`96b51f9`](https://github.com/mdx-js/mdx/commit/96b51f93) Remove inferral of development from `NODE_ENV` ##### Change (unlikely to affect you) - [`c961af8`](https://github.com/mdx-js/mdx/commit/c961af80) Remove `useDynamicImport` option - [`9cb26fd`](https://github.com/mdx-js/mdx/commit/9cb26fd1) `@mdx-js/register`: remove package - [`0d1558a`](https://github.com/mdx-js/mdx/commit/0d1558a3) `@mdx-js/esbuild`: remove experimental `allowDangerousRemoteMdx` - [`0f62bce`](https://github.com/mdx-js/mdx/commit/0f62bce9) `@mdx-js/node-loader`: remove `fixRuntimeWithoutExportMap` - [`4f92422`](https://github.com/mdx-js/mdx/commit/4f924227) `@mdx-js/preact`: remove deprecated `MDXContext`, `withMDXComponents` - [`a362bb4`](https://github.com/mdx-js/mdx/commit/a362bb43) `@mdx-js/react`: remove deprecated `MDXContext`, `withMDXComponents` ##### Add - [`e12f307`](https://github.com/mdx-js/mdx/commit/e12f3079) Add support for passing `baseUrl` when running - [`2c511a4`](https://github.com/mdx-js/mdx/commit/2c511a40) Add support for `baseUrl` as a `URL` - [`1863914`](https://github.com/mdx-js/mdx/commit/1863914c) Add deprecation warning for classic runtime - [`a34177c`](https://github.com/mdx-js/mdx/commit/a34177c3) Add support for ES2024 in MDX, adjacent JSX and expression blocks - [`44fd9ca`](https://github.com/mdx-js/mdx/commit/44fd9cac) Add support for `await` in MDX - [`3a7f194`](https://github.com/mdx-js/mdx/commit/3a7f1947) Add `tableCellAlignToStyle` option, to use `align` - [`fdfe17b`](https://github.com/mdx-js/mdx/commit/fdfe17b8) `@mdx-js/rollup`: add support for Vite development mode by [@​remcohaszing](https://github.com/remcohaszing) in [mdx-js/mdx#2376 ##### Misc - [`f48d038`](https://github.com/mdx-js/mdx/commit/f48d038b) Remove unneeded pragma comment after transform - [`8f3b292`](https://github.com/mdx-js/mdx/commit/8f3b2920) Add a `use strict` directive to function bodies - [`172e519`](https://github.com/mdx-js/mdx/commit/172e5190) `@mdx-js/react`: fix to classify `@types/react` as a peer dependency by [@​remcohaszing](https://github.com/remcohaszing) in [mdx-js/mdx#2281 - [`a7bd79b`](https://github.com/mdx-js/mdx/commit/a7bd79bb) Refactor output to immediately export default - [`e525db9`](https://github.com/mdx-js/mdx/commit/e525db9b) [`dae82ae`](https://github.com/mdx-js/mdx/commit/dae82ae4) Refactor some errors - [`ce173f2`](https://github.com/mdx-js/mdx/commit/ce173f28) Refactor to add types for JSX runtimes - [`8a56312`](https://github.com/mdx-js/mdx/commit/8a563128) Refactor output to use spread, not `Object.assign` by [@​remcohaszing](https://github.com/remcohaszing) in [mdx-js/mdx#2328 - [`825717f`](https://github.com/mdx-js/mdx/commit/825717fd) Refactor to sort default components by [@​remcohaszing](https://github.com/remcohaszing) in [mdx-js/mdx#2318 - [`d8a62d2`](https://github.com/mdx-js/mdx/commit/d8a62d20) Add missing type dependencies by [@​arcanis](https://github.com/arcanis) in [mdx-js/mdx#2256 ##### Docs - [`a9f0c04`](https://github.com/mdx-js/mdx/commit/a9f0c046) Add guide on injecting components - [`24e3d8d`](https://github.com/mdx-js/mdx/commit/24e3d8d1) Add compat sections to readmes - [`30e4a5d`](https://github.com/mdx-js/mdx/commit/30e4a5d5) Add sponsor - [`07503a5`](https://github.com/mdx-js/mdx/commit/07503a5f) Update link to KaTeX CSS in docs by [@​victor23k](https://github.com/victor23k) in [mdx-js/mdx#2360 - [`74aee56`](https://github.com/mdx-js/mdx/commit/74aee569) [`bc1d9e5`](https://github.com/mdx-js/mdx/commit/bc1d9e56) [`765310c`](https://github.com/mdx-js/mdx/commit/765310ca) [`6d1e64d`](https://github.com/mdx-js/mdx/commit/6d1e64d9) Refactor docs - [`7fd1d9a`](https://github.com/mdx-js/mdx/commit/7fd1d9a4) Fix docs on how to use solid by [@​BeiyanYunyi](https://github.com/BeiyanYunyi) in [mdx-js/mdx#2300 - [`4129f90`](https://github.com/mdx-js/mdx/commit/4129f90e) Fix a couple typos by [@​deining](https://github.com/deining) in [mdx-js/mdx#2266 - [`bb902f8`](https://github.com/mdx-js/mdx/commit/bb902f83) Fix typo by [@​ChristianMurphy](https://github.com/ChristianMurphy) in [mdx-js/mdx#2380 ##### Site - [`78a1eb5`](https://github.com/mdx-js/mdx/commit/78a1eb52) Add v3 blog post - [`2b1948c`](https://github.com/mdx-js/mdx/commit/2b1948c0) Add v3 migration guide - [`d6bb70c`](https://github.com/mdx-js/mdx/commit/d6bb70ca) Add improved error display in playground - [`89097e4`](https://github.com/mdx-js/mdx/commit/89097e4c) Remove unmaintained dev-dependency - [`3e23ba9`](https://github.com/mdx-js/mdx/commit/3e23ba90) Add more options to playground - [`d92128b`](https://github.com/mdx-js/mdx/commit/d92128ba) Fix links in docs - [`ab3aa96`](https://github.com/mdx-js/mdx/commit/ab3aa966) Add GitHub pages by [@​remcohaszing](https://github.com/remcohaszing) in [mdx-js/mdx#2377 - [`a2c8693`](https://github.com/mdx-js/mdx/commit/a2c86936) Fix site by [@​wooorm](https://github.com/wooorm) in [mdx-js/mdx#2358 - [`dbe9f44`](https://github.com/mdx-js/mdx/commit/dbe9f44b) Fix playground AST views w/ clone by [@​Jokcy](https://github.com/Jokcy) in [mdx-js/mdx#2315 - [`7504cfb`](https://github.com/mdx-js/mdx/commit/7504cfb8) Add more options to playground, directives, format, etc by [@​slorber](https://github.com/slorber) in [mdx-js/mdx#2295 - [`57301df`](https://github.com/mdx-js/mdx/commit/57301dfa) Add resizable editor/layout to playground by [@​slorber](https://github.com/slorber) in [mdx-js/mdx#2296 - [`9eb747d`](https://github.com/mdx-js/mdx/commit/9eb747d6) Add info on how to build site locally by [@​slorber](https://github.com/slorber) in [mdx-js/mdx#2297 **Full Changelog**: mdx-js/mdx@2.3.0...3.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/X-oss-byte/Nextjs).
Since
react
is a peerDependency, so should it’s matching type definitions be. However, in order not to bother people not using TypeScript, it’s made optional.This solves dependency resolution for people using React lower than latest. A practical example:
Create an emtpy directory, and cd into it. Now run:
And inspect the dependency tree:
Alternatively:
You can see there are two versions of
@types/react
. This may cause hard to debug conflicts.This solves the problem people described in https://github.com/orgs/mdx-js/discussions/2238. This is not intentional. They are just lucky
react
doesn’t ship their own type definitions.