25.x

Edit

Jest CLI Options

Утилита командной строки 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

Run tests that match this spec name (match against the name in describe or test, basically).

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 supports both camelcase and dashed arg formats. The following examples will have an equal result:

jest --collect-coverage
jest --collectCoverage

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

jest --update-snapshot --detectOpenHandles

Параметры

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

Справка

jest <regexForTestFiles>

При запуске Jest с аргументом этот аргумент интерпретируется как регулярное выражение, сопоставляемое c файлами в вашем проекте. Это позволяет запустить наборы тестов, предоставляя шаблон. Будут выбраны и выполнены только те файлы, которые соответствуют шаблону. 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 по крайней мере в два раза медленнее.

If you want to inspect the cache, use --showConfig and look at the cacheDirectory value. If you need to clear the cache, use --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

Deletes the Jest cache directory and then exits without running tests. Will delete cacheDirectory if the option is passed, or Jest's default cache directory. The default cache directory can be found by calling jest --showConfig. Note: clearing the cache will reduce performance.

--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. The path to a Jest config file specifying how to find and execute tests. Если в конфигурации не задан 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 and comes with a few caveats

  1. Your node version must include vm.compileFunction, which was introduced in node 10.10
  2. Tests needs to run in Node test environment (support for jsdom requires jest-environment-jsdom-sixteen)
  3. V8 has way better data in the later versions, so using the latest versions of node (v13 at the time of this writing) will yield better results

--debug

Print debugging info about your Jest config.

--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. This option has a significant performance penalty and should only be used for debugging.

--env=<environment>

The test environment used for all tests. This can point to any file or node module. Examples: jsdom, node or path/to/my-environment.js.

--errorOnDeprecated

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

--expand

Alias: -e. Use this flag to show full diffs and errors instead of a patch.

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

--json

Prints the test results in JSON. This mode will send all other test output and user messages to 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

Lists all tests as JSON that Jest will run given the arguments, and exits. This can be used together with --findRelatedTests to know which tests Jest will run.

--logHeapUsage

Logs the heap usage after every test. Useful to debug memory leaks. Use together with --runInBand and --expose-gc in 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

Активирует уведомления для результатов теста. Good for when you don't want your consciousness to be able to focus on anything except JavaScript testing.

--onlyChanged

Псевдоним: -o. Предпринимает попытку определить какие тесты запускать основываясь на данных о том, какие файлы в текущем репозитории были изменены. Only works if you're running tests in a git/hg repository at the moment and requires a static dependency graph (ie. no dynamic requires).

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

A list of paths to directories that Jest should use to search for files in.

--runInBand

Alias: -i. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.

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

Путь к модулю, который исполняет некоторый код для конфигурирования или установки платформы тестирования перед каждым тестом. Beware that files imported by the setup script will not be mocked during testing.

--showConfig

Выводит конфигурацию Jest и затем завершается.

--silent

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

--testNamePattern=<regex>

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.

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

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

Строка регулярного выражения, которая противопоставляется всем путям тестов перед выполнением. 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

Alias: -v. Print the version and exit.

--watch

Watch files for changes and rerun tests related to changed files. If you want to re-run all tests when a file has changed, use the --watchAll option instead.

--watchAll

Watch files for changes and rerun all tests when something changes. If you want to re-run only the tests that depend on the changed files, use the --watch option.

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 →