Skip to content
Delightful JavaScript Testing.
JavaScript TypeScript Other
Branch: master
Clone or download
jessestuart and thymikee fix(docs): Update broken links in docs. (#8847)
* fix(docs): Fix broken links pointing to legacy JS file.

Signed-off-by: Jesse Stuart <hi@jessestuart.com>

* chore(docs): Update CHANGELOG.

Signed-off-by: Jesse Stuart <hi@jessestuart.com>

* fix(docs): Fix broken link in "Configuration" docs.

Signed-off-by: Jesse Stuart <hi@jessestuart.com>
Latest commit 012472b Aug 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci chore: enforce LF line endings (#8809) Aug 11, 2019
.github chore: add funding.yml (#8498) May 28, 2019
.vscode chore: add runtimeArgs in VSCode launch.json (#6985) Sep 16, 2018
.yarn/releases chore: bump yarn (#8691) Jul 15, 2019
docs fix(docs): Update broken links in docs. (#8847) Aug 18, 2019
e2e chore: sort member in imports (#8846) Aug 18, 2019
examples chore: sort member in imports (#8846) Aug 18, 2019
fixtures Update Facebook copyright headers (#7589) Jan 8, 2019
packages chore: sort member in imports (#8846) Aug 18, 2019
scripts chore: Check copyright and license as one joined substring (#8815) Aug 13, 2019
website fix(docs): Update broken links in docs. (#8847) Aug 18, 2019
.azure-pipelines-steps.yml Simplify workaround that overrides Jest clone folder on Azure Pipelin… May 2, 2019
.azure-pipelines.yml Simplify workaround that overrides Jest clone folder on Azure Pipelin… May 2, 2019
.editorconfig chore: enforce LF line endings (#8809) Aug 11, 2019
.eslintignore expect: Highlight substring differences when matcher fails, part 2 (#… Jun 13, 2019
.eslintrc.js chore: sort member in imports (#8846) Aug 18, 2019
.gitignore chore: upgrade TS to 3.4.0-dev* for inceremental builds (#8149) Mar 19, 2019
.npmignore Chore: npmignore tsconfig.* files. (#8641) Jul 4, 2019
.prettierignore expect: Highlight substring differences when matcher fails, part 2 (#… Jun 13, 2019
.travis.yml Stop running TS builds on CI beyond dedicated lint job (#8346) Apr 22, 2019
.watchmanconfig add empty .watchmanconfig (#5683) Feb 27, 2018
.yarnrc chore: bump yarn (#8691) Jul 15, 2019
CHANGELOG.md fix(docs): Update broken links in docs. (#8847) Aug 18, 2019
CODE_OF_CONDUCT.md Add missing copyright headers and code of conduct (#7221) Oct 23, 2018
CONTRIBUTING.md Fix grammar: "a known issues"->"a known issue" (#8844) Aug 17, 2019
LICENSE LICENSE: Follow copyright header guidelines and delete For Jest softw… May 6, 2019
README.md feat(docs): Add Table of Contents (#8657) Jul 8, 2019
TestUtils.ts chore: correct type error in e2e test util (#8705) Jul 17, 2019
babel.config.js use babel-plugin-replace-ts-export-assignment package (#8805) Aug 10, 2019
crowdin.yaml Upgrade prettier (#6846) Aug 15, 2018
jest set correct stack trace for async rejections of non-errors (#6230) May 23, 2018
jest-worker Add node worker-thread support to jest-worker (#7408) Dec 5, 2018
jest.config.ci.js chore: Make sure copyright header comment includes license (#8783) Aug 6, 2019
jest.config.js chore: Make sure copyright header comment includes license (#8783) Aug 6, 2019
jsconfig.json Add Jest Editor Support (#2192) Dec 7, 2016
karma.conf.js Correctly bundle up for browser globals (#7661) Jan 20, 2019
lerna.json Release 24.9.0 Aug 16, 2019
package.json chore: sort member in imports (#8846) Aug 18, 2019
testSetupFile.js chore: goodbye AppVeyor, it was a good ride (#7660) Mar 19, 2019
tsconfig.json chore: reduce reliance on esModuleInterop (#8842) Aug 18, 2019
yarn.lock chore: sort member in imports (#8846) Aug 18, 2019

README.md

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

Table of Contents

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.

You can’t perform that action at this time.