Опции командной строки 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
Режим отслеживания изменений также позволяет указать имя или путь к файлу, чтобы сфокусироваться на выполнении определенного набора тестов.
Using with package manager
If you run Jest via your package manager, you can still pass the command line arguments directly as Jest arguments.
Вместо:
jest -u -t="ColorPicker"
вы можете использовать:
- npm
- Yarn
- pnpm
npm test -- -u -t="ColorPicker"
yarn test -u -t="ColorPicker"
pnpm 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
Параметры
CLI options take precedence over values from the Configuration.
- Camelcase & dashed args support
- Параметры
- Справка
jest <regexForTestFiles>
--bail[=<n>]
--cache
--changedFilesWithAncestor
--changedSince
--ci
--clearCache
--clearMocks
--collectCoverageFrom=<glob>
--colors
--config=<path>
--coverage[=<boolean>]
--coverageDirectory=<path>
--coverageProvider=<provider>
--debug
--detectOpenHandles
--env=<environment>
--errorOnDeprecated
--expand
--filter=<file>
--findRelatedTests <spaceSeparatedListOfSourceFiles>
--forceExit
--help
--ignoreProjects <project1> ... <projectN>
--init
--injectGlobals
--json
--lastCommit
--listTests
--logHeapUsage
--maxConcurrency=<num>
--maxWorkers=<num>|<string>
--noStackTrace
--notify
--onlyChanged
--openHandlesTimeout=<milliseconds>
--outputFile=<filename>
--passWithNoTests
--projects <path1> ... <pathN>
--randomize
--reporters
--resetMocks
--restoreMocks
--roots
--runInBand
--runTestsByPath
--seed=<num>
--selectProjects <project1> ... <projectN>
--setupFilesAfterEnv <path1> ... <pathN>
--shard
--showConfig
--showSeed
--silent
--testEnvironmentOptions=<json string>
--testLocationInResults
--testMatch glob1 ... globN
--testNamePattern=<regex>
--testPathIgnorePatterns=<regex>|[array]
--testPathPattern=<regex>
--testRunner=<path>
--testSequencer=<path>
--testTimeout=<number>
--updateSnapshot
--useStderr
--verbose
--version
--watch
--watchAll
--watchman
--workerThreads
Справка
jest <regexForTestFiles>
При запуске Jest
с аргументом этот аргумент интерпретируется как регулярное выражение, сопоставляемое c файлами в вашем проекте. Это позволяет запустить наборы тестов, предоставляя шаблон. Будут выбраны и выполнены только те файлы, которые соответствуют шаблону. В зависимости от терминала, может понадобится заключить аргумент в кавычки: jest "my.*(complex)?pattern"
. На Windows используйте /
в качестве разделителя пути, а `экранируйте с помощью обратной косой:
`.
--bail[=<n>]
Псевдоним: -b
. Выход из набора тестов сразу после n
неудачных тестов. По умолчанию 1
.
--cache
Нужно ли использовать кэш. По умолчанию используется значение true. Отключить использование кэша можно с помощью флага --no-cache
.
The cache should only be disabled if you are experiencing caching related problems. On average, disabling the cache makes Jest at least two times slower.
Чтобы посмотреть содержимое кэша используйте аргумент --showConfig
и значение cacheDirectory
. Для очистки кэша добавьте --clearCache
.
--changedFilesWithAncestor
Запускает тесты для файлов с текущими изменениями, а также для файлов, которые были измененны в предыдущем коммите. Похожая опция: --onlyChanged
.
--changedSince
Запускает тесты, которые затрагивают изменения в указанной ветке или коммите. Если рабочая ветка не совпадает с указанной, тогда будут протестированны только локальные изменения. Похожая опция: --onlyChanged
.
--ci
При указании этой опции Jest будет считать, что выполняется в CI-среде. В этом случае меняется поведение при обнаружении новых тестов со снимками. Вместо того, чтобы автоматически сохранить новый снимок, Jest будет считать тест проваленным, если запущен без --updateSnapshot
.
--clearCache
Удаляет директорию с кэшом Jest и завершает процесс без запуска тестов. Опция cacheDirectory
используется для указания директории с кэшом. Если её пропустить, Jest удалит кэш-директорию по-умолчанию. Чтобы узнать, где находится кэш-директория по умолчанию, вызовите следующую комманду: jest --showConfig
.
Clearing the cache will reduce performance.
--clearMocks
Automatically clear mock calls, instances, contexts and results before every test. Equivalent to calling jest.clearAllMocks()
before each test. This does not remove any mock implementation that may have been provided.
--collectCoverageFrom=<glob>
Glob-шаблон отностительно rootDir
, по которому будут выбраны файлы с информацией для отчета о покритии тестами.
--colors
Принудительно включает подсветку вывода результатов тестирования, даже если stdout – не TTY.
Alternatively you can set the environment variable FORCE_COLOR=true
to forcefully enable or FORCE_COLOR=false
to disable colorized output. The use of FORCE_COLOR
overrides all other color support checks.
--config=<path>
Псевдоним: -c
. Путь к файлу конфигурации Jest, в котором указывается где искать и как выполнять тесты. Если в конфигурации не задан rootDir
, тогда каталог с конфигурационным файлом будет считаться rootDir
для проекта. Для задания данной опции может быть использовано JSON-значение, которое Jest будет использовать как конфигурацию.
--coverage[=<boolean>]
Аналог: --collectCoverage
. Указывает, что следует собирать и отображать информацию о тестовом покрытии. Возможно передать <boolean>
для переопределения параметров, установленных в конфигурации.
--coverageDirectory=<path>
The directory where Jest should output its coverage files.
--coverageProvider=<provider>
Indicates which provider should be used to instrument code for coverage. Допустимые значения: babel
(по умолчанию) или v8
.
--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 asynchronous function receives a list of test paths which can be manipulated to exclude tests from running by returning an object with shape { filtered: Array<{ test: string }> }
. Especially useful when used in conjunction with a testing infrastructure to filter known broken tests, e.g.
module.exports = testPaths => {
const allowedPaths = testPaths
.filter(filteringFunction)
.map(test => ({test})); // [{ test: "path1.spec.js" }, { test: "path2.spec.js" }, etc]
return {
filtered: allowedPaths,
};
};
--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 закончить исполнение после того, как все тесты завершены. Полезно в случаях, когда ресурсы, созданные в целях тестирования, не могут быть освобождены надлежащим образом.
This feature is an escape-hatch. Если Jest не заканчивает выполнение после того, как тесты завершились, это означает, что внешние ресурсы по-прежнему удерживаются или таймеры ожидают завершения. Настоятельно рекомендуется высвобождать внешние ресурсы после завершения каждого отдельного теста для того, чтобы Jest успешно мог завершить выполнение. You can use --detectOpenHandles
to help track it down.
--help
Показать справку, схожую с данной страницей.
--ignoreProjects <project1> ... <projectN>
Ignore the tests of the specified projects. Jest использует атрибут displayName
из конфигурации для идентификации каждого проекта. Если вы используете эту опцию, вы должны указать displayName
во всех ваших проектах.
--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);
});
This option is only supported using the default jest-circus
test runner.
--json
Выводит результаты в формате JSON. В этом режиме весь вывод тестов и пользовательских сообщений будет направлен в stderr.
--lastCommit
Выполнит все тесты, которые были связаны с изменёнными файлами в последнем коммите. Похожая опция: --onlyChanged
.
--listTests
Lists all test files that Jest will run given the arguments, and exits.
--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
.
--openHandlesTimeout=<milliseconds>
When --detectOpenHandles
and --forceExit
are disabled, Jest will print a warning if the process has not exited cleanly after this number of milliseconds. A value of 0
disables the warning. Defaults to 1000
.
--outputFile=<filename>
Записывает результаты тестов в файл при условии, если указан флаг --json
. Структура возвращаемого JSON описана по ссылке testResultsProcessor.
--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.
If configuration files are found in the specified paths, all projects specified within those configuration files will be run.
--randomize
Shuffle the order of the tests within a file. The shuffling is based on the seed. See --seed=<num>
for more info.
Seed value is displayed when this option is set. Equivalent to setting the CLI option --showSeed
.
jest --randomize --seed 1234
This option is only supported using the default jest-circus
test runner.
--reporters
Запуск тестов с указанными генераторами отчетов. Параметры генераторов отчета недоступны через командную строку. Пример с несколькими генераторами отчетов:
jest --reporters="default" --reporters="jest-junit"
--resetMocks
Automatically reset mock state before every test. Equivalent to calling jest.resetAllMocks()
before each test. This will lead to any mocks having their fake implementations removed but does not restore their initial implementation.
--restoreMocks
Automatically restore mock state and implementation before every test. Equivalent to calling jest.restoreAllMocks()
before each test. This will lead to any mocks having their fake implementations removed and restores their initial implementation.
--roots
Список путей к директориями, в которых Jest должен искать файлы с тестами.
--runInBand
Псевдоним: -i
. Последовательно выполняет все тесты в текущем процессе вместо создания пула дочерних рабочих процессов, которые выполняют тесты. Может быть полезно для отладки.
--runTestsByPath
Запускает тесты, к которым указаны конкретные пути. This avoids converting them into a regular expression and matching it against every single file.
For example, given the following file structure:
__tests__
└── t1.test.js # test
└── t2.test.js # test
When ran with a pattern, no test is found:
jest --runTestsByPath __tests__/t
Output:
No tests found
However, passing an exact path will execute only the given test:
jest --runTestsByPath __tests__/t1.test.js
Output:
PASS __tests__/t1.test.js
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.
--seed=<num>
Sets a seed value that can be retrieved in a test file via jest.getSeed()
. The seed value must be between -0x80000000
and 0x7fffffff
inclusive (-2147483648
(-(2 ** 31)
) and 2147483647
(2 ** 31 - 1
) in decimal).
jest --seed=1324
If this option is not specified Jest will randomly generate the value. You can use the --showSeed
flag to print the seed in the test report summary.
--selectProjects <project1> ... <projectN>
Run the tests of the specified projects. Jest использует атрибут displayName
из конфигурации для идентификации каждого проекта. Если вы используете эту опцию, вы должны указать displayName
во всех ваших проектах.
--setupFilesAfterEnv <path1> ... <pathN>
A list of paths to modules that run some code to configure or to set up the testing framework before each test. Beware that files imported by the setup scripts will not be mocked during testing.
--shard
The test suite shard to execute in a format of (?<shardIndex>\d+)/(?<shardCount>\d+)
.
shardIndex
describes which shard to select while shardCount
controls the number of shards the suite should be split into.
shardIndex
and shardCount
have to be 1-based, positive numbers, and shardIndex
has to be lower than or equal to shardCount
.
When shard
is specified the configured testSequencer
has to implement a shard
method.
For example, to split the suite into three shards, each running one third of the tests:
jest --shard=1/3
jest --shard=2/3
jest --shard=3/3
--showConfig
Печатает Jest конфигурацию и затем выходит.
--showSeed
Prints the seed value in the test report summary. See --seed=<num>
for the details.
Can also be set in configuration. See showSeed
.
--silent
Запрещает тестам печать сообщений в консоль.
--testEnvironmentOptions=<json string>
A JSON string with options that will be passed to the testEnvironment
. The relevant options depend on the environment.
--testLocationInResults
Adds a location
field to test results. Useful if you want to report the location of a test in a reporter.
In the resulting object column
is 0-indexed while line
is not.
{
"column": 4,
"line": 5
}
--testMatch glob1 ... globN
The glob patterns Jest uses to detect test files. Please refer to the testMatch
configuration for details.
--testNamePattern=<regex>
Псевдоним: -t
. Запускает только те тесты, наименование которых подпадает под шаблон регулярного выражения. 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
.
The regex is matched against the full name, which is a combination of the test name and all its surrounding describe blocks.
--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.
--testPathPattern=<regex>
Строка регулярного выражения, которая противопоставляется всем путям тестов перед выполнением. На Windows используйте /
в качестве разделителя пути, а `экранируйте с помощью обратной косой:
`.
--testRunner=<path>
Позволяет указать сторонний исполнитель тестов.
--testSequencer=<path>
Lets you specify a custom test sequencer. Please refer to the testSequencer
configuration for details.
--testTimeout=<number>
Default timeout of a test in milliseconds. Default value: 5000.
--updateSnapshot
Псевдоним: -u
. Используйте этот флаг, чтобы повторно сохранять каждый снимок, который проваливается при исполнении тестов. Может использоваться для повторного сохранения снимков вместе с шаблоном для набора тестов или с опцией --testNamePattern
.
--useStderr
Отображает результаты индивидуальных тестов в тестовой иерархии.
--verbose
Отображает результаты отдельных в иерархии набора тестов.
--version
Псевдоним: -v
. Печатает текущую версию и выходит.
--watch
Наблюдает за изменениями в файлах и перезапускает тесты связанные с измененными файлами. Если вместо этого необходимо перезапускать все тесты, используйте флаг --watchAll
.
Use --no-watch
(or --watch=false
) to explicitly disable the watch mode if it was enabled using --watch
. In most CI environments, this is automatically handled for you.
--watchAll
Наблюдает за изменениями в файлах и перезапускает тесты, если что-то изменяется. Если необходимо перезапускать только тесты для измененных файлов, используйте флаг --watch
.
Use --no-watchAll
(or --watchAll=false
) to explicitly disable the watch mode if it was enabled using --watchAll
. 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
.
--workerThreads
Whether to use worker threads for parallelization. Child processes are used by default.
This is experimental feature. See the workerThreads
configuration option for more details.