Перейти к основной части
Version: Далее

Опции командной строки Jest

Утилита командной строки jest имеет ряд полезных опций. Вы можете выполнить команду jest --help для просмотра всех доступных параметров. Многие из них могут использоваться совместно друг с другом для запуска тестов именно так, как вы хотите. Каждый из конфигурационных параметров Jest может также быть настроен через командную строку.

Вот их краткий обзор:

Запуск из командной строки#

Запуск всех тестов (по умолчанию):

jest

Запустить только тесты по шаблону или по имени файла:

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

Выполнить тесты, связанные с измененными файлами, отраженными в hg/git (uncommitted файлы):

jest -o

Запуск тестов, относящихся к файлам path/to/fileA.js и path/to/fileB.js:

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

Выполнить тесты, названия которых совпадают с переданным аргументом (сравниваются строки в блоках describe и test).

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#

Если вы запускаете Jest с помощью npm test, то вы по-прежнему можете использовать аргументы командной строки путем добавления -- между командой npm test и аргументами Jest.

Вместо:

jest -u -t="ColorPicker"

вы можете использовать:

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

Написание параметров через тире или с большой буквы#

Jest поддерживает форматы написания аргументов в верблюжьем стиле (camelCase) и через тире. Следующие примеры будут иметь одинаковый результат:

jest --collect-coverage
jest --collectCoverage

Формат написания аргументов может смешиваться:

jest --update-snapshot --detectOpenHandles

Параметры#

На заметку: аргументы коммандной строки имеют приоритет над значениям в файле Configuration.


Справка#

jest <regexForTestFiles>#

При запуске Jest с аргументом этот аргумент интерпретируется как регулярное выражение, сопоставляемое c файлами в вашем проекте. Это позволяет запустить наборы тестов, предоставляя шаблон. Будут выбраны и выполнены только те файлы, которые соответствуют шаблону. В зависимости от терминала, может понадобится заключить аргумент в кавычки: jest "my.*(complex)?pattern". На Windows используйте / в качестве разделителя пути, а `экранируйте с помощью обратной косой:`.

--bail#

Псевдоним: -b. Выход из набора тестов сразу после n неудачных тестов. По умолчанию 1.

--cache#

Нужно ли использовать кэш. По умолчанию используется значение true. Отключить использование кэша можно с помощью флага --no-cache. Примечание: кэш следует отключать, только если вы испытываете связанные с ним трудности. В среднем, отключение кэша делает Jest по крайней мере в два раза медленнее.

Чтобы посмотреть содержимое кэша используйте аргумент --showConfig и значение cacheDirectory. Для очистки кэша добавьте --clearCache.

--changedFilesWithAncestor#

Запускает тесты для файлов с текущими изменениями, а также для файлов, которые были измененны в предыдущем коммите. Похожая опция: --onlyChanged.

--changedSince#

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

--ci#

При указании этой опции Jest будет считать, что выполняется в CI-среде. В этом случае меняется поведение при обнаружении новых тестов со снимками. Вместо того, чтобы автоматически сохранить новый снимок, Jest будет считать тест проваленным, если запущен без --updateSnapshot.

--clearCache#

Удаляет директорию с кэшом Jest и завершает процесс без запуска тестов. Опция cacheDirectory используется для указания директории с кэшом. Если её пропустить, Jest удалит кэш-директорию по-умолчанию. Чтобы узнать, где находится кэш-директория по умолчанию, вызовите следующую комманду: jest --showConfig. Внимание: очистка кэша снижает производительность!

--collectCoverageFrom=<glob>#

Glob-шаблон отностительно rootDir, по которому будут выбраны файлы с информацией для отчета о покритии тестами.

--colors#

Принудительно включает подсветку вывода результатов тестирования, даже если stdout – не TTY.

--config=<path>#

Псевдоним: -c. Путь к файлу конфигурации Jest, в котором указывается где искать и как выполнять тесты. Если в конфигурации не задан rootDir, тогда каталог с конфигурационным файлом будет считаться rootDir для проекта. Для задания данной опции может быть использовано JSON-значение, которое Jest будет использовать как конфигурацию.

--coverage[=<boolean>]#

Аналог: --collectCoverage. Указывает, что следует собирать и отображать информацию о тестовом покрытии. Возможно передать <boolean> для переопределения параметров, установленных в конфигурации.

--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. Реализовано с использованием async_hooks. Эта опция существенно снижает производительность и поэтому рекоммендуется использовать её только при отладке.

--env=<environment>#

Тестовое окружение, используемое для всех тестов. Может указывать на любой node-модуль или файл. Примеры: jsdom, node или путь/к/окружению.js.

--errorOnDeprecated#

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

--expand#

Псевдоним: -e. Используйте этот флаг, чтобы отображать полноценные diff и сообщения об ошибках вместо патчей.

--filter=<file>#

Путь к модулю, экспортирующему функцию фильтрации. This method receives a list of tests which can be manipulated to exclude tests from running. Especially useful when used in conjunction with a testing infrastructure to filter known broken.

--findRelatedTests <spaceSeparatedListOfSourceFiles>#

Запускает тесты, которые покрывают список файлов, переданных в качестве параметров через пробел. Эту опцию удобно использовать в связке с pre-commit хуком, так как она будет запускать только минимально необходимое количество тестов. Can be used together with --coverage to include a test coverage for the source files, no duplicate --collectCoverageFrom arguments needed.

--forceExit#

Вынуждает Jest закончить исполнение после того, как все тесты завершены. Полезно в случаях, когда ресурсы, созданные в целях тестирования, не могут быть освобождены надлежащим образом. Примечание: Данная опция – это, по сути, обходной механизм. Если Jest не заканчивает выполнение после того, как тесты завершились, это означает, что внешние ресурсы по-прежнему удерживаются или таймеры ожидают завершения. Настоятельно рекомендуется высвобождать внешние ресурсы после завершения каждого отдельного теста для того, чтобы Jest успешно мог завершить выполнение. Используйте опцию --detectOpenHandles для обнаружения таких ресурсов.

--help#

Показать справку, схожую с данной страницей.

--init#

Создание базового файла конфигурации. Jest задаст несколько вопросов, чтобы сгенерировать файл jest.config.js с коротким описанием каждой опции.

--injectGlobals#

Добавить глобальные переменные Jest (expect, test, describe, beforeEach и т. д.) в окружение. Если эта опция равна false, тогда нужно импортировать глобальные переменные из @jest/globals, например.

import {expect, jest, test} from '@jest/globals';
jest.useFakeTimers();
test('some test', () => {
expect(Date.now()).toBe(0);
});

Примечание: эта опция поддерживается только стандартной утилитой для запуска тестов jest-circus.

--json#

Выводит результаты в формате JSON. В этом режиме весь вывод тестов и пользовательских сообщений будет направлен в stderr.

--outputFile=<filename>#

Записывает результаты тестов в файл при условии, если указан флаг --json. Структура возвращаемого JSON описана по ссылке testResultsProcessor.

--lastCommit#

Выполнит все тесты, которые были связаны с изменёнными файлами в последнем коммите. Похожая опция: --onlyChanged.

--listTests#

Выводит список всех тестов, которые Jest выполнит по заданным параметрам, и завершается. Можно использовать вместе с --findRelatedTests, чтобы узнать, какие тесты запустит Jest.

--logHeapUsage#

Заносит в журнал данные об использовании динамической области после каждого теста. Полезно для выявления утечек памяти. При запуске в Node используйте вместе с опциями --runInBand и --expose-gc.

--maxConcurrency=<num>#

Приостанавливает Jest от выполнения большего количества тестов одновременно, чем указано. Влияет только на тесты, использующие test.concurrent.

--maxWorkers=<num>|<string>#

