next

Edit

Jest CLI Options

Командний рядок Jest має декілька корисних опцій. Ви можете запустити jest --help для того щоб переглянути всі наявні опції. Багато опцій, що показані нижче можуть також бути використані разом для того, щоб протестувати саме те, що ви хочете. Кожен з параметрів конфігурації Jest також може бути вказаний як параметр командного рядка.

Ось короткий огляд:

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

Запустити всі тести (за замовчуванням):

jest

Запустити лише тести за визначеним патерном чи назвою файлу:

jest my-test #or
jest path/to/my-test.js

Запустити тести що мають відношення до змінених файлів (файли які не були закомічені):

jest -o

Запустити тести, які стосуються path/to/fileA.js і path/to/fileB.js:

jest --findRelatedTests path/to/fileA.js path/to/fileB.js

Запустити тести, які відповідають назві специфікацій (порівнюються опис в describe або it).

jest -t name-of-spec

Запустити режим спостереження:

jest --watch #runs jest -o by default
jest --watchAll #runs all tests

Режим спостереження також дозволяє вказувати ім’я або шлях до файлу, щоб сфокусуватися на певному наборі тестів.

Використання з yarn

Якщо ви використовуєте Jest з yarn test, ви можете передати аргументи командного рядка напряму, як аргументи Jest.

Замість:

jest -u -t="ColorPicker"

ви можете використовувати:

yarn test -u -t="ColorPicker"

Використання з npm скриптами

If you run Jest via npm test, you can still use the command line arguments by inserting a -- between npm test and the Jest arguments.

Замість:

jest -u -t="ColorPicker"

ви можете використовувати:

npm test -- -u -t="ColorPicker"

Camelcase & dashed args support

Jest supports both camelcase and dashed arg formats. The following examples will have an equal result:

jest --collect-coverage
jest --collectCoverage

Arguments can also be mixed:

jest --update-snapshot --detectOpenHandles

Опції

Note: CLI options take precedence over values from the Configuration.

Довідка

jest <regexForTestFiles>

У випадку запуску jest з аргументом, цей аргумент розглядається як регулярний вираз та порівнюється з файлами у проекті. Існує можливість запускати набори тестів, вказуючи патерн. Тільки тести з файлів, які співпадають з патерном будуть відібрані для виконання. Depending on your terminal, you may need to quote this argument: jest "my.*(complex)?pattern". On Windows, you will need to use / as a path separator or escape \ as \.

--bail

Alias: -b. Exit the test suite immediately upon n number of failing test suite. Defaults to 1.

--cache

Чи використовувати кеш. За замовчуванням true. Вимкніть кеш, використовуючи --no-cache. Примітка: кеш варто відключати лише в тоді, коли ви маєте проблеми, пов’язані з кешем. В середньому, відключення кешу робить Jest щонайменше вдвічі повільнішим.

Якщо ви хочете проінспектувати кеш, скористайтесь --showConfig і перегляньте cacheDirectory значення. Якщо ви бажаєте очистити кеш, використайте --clearCache.

--changedFilesWithAncestor

Runs tests related to the current changes and the changes made in the last commit. Behaves similarly to --onlyChanged.

--changedSince

Runs tests related to the changes since the provided branch or commit hash. If the current branch has diverged from the given branch, then only changes made locally will be tested. Behaves similarly to --onlyChanged.

--ci

Коли вказана ця опція, Jest буде думати, що працює в CI середовищі. Це змінює поведінку, коли зустрічається необхідність в створенні нового знімку. Замість звичайної поведінки зі створенням нового знімку, буде викликана помилка тесту і для оновлення знімків буде необхідно запустити Jest з параметром --updateSnapshot.

--clearCache

Видаляє каталог кешу Jest, а потім виходить без запуску тестів. Буде видалено cacheDirectory, якщо параметр буде передано, або каталогу Jest. кешу, що за замовчуванням. Каталог кешу за замовчуванням можна знайти, запустивши jest --showConfig. Примітка: очищення кешу знизить продуктивність.

--collectCoverageFrom=<glob>

A glob pattern relative to rootDir matching the files that coverage info needs to be collected from.

--colors

Примусово підсвічувати вивід результатів тестів, навіть коли stdout не TTY.

--config=<path>

Псевдонім: -c. Шлях до конфігураційного файлу Jest, який вказує як шукати і виконувати тести. If no rootDir is set in the config, the directory containing the config file is assumed to be the rootDir for the project. Це також може бути JSON рядок, який Jest буде використовувати в якості конфігурації.

--coverage[=<boolean>]

Alias: --collectCoverage. Вказує, що інформація про покриття тестами повинна збиратися і виводитися разом з результатами тестів. Optionally pass <boolean> to override option set in configuration.

--coverageProvider=<provider>

Indicates which provider should be used to instrument code for coverage. Allowed values are babel (default) or v8.

Note that using v8 is considered experimental. This uses V8's builtin code coverage rather than one based on Babel. It is not as well tested, and it has also improved in the last few releases of Node. Using the latest versions of node (v14 at the time of this writing) will yield better results.

--debug

Виводити інформацію для відлагодження щодо вашої конфігурації Jest.

--detectOpenHandles

Attempt to collect and print open handles preventing Jest from exiting cleanly. Use this in cases where you need to use --forceExit in order for Jest to exit to potentially track down the reason. This implies --runInBand, making tests run serially. Implemented using async_hooks. This option has a significant performance penalty and should only be used for debugging.

--env=<environment>

Тестове оточення, яке буде використане для всіх тестів. Може вказувати на будь-який файл або node модуль. Наприклад: jsdom, node або path/to/my-environment.js.

--errorOnDeprecated

Make calling deprecated APIs throw helpful error messages. Useful for easing the upgrade process.

--expand

Псевдонім: -e. Використовуйте цей параметр, щоб виводити повний diff і помилки замість патчу.

--findRelatedTests <spaceSeparatedListOfSourceFiles>

Find and run the tests that cover a space separated list of source files that were passed in as arguments. Useful for pre-commit hook integration to run the minimal amount of tests necessary. Can be used together with --coverage to include a test coverage for the source files, no duplicate --collectCoverageFrom arguments needed.

--forceExit

Змусити Jest примусово завершувати роботу після виконання всіх тестів. Це може бути корисно, якщо ресурси, підготовлені тестовим кодом, не можуть бути коректно очищені. Примітка: Ця опція - це обхідний механізм. Якщо Jest не завершує роботу рісля виконання тестів, це значить, що зовнішні ресурси не звільнено або таймери очікують виконання у вашому коді. Рекомендується звільняти зовнішні ресурси після кожного тесту, щоб Jest міг коректно завершувати роботу. You can use --detectOpenHandles to help track it down.

--help

Відобразити довідку, схожу на цю сторінку.

--init

Generate a basic configuration file. Based on your project, Jest will ask you a few questions that will help to generate a jest.config.js file with a short description for each option.

--injectGlobals

Insert Jest's globals (expect, test, describe, beforeEach etc.) into the global environment. If you set this to false, you should import from @jest/globals, e.g.

import {expect, jest, test} from '@jest/globals';

jest.useFakeTimers();

test('some test', () => {
  expect(Date.now()).toBe(0);
});

Note: This option is only supported using the default jest-circus. test runner

--json

Виводити результати тестів в JSON. В цьому режимі Jest буде відправляти увесь інший вивід і користувацькі повідомлення в stderr.

--outputFile=<filename>

Писати результати виконання тестів у файл, якщо параметр --json також вказано. The returned JSON structure is documented in testResultsProcessor.

--lastCommit

Run all tests affected by file changes in the last commit made. Behaves similarly to --onlyChanged.

--listTests

Виводить тести, які Jest би виконував зі вказаними параметрами, як JSON і завершити роботу. Це може бути корисно у поєднанні з --findRelatedTests, щоб дізнатися, які тести будуть виконані.

--logHeapUsage

Виводити дані про використання па’мяті після кожного тесту. Корисно для відлагоджування витоків пам’яті. Використовуйте разом з параметрами --runInBand та --expose-gc для Node.

--maxConcurrency=<num>

Prevents Jest from executing more than the specified amount of tests at the same time. Only affects tests that use test.concurrent.

--maxWorkers=<num>|<string>

Псевдонім: -w. Вказує максимальну кількість робочих процесів, які можуть бути створені під час виконання тестів. In single run mode, this defaults to the number of the cores available on your machine minus one for the main thread. In watch mode, this defaults to half of the available cores on your machine to ensure Jest is unobtrusive and does not grind your machine to a halt. It may be useful to adjust this in resource limited environments like CIs but the defaults should be adequate for most use-cases.

