fix(jest-transformer): add babel-preset-jest dependency #1112
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
Benchmark resultsBase commit: lwc-engine-benchmark
|
trevor-bliss
changed the title
apapko
approved these changes
Mar 14, 2019
pmdartus
reviewed
Mar 15, 2019
| @@ -16,6 +16,7 @@ | |||
| "@babel/plugin-transform-modules-commonjs": "7.1.0", | |||
| "@babel/template": "~7.1.2", | |||
| "@lwc/errors": "0.37.0", | |||
| "babel-preset-jest": "^24.0.0", | |||
| "deasync": "0.1.14" | |||
| }, | |||
| "peerDependencies": { | |||
There was a problem hiding this comment.
Shall we add instead jest as a peer dependency?
How does other jest transformers deal with this?
There was a problem hiding this comment.
We can add jest as a peer dependency, but we still need a dependency here on babel-preset-jest. This package works with the latest versions of Jest (and I encourage users to stay relatively current), but babel-preset-jest isn't accessible from this package even if the consuming project has a jest dependency.
There was a problem hiding this comment.
Actually, I don't think we need jest as a peer dependency here. This package declares it's own dependencies for the what it uses and the input/output of the transformer hasn't changed in recent versions. It takes in the source code and file path and returns the compiled/transformed code. That should work for older and newer versions of Jest.
We can add a peer dependency for Jest 24 because that's what we want consumers to use but it won't break them to be on Jest 23 so I don't think we should burden them with the warning message if it's not a hard requirement.
There was a problem hiding this comment.
You are assuming here that jest has not introduced a breaking change in babel-preset-jest between 23 and 24.
There was a problem hiding this comment.
The only breaking change Jest listed between 23 and 24 for this package was for to a change that required Babel 7, but the transformer has been on 7 for a while.
I can add the peer dependency just to be safe. I feel like this is moving in a direction where we want the Jest related packages in here to match the Jest major versions though. Similar to how ts-jest does it.
Benchmark resultsBase commit: lwc-engine-benchmark
|
Benchmark resultsBase commit: lwc-engine-benchmark
|
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.
Details
The Jest transformer imports and uses
babel-preset-jestdirectly but does not declare it as a dependency.Although always not fully correct, this did not result in any errors before because the dependency would get hoisted to the project level
node_modulesvia other Jest dependencies anyway. In newer versions of Jest, however,babel-preset-jestis nested injest-config/node_modulesand not accessible by the transformer.Does this PR introduce a breaking change?