Псевдоним: -w. Задает максимальное количество рабочих потоков, выделяемое при выполнении тестов. В одиночном режиме прогона тестов, данный параметр будет равен количеству ядер, доступных на вашем компьютере минус 1 ядро, на котором запущен главный поток выполнения. В режиме наблюдения за изменениями файлов (watch mode), данный параметр будет равен половине от доступного количества ядер ПК, во избежание фризов системы и чрезмерного потребления ресурсов ПК Jest'ом. Может быть полезно настроить этот параметр в средах выполнения кода с ограниченными ресурсами, например в CI средах. Значение по умолчанию должно быть приемлемым для остальных вариантов использования.

Для окружений с переменным количеством доступных ядер процессора можно указать значение в процентах, например 50% от переменного кол-ва ядер ЦП: --maxWorkers=50%

--noStackTrace#

Отключает отображение трассирования стека при выводе результатов тестов.

--notify#

Включает оповещения для результатов прогона тестов. Удобно, когда вы не хотите акцентировать всё свое внимание на тестировании JavaScript.

--onlyChanged#

Alias: -t. Run only tests with a name that matches the regex. For example, suppose you want to run only tests related to authorization which will have names like "GET /api/posts with auth", then you can use jest -t=auth.

--passWithNoTests#

Разрешает успешно завершиться прогону тестов, даже если ни одного теста не было обнаружено.

--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#

Запуск тестов с указанными генераторами отчетов. Параметры генераторов отчета недоступны через командную строку. Пример с несколькими генераторами отчетов:

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

--roots#

Список путей к директориями, в которых Jest должен искать файлы с тестами.

--runInBand#

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

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

Запускает прогон тестов только в указанных проектах. Jest использует атрибут displayName из конфигурации для идентификации каждого проекта. Если вы используете эту опцию, вы должны указать displayName во всех ваших проектах.

--runTestsByPath#

Запускает тесты, к которым указаны конкретные пути.

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#

Запрещает тестам вывод сообщений в консоль.

--silent#

Запрещает тестам печать сообщений в консоль.

--testNamePattern=<regex>#

Псевдоним: -t. Запускает только те тесты, наименование которых подпадает под шаблон регулярного выражения. Например, предположим что вы хотите запустить тесты, которые относятся к авторизации. Тесты имеют в названии "GET /api/posts with auth". Для запуска этих тестов вы можете использовать jest -t=auth.

Примечание: Регулярное выражение соответствует полному имени, которое представляет собой комбинацию имени теста и всех его окружающих блоков.

--testLocationInResults#

Adds a location field to test results. Useful if you want to report the location of a test in a reporter.

Note that column is 0-indexed while line is not.

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

--testPathPattern=<regex>#

Строка регулярного выражения, которая противопоставляется всем путям тестов перед выполнением. На Windows используйте / в качестве разделителя пути, а `экранируйте с помощью обратной косой:`.

--testPathIgnorePatterns=<regex>|[array]#

A single or 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.

To pass as an array use escaped parentheses and space delimited regexps such as \(/node_modules/ /tests/e2e/\). Alternatively, you can omit parentheses by combining regexps into a single regexp like /node_modules/|/tests/e2e/. These two examples are equivalent.

--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#

Отображает результаты индивидуальных тестов в тестовой иерархии.

--verbose#

Отображает результаты отдельных в иерархии набора тестов.

--version#

Псевдоним: -v. Печатает текущую версию и выходит.

--watch#

Наблюдает за изменениями в файлах и перезапускает тесты связанные с измененными файлами. Если вместо этого необходимо перезапускать все тесты, используйте флаг --watchAll.

--watchAll#

Наблюдает за изменениями в файлах и перезапускает тесты, если что-то изменяется. Если необходимо перезапускать только тесты для измененных файлов, используйте флаг --watch.

Используйте --watchAll=false , чтобы явно отключить режим наблюдения. Обратите внимание, что в большинстве окружений непрерывной интеграции (CI) это осуществляется автоматически.

--watchman#

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