Skip to content
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: update environment.md - mention the vitest's jsdom includes fetch #6429

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

dwjohnston
Copy link

@dwjohnston dwjohnston commented Aug 30, 2024

Description

I spent some time wondering why fetch works using vitest, where some additional manual steps are required for setup with jest. It's helpful to have that mentioned in the docs.

See discussion here: #6428

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

I spent some time wondering why `fetch` works using vitest, where some additional manual steps are required for setup with jest. It's helpful to have that mentioned in the docs.

See discussion here: vitest-dev#6428
@dwjohnston dwjohnston changed the title Update environment.md - mention the vitest's jsdom includes fetch docs: update environment.md - mention the vitest's jsdom includes fetch Aug 30, 2024
Copy link

netlify bot commented Aug 30, 2024

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit a783d99
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/66d1722b7da5390008d15839
😎 Deploy Preview https://deploy-preview-6429--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Aug 30, 2024

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 9d2df6c
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/66d9565c2b23550008f96710
😎 Deploy Preview https://deploy-preview-6429--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sheremet-va
Copy link
Member

Can you explain how this is helpful? Do we need to monitor Jest now to update this statement if they also inject fetch? I don't think comparisons to Jest are useful outside of a migration guide.

@dwjohnston
Copy link
Author

dwjohnston commented Sep 3, 2024

@sheremet-va the change to the docs doesn't make any mention of Jest. I've mentioned it in the PR just as motivation/context for my raising the PR.

What it highlights is that vitest doesn't' use stock standard jsdom - there is some amount of modifications that vitest is applying to jsdom.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants