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

@dabapps/jest-matcher-react-shallow-snapshot

v2.0.0

Published

A jest matcher for shallow rendered React component snapshots

Downloads

121

Readme

jest-matcher-react-shallow-snapshot

A jest matcher for shallow rendered React component snapshots

About

This is a fork of @jakesidsmith/jest-matcher-react-shallow-snapshot.

This is a jest matcher that allows you to easily create shallow snapshots of React components will full support for:

  • React.memo
  • React.forwardRef
  • React.Fragment
  • React.createContext (Provider and Consumer)
  • ReactDOM.createPortal
  • Functional components
  • Component classes

The output of this matcher is far more informative than other existing solutions, providing context of memo wrapped components, fragments, etc, and does not require importing a renderer for each of your test files.

This relies on react-shallow-renderer under the hood, which you could use without the jest matcher if you prefer / are using another test suite.

Check out the react-shallow-renderer readme for some examples of the snapshot output.

Example

expect(<MyComponent />).toMatchReactShallowSnapshot();

Install

Install as a dev dependency (-D is short for --save-dev)

npm i @dabapps/jest-matcher-react-shallow-snapshot -D

Configuration

Jest config

This library requires you to define a setupFilesAfterEnv entry in your jest config (or setupTestFrameworkScriptFile for older versions of jest).

This should point to a file which will be used to initialize custom matchers:

module.exports = {
  setupFilesAfterEnv: [
    '<rootDir>/path/to/custom-matchers.js'
  ]
};

If you don't already have a such a file you should create one, and then simply import this library in that file:

import '@dabapps/jest-matcher-react-shallow-snapshot';

If you are using TypeScript, importing this file from your setup file should apply the types needed to call .toMatchReactShallowSnapshot. If it doesn't, then make sure that the setup file is included in your tsconfig.

Usage

Now you can simply render a react component and expect it to match your shallow snapshot:

expect(<MyComponent />).toMatchReactShallowSnapshot();

Updating this fork from upstream

Ensure you have added a remote upstream in git e.g.

git remote add upstream [email protected]:JakeSidSmith/jest-matcher-react-shallow-snapshot.git

Create a new branch (from master) and run the following to pull changes from upstream:

git fetch upstream
git pull upstream master