Core: Add typescript as optional peer dependency #13330
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -67,6 +67,11 @@ | |||
| "react": "^16.8.0 || ^17.0.0", | |||
| "react-dom": "^16.8.0 || ^17.0.0" | |||
| }, | |||
| "peerDependenciesMeta": { | |||
| "typescript": { | |||
There was a problem hiding this comment.
Shouldn't typescript be listed as peerDependencies too? Or having this peerDependenciesMeta info is enough and Yarn will "do it" for us under the hood?
There was a problem hiding this comment.
Technically it would be more correct to list it, yes. However when we introduced the feature some maintainers were concerned that it would print more warnings on older package managers (for example for their users running npm 5), so we improved it by making peerDependenciesMeta imply a corresponding peer dependency on * (this way older package managers just ignore the peer dependency). So in short, it's as you prefer, we support both 🙂
gaetanmaisse
approved these changes
Nov 29, 2020
shilman
changed the title
shilman
approved these changes
Dec 1, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue: TypeScript is a peer dependency for
fork-ts-checker-webpack-pluginandreact-docgen-typescript-plugin, but isn't provided by neither@storybook/corenor@storybook/react, and thus generates warnings:What I did
Since Yarn requires peer dependencies to be listed at every level of dependency chains, I've added TypeScript as an optional peer dependency of both
@storybook/coreand@storybook/react, so that they can forward the package to their own dependencies.How to test
n/a