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

add storybook coverage exclude entries #7020

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

Conversation

ndelangen
Copy link

Description

Storybook stories can be considered test, especially with the storybook test plugin for vitest in the works, they are converted into test files.

When enabling coverage in that scenario, it's undesired to have the story files count for measuring coverage.

Therefore is useful for those files to be excluded.

It would be possible for vitest users to configure this, however we think it could be useful to add this to the default set of coverage exclude patterns inside of vitest itself.

More context here:
storybookjs/storybook#29613

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:.

Copy link

netlify bot commented Dec 4, 2024

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 8e8173f
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/67507d8872db8a000840e832
😎 Deploy Preview https://deploy-preview-7020--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.

@AriPerkkio
Copy link
Member

We are considering removing all non-Vitest related defaults from coverage.exclude, see:

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