Premiers pas · Jest

Installez Jest en utilisant votre gestionnaire de paquets favori :
Commençons par écrire un test pour une hypothétique fonction qui additionne deux nombres. First, create a sum.js file:
Then, create a file named sum.test.js. Il s'agit de notre test actuel :
Add the following section to your package.json:
Finally, run yarn test or npm test and Jest will print this message:
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.
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:
If you'd like to learn more about running jest through the command line, take a look at the Jest CLI Options page.
Basé sur votre projet, Jest vous posera quelques questions et créera un fichier de configuration de base avec une courte description pour chaque option :
To use Babel, install required dependencies:
Configure Babel to target your current version of Node by creating a babel.config.js file in the root of your project:
La configuration idéale pour Babel dépendra de votre projet. See Babel's docs for more details.
Jest will set process.env.NODE_ENV to 'test' if it's not set to something else. Vous pouvez l'utiliser dans votre configuration pour paramétrer de manière conditionnelle uniquement la compilation nécessaire pour Jest, par exemple.
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:
Most of the time you do not need to do anything special to work with different bundlers - the exception is if you have some plugin or configuration which generates files or have custom file resolution rules.
Jest can be used in projects that use webpack to manage assets, styles, and compilation. webpack offre quelques défis singuliers par rapport à d'autres outils. Refer to the webpack guide to get started.
Jest is not supported by Vite due to incompatibilities with the Vite plugin system.
There are examples for Jest integration with Vite in the vite-jest library. However, this library is not compatible with versions of Vite later than 2.4.2.
One alternative is Vitest which has an API that is compatible with Jest.
Jest can be used in projects that use parcel-bundler to manage assets, styles, and compilation similar to webpack. Parcel nécessite aucune configuration. Refer to the official docs to get started.
Jest prend en charge TypeScript, via Babel. First, make sure you followed the instructions on using Babel above. Next, install the @babel/preset-typescript:
Then add @babel/preset-typescript to the list of presets in your babel.config.js.
However, there are some caveats to using TypeScript with Babel. La prise en charge de TypeScript dans Babel étant purement une transpilation, Jest ne vérifiera pas le typage de vos tests lors de leur exécution. If you want that, you can use ts-jest instead, or just run the TypeScript compiler tsc separately (or as part of your build process).
Node erases type annotations itself, and Jest uses that whenever no transformer claims a .ts, .mts or .cts file. Set an empty transform to take the default babel-jest entry out of the way:
Node replaces types with whitespace, so positions line up with your source and no source map is involved. It requires Node.js ^22.13.0 or >=23.2.0.
Jest reads the module format the same way it does for JavaScript, so an ESM .ts or .mts file needs its extension in extensionsToTreatAsEsm. Node infers ESM from .mts and CommonJS from .cts on the extension alone; Jest does not do that yet.
What Node cannot do is compile TypeScript features that emit code. enum, namespace and parameter properties throw, and so does JSX, which means .tsx still needs Babel or ts-jest. Two more things to keep in mind:
ts-jest is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
In order for Jest to transpile TypeScript with ts-jest, you may also need to create a configuration file.
There are two ways to have Jest global APIs typed for test files written in TypeScript.
Vous pouvez utiliser les définitions de types qui sont livrées avec Jest et seront mises à jour chaque fois que vous mettez à jour Jest. Install the @jest/globals package:
Et importez les API depuis le paquet :
See the additional usage documentation of describe.each/test.each and mock functions.
Or you may choose to install the @types/jest package. Il fournit des types pour les globales Jest sans devoir les importer.
@types/jest is a third party library maintained at DefinitelyTyped, hence the latest Jest features or versions may not be covered yet. Try to match versions of Jest and @types/jest as closely as possible. For example, if you are using Jest 27.4.0 then installing 27.4.x of @types/jest is ideal.
Jest can be used with ESLint without any further configuration as long as you import the Jest global helpers (describe, it, etc.) from @jest/globals before using them in your test file. This is necessary to avoid no-undef errors from ESLint, which doesn't know about the Jest globals.
If you'd like to avoid these imports, you can configure your ESLint environment to support these globals by adding the jest environment:
Or use eslint-plugin-jest, which has a similar effect: