americanexpress / jest-image-snapshot

✨ Jest matcher for image comparisons. Most commonly used for visual regression testing.
Apache License 2.0
3.83k stars 198 forks source link

chore(dist): remove images from install bundle #307

Closed 10xLaCroixDrinker closed 2 years ago

10xLaCroixDrinker commented 2 years ago

Description

fixes #294

Motivation and Context

smaller bundle => faster install => better DX

How Has This Been Tested?

Before:

$ npm pack
npm notice
npm notice 📦  jest-image-snapshot@5.1.0
npm notice === Tarball Contents ===
npm notice 148B    .editorconfig
npm notice 24B     .eslintrc.json
npm notice 7B      .gitattributes
npm notice 42B     .github/labeler.yml
npm notice 1.7kB   .github/pull_request_template.md
npm notice 679B    .github/workflows/health-check.yml
npm notice 234B    .github/workflows/pr-labeler.yml
npm notice 1.0kB   .github/workflows/release.yml
npm notice 702B    .github/workflows/stale.yml
npm notice 909B    .github/workflows/tests.yml
npm notice 6.7kB   CHANGELOG.md
npm notice 8.5kB   CODE_OF_CONDUCT.md
npm notice 79B     CODEOWNERS
npm notice 3.7kB   CONTRIBUTING.md
npm notice 10.3kB  LICENSE.txt
npm notice 16.5kB  README.md
npm notice 792B    commitlint.config.js
npm notice 949.2kB images/create-snapshot.gif
npm notice 1.7MB   images/fail-snapshot.gif
npm notice 316.6kB images/image-diff.png
npm notice 52.4kB  jest-image-snapshot.png
npm notice 2.7kB   package.json
npm notice 1.2kB   src/diff-process.js
npm notice 12.6kB  src/diff-snapshot.js
npm notice 2.0kB   src/image-composer.js
npm notice 9.3kB   src/index.js
npm notice 2.8kB   src/outdated-snapshot-reporter.js
npm notice === Tarball Details ===
npm notice name:          jest-image-snapshot
npm notice version:       5.1.0
npm notice filename:      jest-image-snapshot-5.1.0.tgz
npm notice package size:  2.8 MB
npm notice unpacked size: 3.1 MB
npm notice shasum:        857ef3cc50aa4e68c0ab05b4e71feea4709cc787
npm notice integrity:     sha512-ajrkvObIpZg5B[...]7QudsixvLDFAw==
npm notice total files:   27
npm notice
jest-image-snapshot-5.1.0.tgz

After:

$ npm pack
npm notice
npm notice 📦  jest-image-snapshot@5.1.0
npm notice === Tarball Contents ===
npm notice 148B   .editorconfig
npm notice 24B    .eslintrc.json
npm notice 7B     .gitattributes
npm notice 6.7kB  CHANGELOG.md
npm notice 8.5kB  CODE_OF_CONDUCT.md
npm notice 79B    CODEOWNERS
npm notice 3.7kB  CONTRIBUTING.md
npm notice 10.3kB LICENSE.txt
npm notice 16.7kB README.md
npm notice 792B   commitlint.config.js
npm notice 2.7kB  package.json
npm notice 1.2kB  src/diff-process.js
npm notice 12.6kB src/diff-snapshot.js
npm notice 2.0kB  src/image-composer.js
npm notice 9.3kB  src/index.js
npm notice 2.8kB  src/outdated-snapshot-reporter.js
npm notice === Tarball Details ===
npm notice name:          jest-image-snapshot
npm notice version:       5.1.0
npm notice filename:      jest-image-snapshot-5.1.0.tgz
npm notice package size:  25.5 kB
npm notice unpacked size: 77.5 kB
npm notice shasum:        5a921efe42b66c740e05a81dac02d130e716c964
npm notice integrity:     sha512-oVidbCRLDGbQP[...]G8s6Ataqwab8A==
npm notice total files:   16
npm notice
jest-image-snapshot-5.1.0.tgz

Types of Changes

Checklist:

What is the Impact to Developers Using Jest-Image-Snapshot?

Faster, lighter installs

oneamexbot commented 2 years ago

:tada: This PR is included in version 5.1.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket: