Add @emotion/* dependencies to babel-plugin-emotion READMEs #1254
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
babel-plugin-emotion includes macros which may generate application code
that imports these packages, e.g.
import _styled from "@emotion/styled-base";
Normally, this is not a problem when using popular package managers like
npm / yarn because '@emotion/styled-base' is a transitive
dependency of '@emotion/styled', which is hoisted to the root
node_modules folder, enabling it to be found by webpack / node:
node_modules/
@emotion/styled/
...
@emotion/styled-base/
...
But when using strict package managers such as pnpm (or yarn pnp),
@emotion/styled-base cannot be resolved because it can only be resolved
by code inside the @emotion/styled package:
node_modules/
@emotion/styled/
...
node_modules/
@emotion/styled-base/
...
Adding these to the respective READMEs of both babel packages should
help users avoid this issue.
|
Preview Docs Built with commit bebd5ac |
|
This will be fixed when we land #1575 . Closing it right now though to clean up the issue tracker. |
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.
What:
Add @emotion/* dependencies to babel-plugin-emotion / @emotion/babel-preset-css-prop READMEs
Why:
babel-plugin-emotion includes macros which may generate application code
that imports these packages, e.g.
Normally, this is not a problem when using popular package managers like
npm / yarn because '@emotion/styled-base' is a transitive
dependency of '@emotion/styled', which is hoisted to the root
node_modules folder, enabling it to be found by webpack / node:
But when using strict package managers such as pnpm (or yarn pnp),
@emotion/styled-base cannot be resolved because it can only be resolved
by code inside the @emotion/styled package:
Adding these to the respective READMEs of both babel packages should
help users avoid this issue.
How:
Manually editing README.md files.
Checklist: