Skip to content

deps: move peer types to optional peerDeps #122

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

Merged
merged 1 commit into from
Feb 15, 2025
Merged

Conversation

agilgur5
Copy link
Owner

@agilgur5 agilgur5 commented Feb 15, 2025

Summary

Move @types/react and @types/prop-types to optional peerDependencies

Details

Future Work

- `react` and `prop-types` are peerDeps, so their `@types/` packages should be too
  - and since they're peers now, we can [mark them as optional](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#peerdependenciesmeta) as well (since they're only needed for TS usage)
  - this should also allow for users to be able to install a range of `@types/react` as well, instead of just v19
@agilgur5 agilgur5 added the scope: types Related to type definitions label Feb 15, 2025

This comment was marked as resolved.

Copy link
Owner Author

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

✅ LGTM. CI still passes with the types deps changes

@agilgur5 agilgur5 merged commit cb1e784 into main Feb 15, 2025
8 checks passed
@agilgur5 agilgur5 deleted the deps-optional-types branch February 15, 2025 02:45
@agilgur5
Copy link
Owner Author

This is in preparation for the v1.1.0 TS release

v1.1.0-alpha.1 has been released as the first official native TS release

@agilgur5 agilgur5 added the scope: dependencies Pull requests that update a dependency file label Feb 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: dependencies Pull requests that update a dependency file scope: types Related to type definitions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant