Visitar URL original
feat: accept `new` or `all` in `--update` flag (#9543) · vitest-dev/vitest@a5acf28 · GitHub
Skip to content

Commit a5acf28

Browse files
sheremet-vasheremet-va
authored
feat: accept new or all in --update flag (#9543)
1 parent c8a3114 commit a5acf28

7 files changed

Lines changed: 48 additions & 50 deletions

File tree

‎docs/config/update.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@ outline: deep
55

66
# update <CRoot /> {#update}
77

8-
- **Type:** `boolean`
8+
- **Type:** `boolean | 'new' | 'all'`
99
- **Default:** `false`
10-
- **CLI:** `-u`, `--update`, `--update=false`
10+
- **CLI:** `-u`, `--update`, `--update=false`, `--update=new`
1111

12-
Update snapshot files. This will update all changed snapshots and delete obsolete ones.
12+
Update snapshot files. The behaviour depends on the value:
13+
14+
- `true` or `'all'`: updates all changed snapshots and delete obsolete ones
15+
- `new`: generates new snapshots without changing or deleting obsolete ones

‎docs/guide/cli-generated.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Path to config file
1313

1414
### update
1515

16-
- **CLI:** `-u, --update`
16+
- **CLI:** `-u, --update [type]`
1717
- **Config:** [update](/config/update)
1818

19-
Update snapshot
19+
Update snapshot (accepts boolean, "new" or "all")
2020

2121
### watch
2222

‎packages/vitest/src/node/cli/cli-config.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ export const cliOptionsConfig: VitestCLIOptions = {
7878
},
7979
update: {
8080
shorthand: 'u',
81-
description: 'Update snapshot',
81+
description: 'Update snapshot (accepts boolean, "new" or "all")',
82+
argument: '[type]',
8283
},
8384
watch: {
8485
shorthand: 'w',

‎packages/vitest/src/node/config/resolveConfig.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,9 @@ export function resolveConfig(
508508
expand: resolved.expandSnapshotDiff ?? false,
509509
snapshotFormat: resolved.snapshotFormat || {},
510510
updateSnapshot:
511-
isCI && !UPDATE_SNAPSHOT ? 'none' : UPDATE_SNAPSHOT ? 'all' : 'new',
511+
UPDATE_SNAPSHOT === 'all' || UPDATE_SNAPSHOT === 'new'
512+
? UPDATE_SNAPSHOT
513+
: isCI && !UPDATE_SNAPSHOT ? 'none' : UPDATE_SNAPSHOT ? 'all' : 'new',
512514
resolveSnapshotPath: options.resolveSnapshotPath,
513515
// resolved inside the worker
514516
snapshotEnvironment: null as any,

‎packages/vitest/src/node/types/config.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ export interface InlineConfig {
365365
*
366366
* @default false
367367
*/
368-
update?: boolean
368+
update?: boolean | 'all' | 'new'
369369

370370
/**
371371
* Watch mode

‎test/browser/fixtures/user-event/wheel.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ describe.for([
2525

2626
await (testType === 'userEvent' ? userEvent.wheel(selector, options) : selector.wheel(options))
2727

28-
expect(wheel).toHaveBeenCalledOnce()
28+
await expect.poll(() => wheel).toHaveBeenCalledOnce()
2929
expect(wheel.mock.calls[0][0].deltaX).toBe(deltaX)
3030
expect(wheel.mock.calls[0][0].deltaY).toBe(deltaY)
3131
})

‎test/browser/specs/to-match-screenshot.test.ts‎

Lines changed: 33 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import type { ViteUserConfig } from 'vitest/config'
22
import type { TestFsStructure } from '../../test-utils'
33
import { platform } from 'node:os'
4-
import { resolve } from 'node:path'
54
import { describe, expect, test } from 'vitest'
6-
import { runVitestCli, useFS } from '../../test-utils'
5+
import { runInlineTests } from '../../test-utils'
76
import { extractToMatchScreenshotPaths } from '../fixtures/expect-dom/utils'
87
import utilsContent from '../fixtures/expect-dom/utils?raw'
8+
import { provider } from '../settings'
99

1010
const testFilename = 'basic.test.ts'
1111
const testName = 'screenshot-snapshot'
@@ -27,57 +27,46 @@ test('${testName}', async ({ expect }) => {
2727

2828
const browser = 'chromium'
2929

30-
async function runInlineTests(
30+
async function runBrowserTests(
3131
structure: TestFsStructure,
3232
config: ViteUserConfig['test'] = {},
3333
) {
34-
const root = resolve(process.cwd(), `vitest-test-${crypto.randomUUID()}`)
35-
36-
const fs = useFS(root, {
34+
return runInlineTests({
3735
...structure,
38-
'vitest.config.ts': `
39-
import { playwright } from '@vitest/browser-playwright'
40-
export default {
41-
test: {
42-
browser: {
43-
enabled: true,
44-
screenshotFailures: false,
45-
provider: playwright(),
46-
headless: true,
47-
instances: [{ browser: ${JSON.stringify(browser)} }],
36+
'vitest.config.js': `
37+
import { playwright } from '@vitest/browser-playwright'
38+
export default {
39+
test: {
40+
browser: {
41+
enabled: true,
42+
screenshotFailures: false,
43+
provider: playwright(),
44+
headless: true,
45+
instances: [{ browser: ${JSON.stringify(browser)} }],
46+
},
47+
reporters: ['verbose'],
48+
...${JSON.stringify(config)},
4849
},
49-
reporters: ['verbose'],
50-
...${JSON.stringify(config)},
51-
},
52-
}`,
53-
})
54-
55-
const vitest = await runVitestCli({
56-
nodeOptions: {
57-
env: {
58-
CI: 'false',
59-
GITHUB_ACTIONS: undefined,
60-
NO_COLOR: 'true',
61-
},
50+
}`,
51+
}, {
52+
$cliOptions: {
53+
watch: true,
6254
},
63-
}, '--root', root, '--watch')
64-
65-
return {
66-
fs,
67-
root,
68-
...vitest,
69-
}
55+
})
7056
}
7157

72-
describe('--watch', () => {
58+
describe.runIf(provider.name === 'playwright')('--watch', () => {
7359
test(
7460
'fails when creating a snapshot for the first time and does NOT update it afterwards',
7561
async () => {
76-
const { fs, stderr, vitest } = await runInlineTests(
62+
const { fs, stderr, vitest } = await runBrowserTests(
7763
{
7864
[testFilename]: testContent,
7965
'utils.ts': utilsContent,
8066
},
67+
{
68+
update: 'new',
69+
},
8170
)
8271

8372
const [referencePath] = extractToMatchScreenshotPaths(stderr, testName)
@@ -102,11 +91,14 @@ describe('--watch', () => {
10291
test(
10392
'creates a reference and fails when changing the DOM content',
10493
async () => {
105-
const { fs, stderr, vitest } = await runInlineTests(
94+
const { fs, stderr, vitest } = await runBrowserTests(
10695
{
10796
[testFilename]: testContent,
10897
'utils.ts': utilsContent,
10998
},
99+
{
100+
update: 'new',
101+
},
110102
)
111103

112104
expect(stderr).toContain(`No existing reference screenshot found; a new one was created. Review it before running tests again.\n\nReference screenshot:`)
@@ -126,7 +118,7 @@ describe('--watch', () => {
126118
test(
127119
'creates snapshot and does NOT update it if reference matches',
128120
async () => {
129-
const { fs, stderr, vitest } = await runInlineTests(
121+
const { fs, stderr, vitest } = await runBrowserTests(
130122
{
131123
[testFilename]: testContent,
132124
'utils.ts': utilsContent,
@@ -174,7 +166,7 @@ describe('--watch', () => {
174166
test(
175167
'creates snapshot and updates it if reference mismatches',
176168
async () => {
177-
const { fs, stderr, vitest } = await runInlineTests(
169+
const { fs, stderr, vitest } = await runBrowserTests(
178170
{
179171
[testFilename]: testContent,
180172
'utils.ts': utilsContent,

0 commit comments

Comments
 (0)