facebook/jest


Delightful JavaScript Testing.

https://jestjs.io

License: MIT

Language: JavaScript

Keywords: easy, expectation, facebook, immersive, javascript, painless, painless-javascript-testing, snapshot, testing


npm version Follow on Twitter

 

🃏 Delightful JavaScript Testing

👩🏻‍💻 Developer Ready: A comprehensive JavaScript testing solution. Works out of the box for most JavaScript projects.

🏃🏽 Instant Feedback: Fast, interactive watch mode only runs test files related to changed files.

📸 Snapshot Testing: Capture snapshots of large objects to simplify testing and to analyze how they change over time.

See more on jestjs.io

Getting Started

Install Jest using yarn:

yarn add --dev jest

Or npm:

npm install --save-dev jest

Note: Jest documentation uses yarn commands, but npm will also work. You can compare yarn and npm commands in the yarn docs, here.

Let's get started by writing a test for a hypothetical function that adds two numbers. First, create a sum.js file:

function sum(a, b) {
  return a + b;
}
module.exports = sum;

Then, create a file named sum.test.js. This will contain our actual test:

const sum = require('./sum');

test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3);
});

Add the following section to your package.json:

{
  "scripts": {
    "test": "jest"
  }
}

Finally, run yarn test or npm run test and Jest will print this message:

PASS  ./sum.test.js
✓ adds 1 + 2 to equal 3 (5ms)

You just successfully wrote your first test using Jest!

This test used expect and toBe to test that two values were exactly identical. To learn about the other things that Jest can test, see Using Matchers.

Running from command line

You can run Jest directly from the CLI (if it's globally available in your PATH, e.g. by yarn global add jest or npm install jest --global) with a variety of useful options.

Here's how to run Jest on files matching my-test, using config.json as a configuration file and display a native OS notification after the run:

jest my-test --notify --config=config.json

If you'd like to learn more about running jest through the command line, take a look at the Jest CLI Options page.

Additional Configuration

Generate a basic configuration file

Based on your project, Jest will ask you a few questions and will create a basic configuration file with a short description for each option:

jest --init

Using Babel

To use Babel, install required dependencies via yarn:

yarn add --dev babel-jest @babel/core @babel/preset-env

If you do not already have babel configured for your project, you can use Babel to target your current version of Node by creating a babel.config.js file in the root of your project:

// babel.config.js
module.exports = {
  presets: [['@babel/preset-env', {targets: {node: 'current'}}]],
};

The ideal configuration for Babel will depend on your project. See Babel's docs for more details.

Making your Babel config jest-aware

Jest will set process.env.NODE_ENV to 'test' if it's not set to something else. You can use that in your configuration to conditionally setup only the compilation needed for Jest, e.g.

// babel.config.js
module.exports = api => {
  const isTest = api.env('test');
  // You can use isTest to determine what presets and plugins to use.

  return {
    // ...
  };
};

Note: babel-jest is automatically installed when installing Jest and will automatically transform files if a babel configuration exists in your project. To avoid this behavior, you can explicitly reset the transform configuration option:

// jest.config.js
module.exports = {
  transform: {},
};

Using webpack

Jest can be used in projects that use webpack to manage assets, styles, and compilation. webpack does offer some unique challenges over other tools. Refer to the webpack guide to get started.

Using TypeScript

Jest supports TypeScript, via Babel. First make sure you followed the instructions on using Babel above. Next install the @babel/preset-typescript via yarn:

yarn add --dev @babel/preset-typescript

Then add @babel/preset-typescript to the list of presets in your babel.config.js.

// babel.config.js
module.exports = {
  presets: [
    ['@babel/preset-env', {targets: {node: 'current'}}],
+    '@babel/preset-typescript',
  ],
};

Note, there are some caveats to using TypeScript with Babel. Because TypeScript support in Babel is just transpilation, Jest will not type-check your tests as they are ran. If you want that, you can use ts-jest.

Documentation

Learn more about using Jest on the official site!

Badge

Show the world you're using Jest tested with jest jest

[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest) [![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest)

Contributing

Development of Jest happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Jest.

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Jest.

Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

Credits

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

License

Jest is MIT licensed.

Project Statistics

Sourcerank 27
Repository Size 153 MB
Stars 25,437
Forks 3,470
Watchers 503
Open issues 636
Dependencies 2,880
Contributors 801
Tags 193
Created
Last updated
Last pushed

Top Contributors See all

Christoph Nakazawa Simen Bekkhus Aaron Abramov Michał Pierzchała Mark Pedrotti Miguel Jiménez Dmitry Soshnikov Rubén Norte Rogelio Guzman Rick Hanlon II Jeff Morrison Héctor Ramos wtgtybhertgeghgtwtg Tim Seckinger Cristian Carlesso Matt Phillips Orta Eric Nakagawa Amjad Masad scotthovestadt

Packages Referencing this Repo

cjs-jest-reporters3
Jest's reporters
Latest release 24.8.0 - Published - 25.4K stars
@houshuang/babel-jest
Jest plugin to use babel for transformation.
Latest release 23.2.0 - Published - 25.4K stars
jest-watcher
Delightful JavaScript Testing.
Latest release 24.8.0 - Updated - 25.4K stars
jest-serializer
Module for serializing and deserializing object into memory and disk. By default, the `v8` implem...
Latest release 24.4.0 - Updated - 25.4K stars
diff-sequences
Compare items in two sequences to find a longest common subsequence
Latest release 24.3.0 - Updated - 25.4K stars
@kovensky/babel-jest
Jest plugin to use babel for transformation (babel 7 beta version).
Latest release 21.2.1-1 - Published - 25.4K stars
jest-leak-detector
Module for verifying whether an object has been garbage collected or not.
Latest release 24.8.0 - Updated - 25.4K stars
jest-worker
Module for executing heavy tasks under forked processes in parallel, by providing a `Promise` bas...
Latest release 24.6.0 - Updated - 25.4K stars
jest-runner
Delightful JavaScript Testing.
Latest release 24.8.0 - Updated - 25.4K stars
jest-jasmine-fb
Delightful JavaScript Testing.
Latest release 20.1.0-alpha.2 - Updated - 25.4K stars
jest-diff-2
Delightful JavaScript Testing.
Latest release 20.0.3 - Published - 25.4K stars
jest-2
Delightful JavaScript Testing.
Latest release 20.0.4 - Published - 25.4K stars
jest-circus
<h1 align="center"> <img src="https://jestjs.io/img/jest.png" height="150" width="150"/> <img...
Latest release 24.8.0 - Updated - 25.4K stars
jest-get-type
A utility function to get the type of a value
Latest release 24.8.0 - Updated - 25.4K stars
jest-docblock
`jest-docblock` is a package that can extract and parse a specially-formatted comment called a "d...
Latest release 24.3.0 - Updated - 25.4K stars
jest-each
Parameterised tests for Jest
Latest release 24.8.0 - Updated - 25.4K stars
jest-test-typescript-parser
Delightful JavaScript Testing.
Latest release 24.0.0-alpha.0 - Updated - 25.4K stars
jest-regex-util
Delightful JavaScript Testing.
Latest release 24.3.0 - Updated - 25.4K stars
jest-message-util
Delightful JavaScript Testing.
Latest release 24.8.0 - Updated - 25.4K stars
jest-validate
Generic configuration validation tool that helps you with warnings, errors and deprecation messag...
Latest release 24.8.0 - Updated - 25.4K stars

Recent Tags See all

v24.8.0 May 05, 2019
v24.7.1 April 04, 2019
v24.7.0 April 03, 2019
v24.6.0 April 01, 2019
v24.5.0 March 12, 2019
v24.4.0 March 11, 2019
v24.3.1 March 07, 2019
v24.3.0 March 07, 2019
v24.2.0-alpha.0 March 05, 2019
v24.1.0 February 05, 2019
v24.0.0 January 25, 2019
v24.0.0-alpha.16 January 25, 2019
v24.0.0-alpha.15 January 24, 2019
v24.0.0-alpha.14 January 24, 2019
v24.0.0-alpha.14 January 24, 2019

Interesting Forks See all

SimenB/jest
🃏 Painless JavaScript Testing.
JavaScript - Other - Last pushed - 2 stars
gaearon/jest
🃏 Delightful JavaScript Testing.
JavaScript - Last pushed - 2 stars - 1 forks
Bhanditz/jest
Delightful JavaScript Testing.
JavaScript - Other - Updated - 1 stars
Opportunitylivetv/jest
🃏 Delightful JavaScript Testing.
JavaScript - Other - Updated - 1 stars - 1 forks
midzelis/jest
🃏 Delightful JavaScript Testing.
JavaScript - Other - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-04-20 00:42:42 UTC

Login to resync this repository