README_en.md

jest-image-snapshot-sample

Overview

• This is a sample code of jest-image-snapshot.

System Requirements

• Node.js - 14.x
• Yarn - 1.22.x

Library

• TypeScript - 4.5.x
• Jest - 27.5.x
• ts-jest - 27.1.x
• jest-image-snapshot - 4.5.x
• @types/jest-image-snapshot - 4.3.x

Usage

# Node.js package installation 
yarn

# Test run 
yarn test

Execution result

yarn run v1.22.11
warning package.json: No license field
$ jest
 FAIL  test/sample.test.ts
  image test
    ✓ test1.png ok (120 ms)
    ✕ test2.png ng (126 ms)

  ● image test › test2.png ng

    Expected image to match or be a close match to snapshot but was 1.6022815659839251% different from snapshot (309 differing pixels).
    See diff for details: jest-image-snapshot-sample/test/__image_snapshots__/__diff_output__/sample-test-ts-image-test-test-2-png-ng-1-diff.png

      12 |     const imagePath = path.join(process.cwd(), 'test/test2.png');
      13 |     const file = fs.readFileSync(imagePath);
    > 14 |     expect(file).toMatchImageSnapshot();
         |                  ^
      15 |   });
      16 | });
      17 |

      at Object.<anonymous> (test/sample.test.ts:14:18)

 › 1 snapshot failed.
Snapshot Summary
 › 1 snapshot failed from 1 test suite. Inspect your code changes or run `yarn test -u` to update them.

Test Suites: 1 failed, 1 total
Tests:       1 failed, 1 passed, 2 total
Snapshots:   1 failed, 1 passed, 2 total
Time:        1.991 s
Ran all test suites.
error Command failed with exit code 1.

DIFF image