Skip to content

Fix storybook tests for vitest 4.0.16 compatibility #7406

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.

Sign up for GitHub

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

Closed
Copilot wants to merge 2 commits into from
Closed

Fix storybook tests for vitest 4.0.16 compatibility #7406

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da816c1
Initial plan
Copilot Dec 31, 2025
abc60a4
Fix storybook test for vitest 4.0.16 compatibility
Copilot Dec 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 34 additions & 39 deletions packages/react/src/__tests__/storybook.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import fs from 'node:fs'
import path from 'node:path'
import {describe, expect, test} from 'vitest'
import glob from 'fast-glob'
import groupBy from 'lodash.groupby'

const ROOT_DIRECTORY = path.resolve(__dirname, '..', '..')

Expand Down Expand Up @@ -84,51 +83,47 @@ const stories = await Promise.all(
}),
)

const components = Object.entries(
groupBy(stories, ({name}) => {
return name
}),
)
// Flatten the stories array to work with vitest 4.0.16's stricter suite function rules
const flattenedStories = stories.map(story => ({
testName: `${story.name} - ${story.story.default.title} (${story.relativeFilepath})`,
...story,
}))

describe.each(components)('%s', (_component, stories) => {
for (const {story, type, relativeFilepath} of stories) {
describe(`${story.default.title} (${relativeFilepath})`, () => {
test('title follows naming convention', () => {
// Matches:
// - title: 'Components/TreeView'
// Does not match:
// - title: 'Component/TreeView/Features'
// - title: 'TreeView'
const defaultTitlePattern = /Components\/\w+/
describe.each(flattenedStories)('$testName', ({story, type}) => {
test('title follows naming convention', () => {
// Matches:
// - title: 'Components/TreeView'
// Does not match:
// - title: 'Component/TreeView/Features'
// - title: 'TreeView'
const defaultTitlePattern = /Components\/\w+/

// Matches:
// - title: 'Components/TreeView/Features'
// Does not match:
// - title: 'Component/TreeView'
// - title: 'TreeView'
const featureTitlePattern = /Components\/\w+\/Features/
// Matches:
// - title: 'Components/TreeView/Features'
// Does not match:
// - title: 'Component/TreeView'
// - title: 'TreeView'
const featureTitlePattern = /Components\/\w+\/Features/

expect(story.default.title).toMatch(type === 'default' ? defaultTitlePattern : featureTitlePattern)
})
expect(story.default.title).toMatch(type === 'default' ? defaultTitlePattern : featureTitlePattern)
})

if (type === 'default') {
test('exports a Default story', () => {
expect(story.Default).toBeDefined()
})
if (type === 'default') {
test('exports a Default story', () => {
expect(story.Default).toBeDefined()
})

test('Default story does not have `args`', () => {
expect(story.Default.args).not.toBeDefined()
})
test('Default story does not have `args`', () => {
expect(story.Default.args).not.toBeDefined()
})

test('Default story does not have `argTypes`', () => {
expect(story.Default.argTypes).not.toBeDefined()
})
test('Default story does not have `argTypes`', () => {
expect(story.Default.argTypes).not.toBeDefined()
})

test('only exports Default and Playground stories', () => {
for (const storyName of Object.keys(story)) {
expect(/^Default$|^(.*)Playground$|^default$/.test(storyName)).toBe(true)
}
})
test('only exports Default and Playground stories', () => {
for (const storyName of Object.keys(story)) {
expect(/^Default$|^(.*)Playground$|^default$/.test(storyName)).toBe(true)
}
})
}
Expand Down
Loading