npmpackage.info

snappify

A generator of Jest snapshot-based tests for React components written with TypeScript 📸

1.1.0

MIT

JavaScript

3.68 kB

7,347 1.7

Installations

npm install snappify

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

16.16.0

NPM Version

8.11.0 Score

71.8

Supply Chain

99.4

Quality

75.7

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

3

Total

4

Closed

0

Merged

1

Issues

Open

3

Total

3

Closed

0

Releases

v1.1.0

Updated on Jul 23, 2022

View All 1 releases

Contributors

Unable to fetch Contributors

View All 2 Contributors

Languages

JavaScript

JavaScript (100%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

denisraslov

Download Statistics

Total Downloads

7,347

Last Day

Last Week

Last Month

Last Year

342

GitHub Statistics

MIT License

70 Stars

103 Commits

10 Forks

7 Watchers

1 Branches

2 Contributors

Updated on Jul 06, 2024

Bundle Size

9.41 kB

Minified

3.68 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.1.0

Package Id

snappify@1.1.0

Unpacked Size

22.36 kB

Size

7.37 kB

File Count

NPM Version

8.11.0

Node Version

16.16.0

Total Downloads

Cumulative downloads

Total Downloads

7,347

Last Day

Compared to previous day

Last Week

-58.3%

Compared to previous week

Last Month

135.7%

Compared to previous month

Last Year

-20.5%

342

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

minimist

Dev Dependencies

babel-preset-env eslint-config-standard husky jest lint-staged prettier

Snappify

A generator of Jest snapshot-based tests for React components written with TypeScript

Why

Snapshot testing of React components is a useful tool that Jest provides to make sure your UI does not change unexpectedly. To apply it you have to describe several different states of a component configuring it with different props that this component can have.

However, if you write components with TypeScript, you have an interface describing the types of the props. There is no reason to fill props up manually with random values in your tests. It could be done automatically based on the described types. That is what Snappify does.

Snappify generates files with tests for your React components. You just run them. ✨

A related blog post

Introducing Snappify 📸: A generator of snapshot tests for React + TypeScript

Quick Overview

Install Snappify globally:

1npm install -g snappify

Run Snappify inside of a project folder with a configured glob pattern of the React components files and a name of a root folder for generated tests:

1snappify components/**/*.tsx --testsRoot=tests

It will create a directory called tests inside the current folder.

Inside that directory, it will generate the files with snapshot-based tests for every of the components from the files that matched to components/**/*.tsx pattern.

Folders structure

The structure of the included folders with tests will be the same as the structure of the folders with components. The names of the files with tests will be the same as the names of the files with the components.

For example, if you have this structure of folders:

my-app
├── components
│   └── Header.tsx
│   └── Content.tsx
│   └── Footer.tsx
│   └── Button
│       └── index.tsx

You will get this structure of the folders with the tests (when you run the command above):

my-app
├── tests
│   └── Header.js
│   └── Content.js
│   └── Footer.js
│   └── Button
│       └── index.js

How it works

Snappify takes a component and its interface, and generates a file with snapshot-based tests with up to 10 test cases each.

The props values for test cases be generated with uniformly distributed sets of random values based on the types of the props. That means you get the count of test cases that you can take control of, but they are still cover the details of your components as wide as it possible in this situation.

An example

Here we have the Button component that have the declared interface for its props called IButtonProps.

1import * as React from 'react';
2
3interface IButtonProps {
4    children: React.ReactNode;
5    className?: string;
6    isDisabled?: boolean;
7    onClick?: () => void;
8}
9
10const Button: React.StatelessComponent<IButtonProps> = (props) => {
11    const { className, isDisabled, onClick } = props;
12
13    return (
14        <div className={className} onClick={!isDisabled && onClick}>
15            {props.children}
16        </div>
17    );
18};
19
20export default Button;

Snappify will generate a file with tests for this component that will looks like:

1import React from 'react';
2import renderer from 'react-test-renderer';
3
4import Button from 'components/Button.tsx';
5
6test('Button case #1', () => {
7    const tree = renderer.create(
8        <Button
9            // some randomly generated values for props
10            className={'value'}
11            isDisabled={true}
12            onClick={() => undefined}
13            children={<div />}
14        />
15    ).toJSON();
16
17    expect(tree).toMatchSnapshot();
18});
19
20test('Button case #2', () => {
21    const tree = renderer.create(
22        <Button
23            // another set of randomly generated values for props
24            // (the not required props were skipped)
25            children={<div />}
26        />
27    ).toJSON();
28
29    expect(tree).toMatchSnapshot();
30});
31
32// Other test cases go here...

Supported TypeScript types

Right now Snappify supports the basic types of TypeScript. It also supports a few of the React types: React.ReactNode, JSX.Element and React.CSSProperties.

It doesn't support using other declared TypeScript interfaces as types of items of a React component's interface yet.

I condiser increase of the supported types as a future improvement.

Supported TypeScript syntax

Right now Snappify supports only the semicolon (;) as a delimiter between interface items. See example:

1interface IButtonProps {
2    children: React.ReactNode;
3    className?: string;
4}

It also supports only React components declared with one of the following statements:

1class Button extends React.Component<IButtonProps, IButtonState> {}

1class Button extends React.PureComponent<IButtonProps, IButtonState> {}

1const Button:React.StatelessComponent<IButtonProps> = (props) => {}

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

73 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-8w4h-3cm3-2pm2
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to snappify

@snappify/integration

1.0.1

@snappify/next-markdown

1.8.1

Static pages generated from markdown files for your Next.js website.

@snappify/html-to-image

1.9.10

Generates an image from a DOM node using HTML5 canvas and SVG.

@snappify/modern-screenshot

0.0.1

Quickly generate image from DOM node using HTML5 canvas and SVG