Addon-Vitest: Handle additional vitest config export patterns in postinstall#34106
Open
Addon-Vitest: Handle additional vitest config export patterns in postinstall#34106
Conversation
Fixes AddonVitestPostinstallError for these patterns:
- defineConfig(mergeConfig(...)) – defineConfig wrapping mergeConfig
- defineConfig(mergeConfig(...) satisfies ViteUserConfig) – satisfies operator
- mergeConfig(...) as ViteUserConfig – TSAsExpression wrapper
- const config = mergeConfig(...); export default config – re-exported variable
- const vitestConfig = {...}; export default mergeConfig(viteConfig, vitestConfig) – constant arg
- defineProject({...}) – defineProject as alias for defineConfig
- const test = {...}; mergeConfig(viteConfig, { test }) – shorthand property
New helpers added to updateVitestFile.ts:
- unwrapTSExpression: peels off TSAsExpression/TSSatisfiesExpression/TSTypeAssertion
- resolveExpression: resolves through variable references + TS type wrappers
- isDefineConfigLike: recognizes defineConfig and defineProject
- getEffectiveMergeConfigCall: finds the mergeConfig call through any wrappers
26 unit tests passing (19 existing + 7 new).
Co-authored-by: valentinpalkovic <5889929+valentinpalkovic@users.noreply.github.com>
- Use proper union type for TS expression unwrapping (TSAsExpression | TSSatisfiesExpression | TSTypeAssertion) - Extract resolveTestPropValue helper to replace nested ternary with a named function Co-authored-by: valentinpalkovic <5889929+valentinpalkovic@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix AddonVitestPostinstallError in vitest config files
fix(vitest-addon): handle additional vitest config export patterns in postinstall
Mar 11, 2026
Contributor
valentinpalkovic
changed the title
valentinpalkovic
changed the title
|
View your CI Pipeline Execution ↗ for commit 3b1fd51
☁️ Nx Cloud last updated this comment at |
Contributor
|
@copilot Fix eslint/prettier issues |
Co-authored-by: valentinpalkovic <5889929+valentinpalkovic@users.noreply.github.com>
Contributor
Author
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds an AST expression resolver and refactors Vitest config merging to be wrapper-aware (defineConfig/defineProject, mergeConfig, TS wrappers, identifier resolution). Expands AST-driven tests and adjusts postinstall template selection based on detected workspace usage. One legacy test file was trimmed to only loadTemplate checks. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Postinstall
participant TemplateLoader
participant Parser
participant Resolver as ExpressionResolver
participant Updater as updateConfigFile
participant FS as FileSystem
Postinstall->>TemplateLoader: request template (may pass configContent)
TemplateLoader->>Parser: load & parse template AST
Postinstall->>Parser: parse target config AST
Updater->>Resolver: resolve wrapped identifiers/expressions in target AST
Resolver-->>Updater: resolved config object node
Updater->>Parser: merge/append projects, hoist coverage, inject plugin code
Updater->>FS: write updated file if modified
FS-->>Postinstall: return write result
Estimated code review effort🎯 4 (Complex) | ⏱️ ~50 minutes Possibly related PRs
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@code/addons/vitest/src/updateVitestFile.ts`:
- Around line 103-110: The type guard isProjectsArrayProp only matches a
`projects` property so objects shaped like `test: { workspace: [...] }` are
missed; update the guard (used when detecting array-valued project lists for
mergeConfig/viteConfig handling) to accept either an Identifier named "projects"
OR an Identifier named "workspace" with ArrayExpression value so the same
append/merge logic applies; locate and change the isProjectsArrayProp predicate
and any usages in the merge flow that rely on it (the mergeConfig/viteConfig
handling where test.workspace is supported) to ensure test.workspace arrays are
treated identically to test.projects arrays.
In `@code/core/src/babel/expression-resolver.ts`:
- Around line 36-39: The declarator lookup only checks for top-level
VariableDeclaration nodes so exported vars like `export const config = ...` are
missed; update the logic that builds `declarator` (in expression-resolver.ts,
where `declarator` and `varName` are used) to also consider
`ExportNamedDeclaration` nodes that have a `declaration` which is a
`VariableDeclaration` (or unwrap exports before flatMapping), i.e. replicate the
dual-check pattern used in findVarInitialization.ts/ConfigFile.ts so you search
both bare VariableDeclaration nodes and VariableDeclaration nodes wrapped inside
ExportNamedDeclaration when matching the identifier name.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1f4592b5-9415-4cef-b789-c473f39ff16b
📒 Files selected for processing (3)
code/addons/vitest/src/updateVitestFile.tscode/core/src/babel/expression-resolver.tscode/core/src/babel/index.ts
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
code/addons/vitest/src/updateVitestFile.config.test.ts (1)
22-1774: It looks like the split left the original catch-all suite behind almost unchanged.Most of these scenarios are now repeated in
updateVitestFile.config.3.2.test.tsandupdateVitestFile.config.workspace.test.ts, so each snapshot-only change has to be updated in multiple places and it is much less clear which suite is authoritative. I'd trim this file down to the genuinely unique cases, or remove it in favor of the split suites.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@code/addons/vitest/src/updateVitestFile.config.test.ts` around lines 22 - 1774, The test file's describe('updateConfigFile') suite contains many snapshot-only scenarios duplicated across updateVitestFile.config.3.2.test.ts and updateVitestFile.config.workspace.test.ts; remove redundant cases from this file by keeping only genuinely unique tests (identify each by the it(...) titles and the top-level describe('updateConfigFile')), or delete this entire file and rely on the split suites, and ensure the canonical scenarios (e.g., tests that exercise updateConfigFile directly) remain in the other two files; after trimming, run the test suite to confirm snapshots are only updated in the authoritative files.code/addons/vitest/src/updateVitestFile.config.4.test.ts (1)
461-538: Remove or repurpose this duplicated snapshot case.This block is a verbatim duplicate of the earlier
adds projects property to test configcase near Line 217, including the same target input and inline snapshot. Keeping both only adds runtime and snapshot churn without expanding coverage.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@code/addons/vitest/src/updateVitestFile.config.4.test.ts` around lines 461 - 538, The test case titled "adds projects property to test config" is duplicated; remove the duplicate block (the second occurrence in updateVitestFile.config.4.test.ts) or modify it to cover a different scenario instead of repeating the exact target and inline snapshot. Locate the duplicated it(...) block that uses babel.babelParse, loadTemplate('vitest.config.4.template', ...), updateConfigFile(source, target) and getDiff(before, after) and either delete that whole it(...) test or change its inputs/expected snapshot to exercise a distinct behavior (e.g., different CONFIG_DIR or BROWSER_CONFIG) to avoid runtime and snapshot churn.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@code/addons/vitest/src/postinstall.ts`:
- Around line 193-205: The getTemplateName function currently calls
configUsesWorkspace(configContent) on the raw file text which misses
exported/aliased test objects and can false-positive; change getTemplateName to
first resolve the exported config AST/value using the same export-resolution
logic used by updateConfigFile (reuse or call that resolver) and pass the
resolved config object or its serialized source to configUsesWorkspace (or a new
helper that inspects the resolved test property) so template selection correctly
detects whether the effective config uses workspace vs projects before returning
'vitest.config.template' vs 'vitest.config.3.2.template' (keep references to
getTemplateName, configUsesWorkspace, and updateConfigFile to locate the code).
In `@code/addons/vitest/src/updateVitestFile.config.4.test.ts`:
- Around line 10-20: Replace the inline mocks in the vi.mock(...) calls by
enabling the spy behavior and moving implementations into beforeEach: use
vi.mock('storybook/internal/node-logger', () => ({ logger: { info: () => {},
warn: () => {}, error: () => {} } }), { spy: true }) and
vi.mock('../../../core/src/shared/utils/module', () => ({ resolvePackageDir: ()
=> undefined }), { spy: true }) in the top-level mock declarations, then in
beforeEach set the real implementations via vi.mocked(...) to access and set the
mock implementations for logger.info/logger.warn/logger.error and
resolvePackageDir (e.g., vi.mocked(logger.info).mockImplementation(...),
vi.mocked(resolvePackageDir).mockImplementation(() => join(__dirname, '..')));
update the sibling tests (updateVitestFile.config.3.2.test.ts,
updateVitestFile.config.test.ts) the same way.
In `@code/addons/vitest/src/updateVitestFile.config.workspace.test.ts`:
- Around line 24-30: The workspace test is parsing the raw template rather than
the preprocessed form used in production; replicate postinstall.ts preprocessing
before calling babel.babelParse by loading the template via
loadTemplate('vitest.workspace.template', ...) then remove the ROOT_CONFIG
placeholder and strip any empty "extends" entry (EXTENDS_WORKSPACE === ''/empty)
the same way postinstall.ts does, and use that processed string as the input to
babel.babelParse (affecting the variable source and the assertions that call
updateWorkspaceFile()); make the same change for the second test block around
the other occurrence (lines 79-85) so snapshots match the real postinstall
input.
---
Nitpick comments:
In `@code/addons/vitest/src/updateVitestFile.config.4.test.ts`:
- Around line 461-538: The test case titled "adds projects property to test
config" is duplicated; remove the duplicate block (the second occurrence in
updateVitestFile.config.4.test.ts) or modify it to cover a different scenario
instead of repeating the exact target and inline snapshot. Locate the duplicated
it(...) block that uses babel.babelParse,
loadTemplate('vitest.config.4.template', ...), updateConfigFile(source, target)
and getDiff(before, after) and either delete that whole it(...) test or change
its inputs/expected snapshot to exercise a distinct behavior (e.g., different
CONFIG_DIR or BROWSER_CONFIG) to avoid runtime and snapshot churn.
In `@code/addons/vitest/src/updateVitestFile.config.test.ts`:
- Around line 22-1774: The test file's describe('updateConfigFile') suite
contains many snapshot-only scenarios duplicated across
updateVitestFile.config.3.2.test.ts and
updateVitestFile.config.workspace.test.ts; remove redundant cases from this file
by keeping only genuinely unique tests (identify each by the it(...) titles and
the top-level describe('updateConfigFile')), or delete this entire file and rely
on the split suites, and ensure the canonical scenarios (e.g., tests that
exercise updateConfigFile directly) remain in the other two files; after
trimming, run the test suite to confirm snapshots are only updated in the
authoritative files.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 6597ddcc-100a-44f7-8ab7-73e3a8f3d29a
📒 Files selected for processing (6)
code/addons/vitest/src/postinstall.tscode/addons/vitest/src/updateVitestFile.config.3.2.test.tscode/addons/vitest/src/updateVitestFile.config.4.test.tscode/addons/vitest/src/updateVitestFile.config.test.tscode/addons/vitest/src/updateVitestFile.config.workspace.test.tscode/addons/vitest/src/updateVitestFile.test.ts
Comment on lines
+193
to
205
| const getTemplateName = (configContent?: string) => { | ||
| if (isVitest4OrNewer) { | ||
| return 'vitest.config.4.template'; | ||
| } else if (isVitest3_2To4) { | ||
| // In Vitest 3.2, `workspace` was deprecated in favor of `projects` but still works. | ||
| // If the user's existing config already uses `workspace`, use the old template that | ||
| // also uses `workspace` so that the merge doesn't introduce both keys. | ||
| if (configContent && configUsesWorkspace(configContent)) { | ||
| return 'vitest.config.template'; | ||
| } | ||
| return 'vitest.config.3.2.template'; | ||
| } | ||
| return 'vitest.config.template'; |
Contributor
There was a problem hiding this comment.
Resolve the exported config before picking the workspace vs. projects template.
configUsesWorkspace() does a file-wide ObjectProperty scan and only recognizes inline test: { workspace: ... }. That misses shapes like const test = { workspace: [...] }; export default defineConfig({ test }), and it can also false-positive on unrelated test.workspace objects elsewhere in the file. In either case getTemplateName(configFile) can choose the wrong template and reintroduce the workspace/projects conflict this change is trying to avoid. Reusing the same export-resolution path that updateConfigFile() uses would make template selection match the config shapes this PR now supports.
Also applies to: 264-264, 451-484
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@code/addons/vitest/src/postinstall.ts` around lines 193 - 205, The
getTemplateName function currently calls configUsesWorkspace(configContent) on
the raw file text which misses exported/aliased test objects and can
false-positive; change getTemplateName to first resolve the exported config
AST/value using the same export-resolution logic used by updateConfigFile (reuse
or call that resolver) and pass the resolved config object or its serialized
source to configUsesWorkspace (or a new helper that inspects the resolved test
property) so template selection correctly detects whether the effective config
uses workspace vs projects before returning 'vitest.config.template' vs
'vitest.config.3.2.template' (keep references to getTemplateName,
configUsesWorkspace, and updateConfigFile to locate the code).
Comment on lines
+10
to
+20
| vi.mock('storybook/internal/node-logger', () => ({ | ||
| logger: { | ||
| info: vi.fn(), | ||
| warn: vi.fn(), | ||
| error: vi.fn(), | ||
| }, | ||
| })); | ||
|
|
||
| vi.mock('../../../core/src/shared/utils/module', () => ({ | ||
| resolvePackageDir: vi.fn().mockImplementation(() => join(__dirname, '..')), | ||
| })); |
Contributor
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
🧩 Analysis chain
🏁 Script executed:
# First, let's check if the file exists and examine lines 10-20
head -30 code/addons/vitest/src/updateVitestFile.config.4.test.ts | cat -nRepository: storybookjs/storybook
Length of output: 1195
🏁 Script executed:
# Also look for sibling test files to check if the pattern is repeated
fd 'updateVitestFile.*\.test\.ts' code/addons/vitest/src/Repository: storybookjs/storybook
Length of output: 348
🏁 Script executed:
# Examine the full structure of the file to understand the mock setup
wc -l code/addons/vitest/src/updateVitestFile.config.4.test.tsRepository: storybookjs/storybook
Length of output: 126
🏁 Script executed:
# Check the mock setup in sibling test files
head -25 code/addons/vitest/src/updateVitestFile.config.3.2.test.ts | cat -nRepository: storybookjs/storybook
Length of output: 1124
🏁 Script executed:
# Check another sibling file
head -25 code/addons/vitest/src/updateVitestFile.config.test.ts | cat -nRepository: storybookjs/storybook
Length of output: 978
🏁 Script executed:
# Check if there's a beforeEach block in the main test file
grep -n "beforeEach" code/addons/vitest/src/updateVitestFile.config.4.test.ts | head -5Repository: storybookjs/storybook
Length of output: 47
🏁 Script executed:
# Search for how mocks are set up in other test files to see the standard pattern
grep -r "vi\.mock.*spy.*true" code/addons/vitest/src/ --include="*.test.ts" | head -3Repository: storybookjs/storybook
Length of output: 47
🏁 Script executed:
# Check if there are any beforeEach blocks with mock setup in other vitest files in the codebase
find code/addons/vitest/src -name "*.test.ts" -exec grep -l "beforeEach" {} \; | head -5Repository: storybookjs/storybook
Length of output: 277
🏁 Script executed:
# Check one of these files to see how beforeEach and mocks are actually used
grep -A 10 "beforeEach" code/addons/vitest/src/node/boot-test-runner.test.ts | head -20Repository: storybookjs/storybook
Length of output: 686
🏁 Script executed:
# Check if spy: true is used in the codebase
grep -r "spy.*true" code/addons/vitest/src/ --include="*.test.ts" | head -5Repository: storybookjs/storybook
Length of output: 47
🏁 Script executed:
# Look at the spy-mocking.mdc file to understand the exact rules
cat .cursor/rules/spy-mocking.mdc 2>/dev/null || cat .cursorrules 2>/dev/null | head -50Repository: storybookjs/storybook
Length of output: 1585
Use the repo-standard Vitest spy mock setup here.
Lines 10–20 use inline vi.fn() and mockImplementation() directly inside vi.mock() calls, and the same pattern is copied into sibling test files (updateVitestFile.config.3.2.test.ts, updateVitestFile.config.test.ts). Per the repository's spy-mocking rules, refactor to use:
spy: trueoption in allvi.mock()calls- Mock behavior implementations moved to
beforeEachblocks vi.mocked()to type and access the mocked functions
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@code/addons/vitest/src/updateVitestFile.config.4.test.ts` around lines 10 -
20, Replace the inline mocks in the vi.mock(...) calls by enabling the spy
behavior and moving implementations into beforeEach: use
vi.mock('storybook/internal/node-logger', () => ({ logger: { info: () => {},
warn: () => {}, error: () => {} } }), { spy: true }) and
vi.mock('../../../core/src/shared/utils/module', () => ({ resolvePackageDir: ()
=> undefined }), { spy: true }) in the top-level mock declarations, then in
beforeEach set the real implementations via vi.mocked(...) to access and set the
mock implementations for logger.info/logger.warn/logger.error and
resolvePackageDir (e.g., vi.mocked(logger.info).mockImplementation(...),
vi.mocked(resolvePackageDir).mockImplementation(() => join(__dirname, '..')));
update the sibling tests (updateVitestFile.config.3.2.test.ts,
updateVitestFile.config.test.ts) the same way.
Comment on lines
+24
to
+30
| const source = babel.babelParse( | ||
| await loadTemplate('vitest.workspace.template', { | ||
| EXTENDS_WORKSPACE: '', | ||
| CONFIG_DIR: '.storybook', | ||
| BROWSER_CONFIG: "{ provider: 'playwright' }", | ||
| SETUP_FILE: '../.storybook/vitest.setup.ts', | ||
| }) |
Contributor
There was a problem hiding this comment.
Make these workspace snapshots match the real postinstall input.
postinstall.ts strips the ROOT_CONFIG placeholder and the empty extends entry before it parses the workspace template, but both tests build source from the raw loadTemplate() result and snapshot that unprocessed shape. The assertions therefore cover a template variant that production never passes to updateWorkspaceFile(). Preprocess the template here the same way before diffing so the snapshots track the shipped flow.
Also applies to: 79-85
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@code/addons/vitest/src/updateVitestFile.config.workspace.test.ts` around
lines 24 - 30, The workspace test is parsing the raw template rather than the
preprocessed form used in production; replicate postinstall.ts preprocessing
before calling babel.babelParse by loading the template via
loadTemplate('vitest.workspace.template', ...) then remove the ROOT_CONFIG
placeholder and strip any empty "extends" entry (EXTENDS_WORKSPACE === ''/empty)
the same way postinstall.ts does, and use that processed string as the input to
babel.babelParse (affecting the variable source and the assertions that call
updateWorkspaceFile()); make the same change for the second test block around
the other occurrence (lines 79-85) so snapshots match the real postinstall
input.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
code/addons/vitest/src/updateVitestFile.ts (1)
103-110:⚠️ Potential issue | 🟠 MajorHandle existing
test.workspacearrays in the mergeConfig path too.This guard still only matches
projects, somergeConfig(viteConfig, { test: { workspace: [...] } })falls through at Line 483 and gets rewrapped as a new project instead of appending to the existing array.Suggested fix
-/** Type guard for a property that is a `projects` key with an ArrayExpression value. */ +/** Type guard for a property that is a `projects` or `workspace` key with an ArrayExpression value. */ const isProjectsArrayProp = ( p: t.ObjectMethod | t.ObjectProperty | t.SpreadElement ): p is t.ObjectProperty => p.type === 'ObjectProperty' && p.key.type === 'Identifier' && - p.key.name === 'projects' && + (p.key.name === 'projects' || p.key.name === 'workspace') && p.value.type === 'ArrayExpression';Also applies to: 482-485
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@code/addons/vitest/src/updateVitestFile.ts` around lines 103 - 110, The type guard isProjectsArrayProp only matches a "projects" key so mergeConfig paths like test.workspace get rewrapped; update the guard (isProjectsArrayProp) to accept either 'projects' or 'workspace' (e.g., p.key.name === 'projects' || p.key.name === 'workspace'), and then apply the same change to the duplicate check used in the mergeConfig path (the other occurrence around the merge logic) so both places will detect and append to existing ArrayExpression values for workspace as well as projects.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@code/addons/vitest/src/updateVitestFile.config.3.2.test.ts`:
- Around line 10-20: The two inline mocks should be converted to spy-style
mocks: call vi.mock('storybook/internal/node-logger', { spy: true }) and
vi.mock('../../../core/src/shared/utils/module', { spy: true }) (keeping the
same module strings), remove inline vi.fn() and mockImplementation usage, and
move behavior setup into a beforeEach where you obtain type-safe mock handles
via vi.mocked(loggerModule) / vi.mocked(moduleUtils) and set
logger.info/warn/error = vi.fn() and
moduleUtils.resolvePackageDir.mockReturnValue(join(__dirname, '..')); ensure all
mock implementations live in beforeEach and use vi.mocked for access.
In `@code/addons/vitest/src/updateVitestFile.config.test.ts`:
- Around line 10-20: Refactor the two vi.mock calls so the factories are passive
and use the { spy: true } option, then move all mock behavior into a beforeEach:
call vi.mock('storybook/internal/node-logger', () => ({ logger: { info: vi.fn(),
warn: vi.fn(), error: vi.fn() }}), { spy: true }) and
vi.mock('../../../core/src/shared/utils/module', () => ({ resolvePackageDir:
vi.fn() }), { spy: true }); in beforeEach set the implementations via
vi.mocked(logger).info.mockImplementation(...)/warn/error and
vi.mocked(resolvePackageDir).mockImplementation(() => join(__dirname, '..')) so
tests use vi.mocked(...) for type-safe access to logger.info/warn/error and
resolvePackageDir instead of inline factories.
---
Duplicate comments:
In `@code/addons/vitest/src/updateVitestFile.ts`:
- Around line 103-110: The type guard isProjectsArrayProp only matches a
"projects" key so mergeConfig paths like test.workspace get rewrapped; update
the guard (isProjectsArrayProp) to accept either 'projects' or 'workspace'
(e.g., p.key.name === 'projects' || p.key.name === 'workspace'), and then apply
the same change to the duplicate check used in the mergeConfig path (the other
occurrence around the merge logic) so both places will detect and append to
existing ArrayExpression values for workspace as well as projects.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 5e90512a-f0ec-450f-95d9-078b04bd4888
📒 Files selected for processing (4)
code/addons/vitest/src/updateVitestFile.config.3.2.test.tscode/addons/vitest/src/updateVitestFile.config.4.test.tscode/addons/vitest/src/updateVitestFile.config.test.tscode/addons/vitest/src/updateVitestFile.ts
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@code/addons/vitest/src/updateVitestFile.config.4.test.ts`:
- Around line 461-538: The test named "adds projects property to test config" is
duplicated; locate the second occurrence of the it(...) block that uses
babel.babelParse, updateConfigFile, getDiff and either delete this duplicate
test or rename its description to a unique, descriptive string (and adjust
expectations if the intent differs) so both tests have distinct names and
purposes; ensure any imports or helper usage (babel.babelParse,
updateConfigFile, getDiff) remain correct after removing/renaming.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 33b280b0-f25f-4b31-93df-04123642e033
📒 Files selected for processing (5)
code/addons/vitest/src/updateVitestFile.config.4.test.tscode/addons/vitest/src/updateVitestFile.config.test.tscode/addons/vitest/src/updateVitestFile.tscode/core/src/babel/expression-resolver.test.tscode/core/src/babel/expression-resolver.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- code/core/src/babel/expression-resolver.ts
Comment on lines
+461
to
+538
| it('adds projects property to test config', async () => { | ||
| const source = babel.babelParse( | ||
| await loadTemplate('vitest.config.4.template', { | ||
| CONFIG_DIR: '.storybook', | ||
| BROWSER_CONFIG: "{ provider: 'playwright' }", | ||
| SETUP_FILE: '../.storybook/vitest.setup.ts', | ||
| }) | ||
| ); | ||
| const target = babel.babelParse(` | ||
| /// <reference types="vitest/config" /> | ||
| import { defineConfig } from 'vite' | ||
| import react from '@vitejs/plugin-react' | ||
|
|
||
| // https://vite.dev/config/ | ||
| export default defineConfig({ | ||
| plugins: [react()], | ||
| test: { | ||
| globals: true, | ||
| }, | ||
| }) | ||
| `); | ||
|
|
||
| const before = babel.generate(target).code; | ||
| const updated = updateConfigFile(source, target); | ||
| expect(updated).toBe(true); | ||
|
|
||
| const after = babel.generate(target).code; | ||
|
|
||
| // check if the code was updated at all | ||
| expect(after).not.toBe(before); | ||
|
|
||
| // check if the code was updated correctly | ||
| expect(getDiff(before, after)).toMatchInlineSnapshot(` | ||
| " ... | ||
| import react from '@vitejs/plugin-react'; | ||
|
|
||
| // https://vite.dev/config/ | ||
|
|
||
| + import path from 'node:path'; | ||
| + import { fileURLToPath } from 'node:url'; | ||
| + import { storybookTest } from '@storybook/addon-vitest/vitest-plugin'; | ||
| + import { playwright } from '@vitest/browser-playwright'; | ||
| + const dirname = typeof __dirname !== 'undefined' ? __dirname : path.dirname(fileURLToPath(import.meta.url)); | ||
| + | ||
| + // More info at: https://storybook.js.org/docs/next/writing-tests/integrations/vitest-addon | ||
| + | ||
| export default defineConfig({ | ||
| plugins: [react()], | ||
| test: { | ||
|
|
||
| - globals: true | ||
| - | ||
| + globals: true, | ||
| + projects: [{ | ||
| + extends: true, | ||
| + plugins: [ | ||
| + // The plugin will run tests for the stories defined in your Storybook config | ||
| + // See options at: https://storybook.js.org/docs/next/writing-tests/integrations/vitest-addon#storybooktest | ||
| + storybookTest({ | ||
| + configDir: path.join(dirname, '.storybook') | ||
| + })], | ||
| + test: { | ||
| + name: 'storybook', | ||
| + browser: { | ||
| + enabled: true, | ||
| + headless: true, | ||
| + provider: playwright({}), | ||
| + instances: [{ | ||
| + browser: 'chromium' | ||
| + }] | ||
| + } | ||
| + } | ||
| + }] | ||
| + | ||
| } | ||
| });" | ||
| `); | ||
| }); |
Contributor
There was a problem hiding this comment.
Duplicate test case name.
This test (lines 461-538) has the same name as the test at lines 217-294: "adds projects property to test config". Both tests appear to exercise the same scenario. Consider removing the duplicate or renaming one to clarify the different intent.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@code/addons/vitest/src/updateVitestFile.config.4.test.ts` around lines 461 -
538, The test named "adds projects property to test config" is duplicated;
locate the second occurrence of the it(...) block that uses babel.babelParse,
updateConfigFile, getDiff and either delete this duplicate test or rename its
description to a unique, descriptive string (and adjust expectations if the
intent differs) so both tests have distinct names and purposes; ensure any
imports or helper usage (babel.babelParse, updateConfigFile, getDiff) remain
correct after removing/renaming.
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 185 | 185 | 0 |
| Self size | 76 KB | 76 KB | 🎉 -48 B 🎉 |
| Dependency size | 32.18 MB | 32.19 MB | 🚨 +12 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/angular
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 185 | 185 | 0 |
| Self size | 140 KB | 140 KB | 0 B |
| Dependency size | 30.39 MB | 30.40 MB | 🚨 +12 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/ember
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 189 | 189 | 0 |
| Self size | 15 KB | 15 KB | 🚨 +18 B 🚨 |
| Dependency size | 28.89 MB | 28.90 MB | 🚨 +12 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/nextjs
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 534 | 534 | 0 |
| Self size | 650 KB | 650 KB | 0 B |
| Dependency size | 59.89 MB | 59.91 MB | 🚨 +12 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/nextjs-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 92 | 92 | 0 |
| Self size | 1.12 MB | 1.12 MB | 0 B |
| Dependency size | 22.45 MB | 22.47 MB | 🚨 +12 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/react-native-web-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 124 | 124 | 0 |
| Self size | 30 KB | 30 KB | 0 B |
| Dependency size | 23.74 MB | 23.75 MB | 🚨 +12 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/react-vite
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 82 | 82 | 0 |
| Self size | 35 KB | 35 KB | 🚨 +18 B 🚨 |
| Dependency size | 20.24 MB | 20.25 MB | 🚨 +12 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/react-webpack5
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 271 | 271 | 0 |
| Self size | 24 KB | 24 KB | 0 B |
| Dependency size | 44.52 MB | 44.53 MB | 🚨 +12 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/server-webpack5
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 197 | 197 | 0 |
| Self size | 16 KB | 16 KB | 0 B |
| Dependency size | 33.44 MB | 33.45 MB | 🚨 +12 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/cli
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 183 | 183 | 0 |
| Self size | 779 KB | 779 KB | 0 B |
| Dependency size | 67.35 MB | 67.37 MB | 🚨 +18 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/codemod
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 176 | 176 | 0 |
| Self size | 32 KB | 32 KB | 🎉 -36 B 🎉 |
| Dependency size | 65.88 MB | 65.89 MB | 🚨 +16 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/preset-react-webpack
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 167 | 167 | 0 |
| Self size | 18 KB | 18 KB | 🎉 -24 B 🎉 |
| Dependency size | 31.39 MB | 31.40 MB | 🚨 +12 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
@storybook/react
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 58 | 58 | 0 |
| Self size | 1.19 MB | 1.19 MB | 🚨 +6 B 🚨 |
| Dependency size | 13.19 MB | 13.20 MB | 🚨 +12 KB 🚨 |
| Bundle Size Analyzer | Link | Link |
yannbf
reviewed
Mar 12, 2026
| } | ||
|
|
||
| // Properties that should stay at the top-level test object (shared across all projects) | ||
| const TOP_LEVEL_TEST_PROPERTIES = [ |
Member
There was a problem hiding this comment.
Should we add a comment to revisit this often? Or a way to remind us that Vitest might introduce new properties and we should add them
Contributor
There was a problem hiding this comment.
The reminder would need to be set in a different way somehow. A comment in this file will be overlooked.
Contributor
There was a problem hiding this comment.
I'll experiment with TypeScript types from vitest and see how it goes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
defineConfig(mergeConfig(...))pattern (defineConfig wrapping mergeConfig)mergeConfig(...) as ViteUserConfigpattern (TSAsExpression wrapping)defineConfig(mergeConfig(...) satisfies ViteUserConfig)pattern (TSSatisfiesExpression)export default configwhereconfig = mergeConfig(...)(variable re-export)mergeConfig(viteConfig, vitestConfig)where vitestConfig is a variabledefineProject({...})pattern (alias for defineConfig)const test = {...}; mergeConfig(viteConfig, { test })pattern (shorthand property)View original Slack conversation
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.
Summary by CodeRabbit
New Tests
Bug Fixes
Refactor
Behavior