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

TestAddon: Exclude *.stories.* from coverage #29810

Conversation

ndelangen
Copy link
Member

Closes #29613

What I did

I'm unsure how else to address this issue.
But this fix only addresses the problem when running from storybook, not vitest directly.

The only alternative i can think of would be to change this in the generation.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Copy link

nx-cloud bot commented Dec 4, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit ec8bcf8. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@@ -55,6 +55,7 @@ export class VitestManager {
clean: false,
cleanOnRerun: !watchMode,
reportOnFailure: true,
exclude: [...(this.vitest?.config?.coverage?.exclude || []), '**/*.stories.*'],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
exclude: [...(this.vitest?.config?.coverage?.exclude || []), '**/*.stories.*'],
exclude: [...(this.vitest?.config?.coverage?.exclude || []), '**/*.stories.*', 'storybook-static'],

@@ -55,6 +55,7 @@ export class VitestManager {
clean: false,
cleanOnRerun: !watchMode,
reportOnFailure: true,
exclude: [...(this.vitest?.config?.coverage?.exclude || []), '**/*.stories.*'],
Copy link
Contributor

@JReinhold JReinhold Dec 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this.vitest is always going to be undefined at this point, either because this is the first time starting it, or becase a restart always closes vitest first.

So I don't think this is adequate to combine with the user's and/or Vitest's default exclude list.

We need to first resolve the Vitest config, and then we can read from it. The Vitest maintainers have given me a code snippet like this, that should work (maybe with slight modifications):

import { resolveConfig as viteResolveConfig } from 'vite';
import { VitestPlugin, resolveConfig as vitestResolveConfig } from 'vitest/node';

const resolveConfig = async () => {
  const viteConfig = await viteResolveConfig({
    plugins: [VitestPlugin()]
  });
  return vitestResolveConfig(viteConfig);
}

image
image

@ndelangen ndelangen closed this Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants