Skip to content

Commit

Permalink
Docs fixes found during 8.5 QA
Browse files Browse the repository at this point in the history
- Add `configDir` option to example configs
- Move coverage exclusion config under Set up heading
    - Add `**/.storybook/**`
  • Loading branch information
kylegach committed Dec 18, 2024
1 parent abe4c88 commit fcd2b24
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 29 deletions.
6 changes: 6 additions & 0 deletions docs/_snippets/vitest-plugin-vitest-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ export default mergeConfig(
defineConfig({
plugins: [
storybookTest({
// The location of your Storybook config, main.js|ts
configDir: './.storybook',
// This should match your package.json script to run Storybook
// The --ci flag will skip prompts and not open a browser
storybookScript: 'yarn storybook --ci',
Expand Down Expand Up @@ -44,6 +46,8 @@ export default mergeConfig(
defineConfig({
plugins: [
storybookTest({
// The location of your Storybook config, main.js|ts
configDir: './.storybook',
// This should match your package.json script to run Storybook
// The --ci flag will skip prompts and not open a browser
storybookScript: 'yarn storybook --ci',
Expand Down Expand Up @@ -78,6 +82,8 @@ export default mergeConfig(
defineConfig({
plugins: [
storybookTest({
// The location of your Storybook config, main.js|ts
configDir: './.storybook',
// This should match your package.json script to run Storybook
// The --ci flag will skip prompts and not open a browser
storybookScript: 'yarn storybook --ci',
Expand Down
6 changes: 6 additions & 0 deletions docs/_snippets/vitest-plugin-vitest-workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ export default defineWorkspace([
extends: './vite.config.ts',
plugins: [
storybookTest({
// The location of your Storybook config, main.js|ts
configDir: './.storybook',
// This should match your package.json script to run Storybook
// The --ci flag will skip prompts and not open a browser
storybookScript: 'yarn storybook --ci',
Expand Down Expand Up @@ -49,6 +51,8 @@ export default defineWorkspace([
extends: './vite.config.ts',
plugins: [
storybookTest({
// The location of your Storybook config, main.js|ts
configDir: './.storybook',
// This should match your package.json script to run Storybook
// The --ci flag will skip prompts and not open a browser
storybookScript: 'yarn storybook --ci',
Expand Down Expand Up @@ -87,6 +91,8 @@ export default defineWorkspace([
extends: './vite.config.ts',
plugins: [
storybookTest({
// The location of your Storybook config, main.js|ts
configDir: './.storybook',
// This should match your package.json script to run Storybook
// The --ci flag will skip prompts and not open a browser
storybookScript: 'yarn storybook --ci',
Expand Down
13 changes: 10 additions & 3 deletions docs/writing-tests/test-addon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,9 @@ Some Storybook frameworks require additional setup to enable the framework's fea
viteConfig,
defineConfig({
plugins: [
storybookTest(),
storybookTest({
// ...
}),
storybookNextJsPlugin(), // 👈 Apply the framework plugin here
],
// ...
Expand All @@ -119,7 +121,9 @@ Some Storybook frameworks require additional setup to enable the framework's fea
viteConfig,
defineConfig({
plugins: [
storybookTest(),
storybookTest({
// ...
}),
storybookVuePlugin(), // 👈 Apply the framework plugin here
],
// ...
Expand All @@ -142,7 +146,9 @@ Some Storybook frameworks require additional setup to enable the framework's fea
viteConfig,
defineConfig({
plugins: [
storybookTest(),
storybookTest({
// ...
}),
storybookSveltekitPlugin(), // 👈 Apply the framework plugin here
],
// ...
Expand Down Expand Up @@ -313,6 +319,7 @@ export default defineWorkspace([
{
plugins: [
storybookTest({
// ...
storybookScript: 'yarn storybook --ci',
storybookUrl: process.env.SB_URL
}),
Expand Down
49 changes: 23 additions & 26 deletions docs/writing-tests/test-coverage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,29 @@ Before coverage can be calculated, you may need to install a support package cor

{/* prettier-ignore-end */}

Additionally (until Vitest 3.0.0 is released), the generated coverage report will include the stories files themselves and output from your built Storybook application. This is misleading and they should be excluded. To do this, you can add the following to your Vitest config:

```ts title="vitest.config.ts"
import { coverageConfigDefaults, defineConfig } from 'vitest/config';

export default defineConfig({
// ...
test: {
coverage: {
// 👇 Add this
exclude: [
...coverageConfigDefaults.exclude,
'**/.storybook/**',
// 👇 This pattern must align with the `stories` property of your `.storybook/main.ts` config
'**/*.stories.*',
// 👇 This pattern must align with the output directory of `storybook build`
'**/storybook-static/**',
],
}
}
})
```

### Usage

Because coverage is built into the Test addon, you can use it everywhere you run your tests.
Expand Down Expand Up @@ -188,32 +211,6 @@ When calculating coverage in the Storybook UI, the following options are always
- `reporter`
- `reportsDirectory`

### Troubleshooting

#### Excluding stories from the coverage report

Until Vitest 3.0.0 is released, the generated coverage report will include the stories files themselves and output from your built Storybook application. This is misleading and they should be excluded. To do this, you can add the following to your Vitest config:

```ts title="vitest.config.ts"
import { coverageConfigDefaults, defineConfig } from 'vitest/config';
export default defineConfig({
// ...
test: {
coverage: {
// 👇 Add this
exclude: [
...coverageConfigDefaults.exclude,
// This pattern must align with the `stories` property of your `.storybook/main.ts` config
'**/*.stories.*',
// This pattern must align with the output directory of `storybook build`
'storybook-static/**',
],
}
}
})
```

</If>

## With the coverage addon
Expand Down

0 comments on commit fcd2b24

Please sign in to comment.