265 lines
11 KiB
Markdown
265 lines
11 KiB
Markdown
<p align="center">
|
|
<a href="https://badge.fury.io/js/jest">
|
|
<img src="https://badge.fury.io/js/jest.svg" alt="npm version">
|
|
</a>
|
|
<a href="https://github.com/facebook/jest/blob/main/LICENSE">
|
|
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Jest is released under the MIT license." />
|
|
</a>
|
|
<a href="https://twitter.com/intent/follow?screen_name=fbjest">
|
|
<img src="https://img.shields.io/twitter/follow/fbjest.svg?style=social&label=Follow%20@fbjest" alt="Follow on Twitter" />
|
|
</a>
|
|
</p>
|
|
|
|
<!-- A spacer -->
|
|
<p> </p>
|
|
|
|
<p align="center"><img src="website/static/img/jest-readme-headline.png" width="80%"/></p>
|
|
|
|
<h2 align="center">🃏 Delightful JavaScript Testing</h2>
|
|
|
|
**👩🏻💻 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.
|
|
|
|
<p align="right"><em>See more on <a href="https://jestjs.io">jestjs.io</a></em></p>
|
|
|
|
## Table of Contents
|
|
|
|
- [Getting Started](#getting-started)
|
|
- [Running from command line](#running-from-command-line)
|
|
- [Additional Configuration](#additional-configuration)
|
|
- [Generate a basic configuration file](#generate-a-basic-configuration-file)
|
|
- [Using Babel](#using-babel)
|
|
- [Using Webpack](#using-webpack)
|
|
- [Using Parcel](#using-parcel)
|
|
- [Using Typescript](#using-typescript)
|
|
- [Documentation](#documentation)
|
|
- [Badge](#badge)
|
|
- [Contributing](#contributing)
|
|
- [Code of Conduct](#code-of-conduct)
|
|
- [Contributing Guide](#contributing-guide)
|
|
- [Good First Issues](#good-first-issues)
|
|
- [Credits](#credits)
|
|
- [Backers](#backers)
|
|
- [Sponsors](#sponsors)
|
|
- [License](#license)
|
|
|
|
## Getting Started
|
|
|
|
<!-- copied from Getting Started docs, links updated to point to Jest website -->
|
|
|
|
Install Jest using [`yarn`](https://yarnpkg.com/en/package/jest):
|
|
|
|
```bash
|
|
yarn add --dev jest
|
|
```
|
|
|
|
Or [`npm`](https://www.npmjs.com/package/jest):
|
|
|
|
```bash
|
|
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](https://yarnpkg.com/en/docs/migrating-from-npm#toc-cli-commands-comparison).
|
|
|
|
Let's get started by writing a test for a hypothetical function that adds two numbers. First, create a `sum.js` file:
|
|
|
|
```javascript
|
|
function sum(a, b) {
|
|
return a + b;
|
|
}
|
|
module.exports = sum;
|
|
```
|
|
|
|
Then, create a file named `sum.test.js`. This will contain our actual test:
|
|
|
|
```javascript
|
|
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`:
|
|
|
|
```json
|
|
{
|
|
"scripts": {
|
|
"test": "jest"
|
|
}
|
|
}
|
|
```
|
|
|
|
Finally, run `yarn test` or `npm test` and Jest will print this message:
|
|
|
|
```bash
|
|
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](https://jestjs.io/docs/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:
|
|
|
|
```bash
|
|
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](https://jestjs.io/docs/cli) 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:
|
|
|
|
```bash
|
|
jest --init
|
|
```
|
|
|
|
### Using Babel
|
|
|
|
To use [Babel](https://babeljs.io/), install required dependencies via `yarn`:
|
|
|
|
```bash
|
|
yarn add --dev babel-jest @babel/core @babel/preset-env
|
|
```
|
|
|
|
Configure Babel to target your current version of Node by creating a `babel.config.js` file in the root of your project:
|
|
|
|
```javascript
|
|
// 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](https://babeljs.io/docs/en/) for more details.
|
|
|
|
<details><summary markdown="span"><strong>Making your Babel config jest-aware</strong></summary>
|
|
|
|
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.
|
|
|
|
```javascript
|
|
// 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:
|
|
|
|
```javascript
|
|
// jest.config.js
|
|
module.exports = {
|
|
transform: {},
|
|
};
|
|
```
|
|
|
|
</details>
|
|
|
|
<!-- Note that the Babel 6 section in the Getting Started was removed -->
|
|
|
|
### Using webpack
|
|
|
|
Jest can be used in projects that use [webpack](https://webpack.js.org/) to manage assets, styles, and compilation. webpack does offer some unique challenges over other tools. Refer to the [webpack guide](https://jestjs.io/docs/webpack) to get started.
|
|
|
|
### Using parcel
|
|
|
|
Jest can be used in projects that use [parcel-bundler](https://parceljs.org/) to manage assets, styles, and compilation similar to webpack. Parcel requires zero configuration. Refer to the official [docs](https://parceljs.org/docs/) to get started.
|
|
|
|
### Using TypeScript
|
|
|
|
Jest supports TypeScript, via Babel. First, make sure you followed the instructions on [using Babel](#using-babel) above. Next, install the `@babel/preset-typescript` via `yarn`:
|
|
|
|
```bash
|
|
yarn add --dev @babel/preset-typescript
|
|
```
|
|
|
|
Then add `@babel/preset-typescript` to the list of presets in your `babel.config.js`.
|
|
|
|
```diff
|
|
// babel.config.js
|
|
module.exports = {
|
|
presets: [
|
|
['@babel/preset-env', {targets: {node: 'current'}}],
|
|
+ '@babel/preset-typescript',
|
|
],
|
|
};
|
|
```
|
|
|
|
However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transform-typescript#caveats) to using TypeScript with Babel. Because TypeScript support in Babel is purely transpilation, Jest will not type-check your tests as they are run. If you want that, you can use [ts-jest](https://github.com/kulshekhar/ts-jest) instead, or just run the TypeScript compiler [tsc](https://www.typescriptlang.org/docs/handbook/compiler-options.html) separately (or as part of your build process).
|
|
|
|
<!-- end copied -->
|
|
|
|
## Documentation
|
|
|
|
Learn more about using [Jest on the official site!](https://jestjs.io)
|
|
|
|
- [Getting Started](https://jestjs.io/docs/getting-started)
|
|
- [Guides](https://jestjs.io/docs/snapshot-testing)
|
|
- [API Reference](https://jestjs.io/docs/api)
|
|
- [Configuring Jest](https://jestjs.io/docs/configuration)
|
|
|
|
## Badge
|
|
|
|
Show the world you're using _Jest_ `→` [](https://github.com/facebook/jest) [](https://github.com/facebook/jest)
|
|
|
|
<!-- prettier-ignore -->
|
|
```md
|
|
[](https://github.com/facebook/jest)
|
|
[](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](https://code.facebook.com/codeofconduct)
|
|
|
|
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.facebook.com/codeofconduct) so that you can understand what actions will and will not be tolerated.
|
|
|
|
### [Contributing Guide](CONTRIBUTING.md)
|
|
|
|
Read our [contributing guide](CONTRIBUTING.md) 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](https://github.com/facebook/jest/labels/good%20first%20issue)
|
|
|
|
To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/facebook/jest/labels/good%20first%20issue) 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](CONTRIBUTING.md).
|
|
|
|
<a href="https://github.com/facebook/jest/graphs/contributors"><img src="https://opencollective.com/jest/contributors.svg?width=890&button=false" /></a>
|
|
|
|
### [Backers](https://opencollective.com/jest#backer)
|
|
|
|
Thank you to all our backers! 🙏
|
|
|
|
<a href="https://opencollective.com/jest#backers" target="_blank"><img src="https://opencollective.com/jest/backers.svg?width=890"></a>
|
|
|
|
### [Sponsors](https://opencollective.com/jest#sponsor)
|
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
|
|
|
|
<a href="https://opencollective.com/jest/sponsor/0/website" target="_blank"><img src="https://opencollective.com/jest/sponsor/0/avatar.svg"></a> <a href="https://opencollective.com/jest/sponsor/1/website" target="_blank"><img src="https://opencollective.com/jest/sponsor/1/avatar.svg"></a> <a href="https://opencollective.com/jest/sponsor/2/website" target="_blank"><img src="https://opencollective.com/jest/sponsor/2/avatar.svg"></a> <a href="https://opencollective.com/jest/sponsor/3/website" target="_blank"><img src="https://opencollective.com/jest/sponsor/3/avatar.svg"></a> <a href="https://opencollective.com/jest/sponsor/4/website" target="_blank"><img src="https://opencollective.com/jest/sponsor/4/avatar.svg"></a> <a href="https://opencollective.com/jest/sponsor/5/website" target="_blank"><img src="https://opencollective.com/jest/sponsor/5/avatar.svg"></a> <a href="https://opencollective.com/jest/sponsor/6/website" target="_blank"><img src="https://opencollective.com/jest/sponsor/6/avatar.svg"></a> <a href="https://opencollective.com/jest/sponsor/7/website" target="_blank"><img src="https://opencollective.com/jest/sponsor/7/avatar.svg"></a> <a href="https://opencollective.com/jest/sponsor/8/website" target="_blank"><img src="https://opencollective.com/jest/sponsor/8/avatar.svg"></a> <a href="https://opencollective.com/jest/sponsor/9/website" target="_blank"><img src="https://opencollective.com/jest/sponsor/9/avatar.svg"></a>
|
|
|
|
## License
|
|
|
|
Jest is [MIT licensed](./LICENSE).
|