fix(snapshot): preserve white space of toMatchFileSnapshot (#7156)

vitest-dev · Jan 3, 2025 · a437b65 · a437b65
1 parent c98b4b1
commit a437b65
Show file tree

Hide file tree

Showing 8 changed files with 84 additions and 6 deletions.
diff --git a/packages/snapshot/src/client.ts b/packages/snapshot/src/client.ts
@@ -164,8 +164,8 @@ export class SnapshotClient {
       throw createMismatchError(
         `Snapshot \`${key || 'unknown'}\` mismatched`,
         snapshotState.expand,
-        actual?.trim(),
-        expected?.trim(),
+        rawSnapshot ? actual : actual?.trim(),
+        rawSnapshot ? expected : expected?.trim(),
       )
     }
   }

diff --git a/packages/snapshot/src/port/state.ts b/packages/snapshot/src/port/state.ts
@@ -290,8 +290,8 @@ export default class SnapshotState {
       : rawSnapshot
         ? rawSnapshot.content
         : this._snapshotData[key]
-    const expectedTrimmed = prepareExpected(expected)
-    const pass = expectedTrimmed === prepareExpected(receivedSerialized)
+    const expectedTrimmed = rawSnapshot ? expected : prepareExpected(expected)
+    const pass = expectedTrimmed === (rawSnapshot ? receivedSerialized : prepareExpected(receivedSerialized))
     const hasSnapshot = expected !== undefined
     const snapshotIsPersisted
       = isInline
@@ -390,11 +390,11 @@ export default class SnapshotState {
       if (!pass) {
         this.unmatched.increment(testId)
         return {
-          actual: removeExtraLineBreaks(receivedSerialized),
+          actual: rawSnapshot ? receivedSerialized : removeExtraLineBreaks(receivedSerialized),
           count,
           expected:
             expectedTrimmed !== undefined
-              ? removeExtraLineBreaks(expectedTrimmed)
+              ? rawSnapshot ? expectedTrimmed : removeExtraLineBreaks(expectedTrimmed)
               : undefined,
           key,
           pass: false,

diff --git a/test/core/test/snapshot-1.txt b/test/core/test/snapshot-1.txt
@@ -0,0 +1,2 @@
+
+  white space
diff --git a/test/core/test/snapshot-2.txt b/test/core/test/snapshot-2.txt
@@ -0,0 +1,10 @@
+example: |
+  {
+    echo "hello"
+  }
+some:
+  nesting:
+    - "hello world"
+even:
+  more:
+    nesting: true
diff --git a/test/snapshots/test/file.test.ts b/test/snapshots/test/file.test.ts
@@ -0,0 +1,28 @@
+import { join } from 'node:path'
+import { expect, test } from 'vitest'
+import { editFile, runVitest } from '../../test-utils'
+
+test('white space sensitive', async () => {
+  const root = join(import.meta.dirname, 'fixtures/file')
+
+  // check correct snapshot
+  let vitest = await runVitest({ root })
+  expect(vitest.exitCode).toBe(0)
+
+  // check diff of wrong snapshot
+  editFile(join(root, 'snapshot-1.txt'), s => s.trim())
+  editFile(join(root, 'snapshot-2.txt'), s => s.replace('echo', 'ECHO'))
+  vitest = await runVitest({ root })
+  expect(vitest.stderr).toContain(`
+- white space
++
++
++   white space
++
+`)
+  expect(vitest.stderr).toContain(`
+-     ECHO "hello"
++     echo "hello"
+`)
+  expect(vitest.exitCode).toBe(1)
+})
diff --git a/test/snapshots/test/fixtures/file/basic.test.ts b/test/snapshots/test/fixtures/file/basic.test.ts
@@ -0,0 +1,25 @@
+import { test, expect } from "vitest"
+
+// pnpm -C test/snapshots test:fixtures --root test/fixtures/file
+
+test('white space', async () => {
+  await expect(`
+
+  white space
+`).toMatchFileSnapshot('snapshot-1.txt')
+})
+
+test('indent', async () => {
+  await expect(`\
+example: |
+  {
+    echo "hello"
+  }
+some:
+  nesting:
+    - "hello world"
+even:
+  more:
+    nesting: true
+`).toMatchFileSnapshot('snapshot-2.txt')
+})
diff --git a/test/snapshots/test/fixtures/file/snapshot-1.txt b/test/snapshots/test/fixtures/file/snapshot-1.txt
@@ -0,0 +1,3 @@
+
+
+  white space
diff --git a/test/snapshots/test/fixtures/file/snapshot-2.txt b/test/snapshots/test/fixtures/file/snapshot-2.txt
@@ -0,0 +1,10 @@
+example: |
+  {
+    echo "hello"
+  }
+some:
+  nesting:
+    - "hello world"
+even:
+  more:
+    nesting: true