For environments with variable CPUs available, you can use percentage based configuration: --maxWorkers=50%

--noStackTrace

Забороняє трасування стеку викликів у виводі результатів тесту.

--notify

Активує повідомлення про результати тестів. Зручно, коли ви не хочете забути про виконання тестів, перемкнувшись на виконання іншої роботи.

--onlyChanged

Псевдонім: -o. Пробує визначити, які тести запускати, на основі того, які файли були змінені в поточному репозиторії. Плацює лише якщо ви запускаєте тести всередині git/hg репозиторію і потребує статичного дерева залежностей (тобто без динамічних "require").

--passWithNoTests

Allows the test suite to pass when no files are found.

--projects <path1> ... <pathN>

Run tests from one or more projects, found in the specified paths; also takes path globs. This option is the CLI equivalent of the projects configuration option. Note that if configuration files are found in the specified paths, all projects specified within those configuration files will be run.

--reporters

Run tests with specified reporters. Reporter options are not available via CLI. Example with multiple reporters:

jest --reporters="default" --reporters="jest-junit"

--roots

Список шляхів до директорій, що Jest повинен використовувати для пошуку файлів в них.

--runInBand

Псевдонім: -i. Запускати всі тести під ряд, замість створення кількох робочих процесів, які виконують тести. Може бути корисним для відлагодження.

--selectProjects <project1> ... <projectN>

Run only the tests of the specified projects. Jest uses the attribute displayName in the configuration to identify each project. If you use this option, you should provide a displayName to all your projects.

--runTestsByPath

Run only the tests that were specified with their exact paths.

Note: The default regex matching works fine on small runs, but becomes slow if provided with multiple patterns and/or against a lot of tests. This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files

--setupTestFrameworkScriptFile=<file>

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

--showConfig

Виводить конфігурацію Jest і завершує роботу.

--silent

Забороняє тестам виводити повідомлення в консоль.

--testNamePattern=<regex>

Псевдонім: -t. Run only tests with a name that matches the regex. Наприклад, припустимо, ви хочете запустити лише тести, пов'язані з авторизацією, які матимуть назви типу "GET /api/posts with auth", то можна використати jest -t=auth.

Note: The regex is matched against the full name, which is a combination of the test name and all its surrounding describe blocks.

--testLocationInResults

Додає locationполе для перевірки результатів. Корисно, якщо ви хочете повідомити про місцезнаходження тесту в звіт.

Зауважте, що column 0-індексований в той час як line ні.

{
  "column": 4,
  "line": 5
}

--testPathPattern=<regex>

Регулярний вираз, який порівнюється зі шляхом до файла з тестами перед його запуском. On Windows, you will need to use / as a path separator or escape \ as \.

--testPathIgnorePatterns=[array]

An array of regexp pattern strings that are tested against all tests paths before executing the test. Contrary to --testPathPattern, it will only run those tests with a path that does not match with the provided regexp expressions.

--testRunner=<path>

Дозволяє вам вказати стороннього виконавця тестів.

--testSequencer=<path>

Lets you specify a custom test sequencer. Please refer to the documentation of the corresponding configuration property for details.

--testTimeout=<number>

Default timeout of a test in milliseconds. Default value: 5000.

--updateSnapshot

Псевдонім: -u. Використофуйте цей параметр, щоб створити заново кожен знімок, який викликав помилку під час виконання тестів. Може бути використаний разом з вказанням шаблону наборів тестів або з --testNamePattern щоб заново створити знімки.

--useStderr

Пренаправити весь вивід в stderr.

--verbose

Виводити результати кожного тесту з ієрархією набору тестів.

--version

Псевдонім: -v. Виводить версію і завершує роботу.

--watch

Слідкує за файлами, якізмінюються і запускає тести, які їх стосуються. Якщо ви хочете виконати всі тести, коли змінюється будь-який файл, використовуйте параметр --watchAll.

--watchAll

Слідкує за зміною файлів і перезапускає всі тести, якщо будь-який з них буде змінено. Якщо ви хочете перезапускати лише ті тести, які залежать від змінених файлів, використовуйте параметр --watch.

Use --watchAll=false to explicitly disable the watch mode. Note that in most CI environments, this is automatically handled for you.

--watchman

Whether to use watchman for file crawling. Defaults to true. Disable using --no-watchman.

← Configuring JestEnvironment Variables →