-
Notifications
You must be signed in to change notification settings - Fork 1
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
docs: add readme, instructions and explanation #6
Merged
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
fa10da3
add readme with intro, instructions and explanation
b0edfdf
Merge branch 'main' into readme-firstpass
tobiashochguertel 4176270
remove badges
43ebe4e
Merge branch 'readme-firstpass' of github-james:mswjs/jest-fixed-jsdo…
43b9323
remove duplicate instructions, use suggested update
bcaf74e
remove unneeded testenvironmentoptions
c71d538
docs: rephrase the readme
kettanaito File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,23 @@ | ||
# jest-fixed-jsdom | ||
<h1 align="center">jest-fixed-jsdom</h1> | ||
<p align="center">This library helps re-attach missing NodeJS globals definitions in JSDOM that Jest strips out</p> | ||
|
||
## Motivation | ||
|
||
Jest strips out a number of NodeJS globals that are used in tests and libraries involving JSDOM, such as structuredClone, ReadableStream, and so on. This library patches these globals back in - there is no polyfilling or mocking involved, it simply re-attaches the missing globals to the JSDOM environment. If you've ever come across errors such as `ReferenceError: ReadableStream is not defined` or `ReferenceError: structuredClone is not defined`, this library is for you. If you were previously using (undici)[https://www.npmjs.com/package/undici] purely to solve this, you will no longer need it. | ||
|
||
## Installation | ||
|
||
`npm install jest-fixed-jsdom -D` | ||
|
||
JamesZoft marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## Configuring your jest environment to use jest-fixed-jsdom | ||
|
||
You will need to add/modify two properties in your jest configuration to use jest-fixed-jsdom. | ||
|
||
```json | ||
{ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would be nice to add a comment that mentions what file this is ( |
||
"testEnvironment": "jest-fixed-jsdom" | ||
} | ||
``` | ||
|
||
Setting `testEnvironment` to `jest-fixed-jsdom` will tell Jest to use jest-fixed-jsdom as the test environment. Setting `customExportConditions` to an empty array will stop JSDOM from using the browser environment to load exports. | ||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not entirely correct. There are a few things that happen in the Jest/JSDOM combo:
ReadableSteam
,TextEncoder
,TextDecoder
.Event
andstructuredClone()
.If you want, I can help you rewrite this section. Let me know.