Version: 27.0

Початок роботи

Встановіть Jest за допомогою yarn:

yarn add --dev jest

Або npm:

npm install --save-dev jest

Примітка: документація Jest використовує команди yarn, проте npm також спрацює. Ви можете порівняти команди yarn та npm в в документації yarn.

Давайте почнемо з написання тесту для гіпотетичної функції, яка додає два числа. Спочатку створіть файл sum.js:

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

Далі, створіть файл з назвою sum.test.js. Що буде містити сам тест:

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

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

Додайте наступну секцію до вашого package.json:

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

І, нарешті, запустіть yarn test і Jest виведе це повідомлення:

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

Ви тільки що успішно написали свій перший тест, використовуючи Jest!

Цей тест використовує expect and toBe для перевірки, що два значення абсолютно ідентичні. Щоб дізнатися про інші речі, які Jest може тестувати, перегляньте Використання Matchers.

Запуск з командного рядка#

Ви можете запустити Jest безпосередньо з командного рядка (якщо він доступний глобально у вашому PATH, наприклад yarn global add jest або npm install jest --global) з широким набором корисних параметрів.

Ось як можна запустити Jest для файлів, назва яких відповідає шаблону my-test, використовуючи config.json як файл конфігурації та з відображенням нативних сповіщень ОС після запуску:

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

Щоб дізнатися більше про запуск jest з командного рядка, відвідайте сторінку параметри командного рядка Jest.

Додаткові налаштування#

Згенеруйте основний файл конфігурації#

В залежності від вашого проекту, Jest поставить вам кілька питань і створить початковий файл конфігурації з коротким описом кожного налаштування:

jest --init

Високристання Babel#

Щоб використовувати Babel, встановіть необхідні залежності за допомогою yarn:

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

Налаштуйте Babel відповідно до вашої версії Node, створивши файл babel.config.js в кореневому каталозі проекту:

// 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 {
    // ...
  };
};

Примітка: babel-jest автоматично встановлюється під час встановлення Jest і буде автоматично транслювати файли, якщо конфігурація Babel існує у вашому проекті. Щоб відключити цю поведінку, ви можете явно очистити конфігураційни параметр transform:

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

Підтримка Babel 6

Jest 24 втратив підтримку Babel 6. Ми наполегливо рекомендуємо вам оновитися до Babel 7, який активно підтримується. Однак, якщо оновлення до Babel 7 неможливе, або продовжуйте використовувати Jest 23 або оновіться до Jest 24 вказавши версію babel-jest 23, як у прикладі:

"dependencies": {
  "babel-core": "^6.26.3",
  "babel-jest": "^23.6.0",
  "babel-preset-env": "^1.7.0",
  "jest": "^24.0.0"
}

While we generally recommend using the same version of every Jest package, this workaround will allow you to continue using the latest version of Jest with Babel 6 for now.

Використання webpack#

Jest може застосовуватися в проектах, які використовують webpack для керування ресурсами, стилями та компіляції коду. webpack кидає певні унікальні виклики для використання інших інструментів. Перегляньте посібник по роботі з webpack щоб почати його використовувати.

Using parcel#

Jest може використовуватись в проектах, що використовують parsel-bundler для керування ресурсами, стилями та компіляції, подібної до webpack. Parcel вимагає нульову конфігурацію. Зверніться до офіційної документації , щоб розпочати роботу.

Використання TypeScript#

Jest підтримує TypeScript, за допомогою Babel. По-перше, переконайтеся, що ви дотримувались інструкцій використовуючи Babel вище. Далі, встановіть @babel/preset-typescript через yarn:

yarn add --dev @babel/preset-typescript

Тоді додайте @babel/preset-typescript до списку пресетів у вашому babel.config.js.

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

Проте, є деякі застереження щодо використання TypeScript з Babel. Оскільки TypeScript в Babel є суто транспіляцією, Jest не буде перевіряти ваші тести, коли вони будуть запущені. Якщо вам це потрібно, ви можете використовувати ts-jest , або просто запустіть компілятор TypeScript tsc окремо (або до вашої частини процесу збірки).

Ви також можете встановити модуль @types/jest для версії Jest, яку ви використовуєте. Це допоможе забезпечити повним набором під час написання тестів з TypeScript.

Для @types/* модулів рекомендується спробувати встановити відповідність версії відповідного модуля. Наприклад, якщо ви використовуєте 26.4.0 версію jest, тоді використання 26.4.x версії @types/jest є ідеальним. Взагалі, спробуйте поєднати мажорні (26) та другорядну (4) версію якомога точніше.

yarn add --dev @types/jest