πŸƒ Delightful JavaScript Testing.
rubennorte Added method to get an iterator for all files in HasteFS (#7010)
* Added method to get an iterator for all files in HasteFS

* Used hasteFS.getFileIterator() in jest-resolve-dependencies

* Update changelog
Latest commit ee751bf Sep 20, 2018
Permalink
Failed to load latest commit information.
.circleci chore: move jest configuration into config files (#6861) Aug 17, 2018
.github Upgrade prettier (#6846) Aug 15, 2018
.vscode chore: add runtimeArgs in VSCode launch.json (#6985) Sep 16, 2018
docs docs: fix `rejects.toMatch` on `rejects.toThrow` (#6999) Sep 19, 2018
e2e chore: bump package versions (#6978) Sep 19, 2018
examples chore: add example using babel 7 (#6983) Sep 18, 2018
fixtures Rename jest-watch to jest-watcher May 30, 2018
flow-typed Update flow typing for `{only,it,describe,it.only}.each` function arg… Sep 3, 2018
packages Added method to get an iterator for all files in HasteFS (#7010) Sep 20, 2018
scripts chore: bump package versions (#6978) Sep 19, 2018
types [WIP] feat: option to not escape strings in diff messages (#5661) Sep 17, 2018
website docs: Replace shallow equality with referential identity in `ExpectAP… Sep 19, 2018
.babelrc chore: transpile object shorthand syntax for node 4 compatibility (#6582 Jul 3, 2018
.editorconfig Don't strip trailing whitespace in snapshot files (#6111) May 2, 2018
.eslintignore Lint types/ directory (#4785) Oct 30, 2017
.eslintrc.js Update the eslint definition to un-break the CI build (#6587) Jul 1, 2018
.flowconfig chore: bump package versions (#6978) Sep 19, 2018
.gitignore Fix website versions page to links to correct language & delete unuse… Jul 22, 2018
.npmignore Add top-level .npmignore. Jul 12, 2016
.travis.yml Upgrade prettier (#6846) Aug 15, 2018
.watchmanconfig add empty .watchmanconfig (#5683) Feb 27, 2018
.yarnrc Integrated with Yarn workspaces (#3906) Jul 7, 2017
CHANGELOG.md Added method to get an iterator for all files in HasteFS (#7010) Sep 20, 2018
CONTRIBUTING.md chore: fix linting error in contributing guide Sep 15, 2018
LICENSE πŸƒ Change license from BSD+Patents to MIT. Sep 26, 2017
README.md Add badge of vulnerabilities from snyk.io (#6986) Sep 16, 2018
TestUtils.js rename `prettier` option to `prettierPath` (#6607) Jul 3, 2018
appveyor.yml Upgrade prettier (#6846) Aug 15, 2018
crowdin.yaml Upgrade prettier (#6846) Aug 15, 2018
eslintImportResolver.js Standardize file names: Fix file names in root (#5500) Feb 9, 2018
jest set correct stack trace for async rejections of non-errors (#6230) May 23, 2018
jest.config.ci.js chore: use useDots option in silent reporter (#6984) Sep 16, 2018
jest.config.js chore: move jest configuration into config files (#6861) Aug 17, 2018
jsconfig.json Add Jest Editor Support (#2192) Dec 7, 2016
karma.conf.js chore: rename "integration-tests" to "e2e" (#6315) May 27, 2018
lerna.json chore: bump package versions (#6978) Sep 19, 2018
package.json chore: upgrade eslint Sep 20, 2018
testSetupFile.js Standardize file names: Fix file names in root (#5500) Feb 9, 2018
yarn.lock chore: upgrade eslint Sep 20, 2018

README.md

Jest

πŸƒ Delightful JavaScript Testing

CircleCI Build Status Travis Build Status Windows Build Status Codecov badge npm version SemVer Blazing Fast

Backers on Open Collective Sponsors on Open Collective License: MIT Known Vulnerabilities

πŸ‘©πŸ»β€πŸ’» Developer Ready: Complete and ready to set-up JavaScript testing solution. Works out of the box for any React project.

πŸƒπŸ½ Instant Feedback: Fast interactive watch mode runs only test files related to changed files and is optimized to give signal quickly.

πŸ“Έ Snapshot Testing: Capture snapshots of React trees or other serializable values to simplify testing and to analyze how state changes over time.

Getting Started

Install Jest using yarn:

yarn add --dev jest

Or via npm:

npm install --save-dev jest

The minimum supported Node version is v6.0.0 by default. If you need to support Node 4, refer to the Compatibility issues section.

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 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) with 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

Using Babel

Babel is automatically handled by Jest using babel-jest. You don't need install anything extra for using Babel.

Note: If you are using Babel version 7 then you need to install babel-jest, babel-core@^7.0.0-bridge.0 and @babel/core with the following command:

yarn add --dev babel-jest babel-core@^7.0.0-bridge.0 @babel/core regenerator-runtime

Don't forget to add a .babelrc file in your project's root folder. For example, if you are using ES6 and React.js with the babel-preset-env and babel-preset-react presets:

{
  "presets": ["env", "react"]
}

You are now set up to use all ES6 features and React specific syntax.

Note: If you are using a more complicated Babel configuration, using Babel's env option, keep in mind that Jest will automatically define NODE_ENV as test. It will not use development section like Babel does by default when no NODE_ENV is set.

Note: If you've turned off transpilation of ES modules with the option { "modules": false }, you have to make sure to turn this on in your test environment.

{
  "presets": [["env", {"modules": false}], "react"],
  "env": {
    "test": {
      "presets": [["env"], "react"]
    }
  }
}

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:

// package.json
{
  "jest": {
    "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

To use TypeScript in your tests 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.