npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@btravers/pdf-snapshot-jest

v0.0.15

Published

Jest extension

Downloads

422

Readme

PDF Snapshot

GitHub Workflow Status (branch) npm Docker Image Version (latest semver) GitHub

Jest matcher for visual regression testing of PDF documents. Behaves just like Jest snapshots do.

Under the hood, it uses pdf.js for conversion of a pdf to png. In node, pdf.js depends on canvas. Finally, the comparison is happening via pixelmatch.

In order to be platform agnostic, the png conversion and png comparison is performed by a small server running aside, available as a Docker image and communicating with Jest matcher using tRCP.

Usage

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed the latest version of Docker.

Installation

First pull the Docker image of the main service.

docker pull btravers/pdf-snapshot

Then install Jest matcher in the dev dependencies of your project.

npm install --save-dev @btravers/pdf-snapshot-jest

Please note that Jest 28 is a peerDependency.

Declare toMatchPdfSnapshot matcher in your Jest configuration.

"jest": {
  "setupFilesAfterEnv": [
    "@btravers/pdf-snapshot-jest/dist/toMatchPdfSnapshot"
  ]
}

If you are using Typescript add import('@btravers/pdf-snapshot-jest/dist/toMatchPdfSnapshot'); to your typings.

Invocation

Start the container with the main service.

docker run -d -p 3000:3000 btravers/pdf-snapshot

In your test, export PDF_SNAPSHOT_SERVER_URL environment variable in order to link Jest matcher with the service running in the container.

process.env.PDF_SNAPSHOT_SERVER_URL = 'http://localhost:3000'

Now, all you have to do in your tests is pass a pdf content as Buffer.

const pdfBuffer = await fs.promise.readFile('path to your pdf');
describe('test pdf report visual regression', () => {
  it('should match', () => expect(pdfBuffer).toMatchPdfSnapshot());
});

Go further

You can rely on testcontainers-node and automate the container start before tests run.

Credits