Перейти до основного змісту
Версія: Next

Опції командного рядка

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

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

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

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

jest

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

jest my-test # або
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 # запускає "jest -o" за замовчуванням
jest --watchAll # запускає всі тести

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

Використання з менеджером пакетів​

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

Замість:

jest -u -t="ColorPicker"

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

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

Підтримка регістрів​

Jest підтримує аргументи в верблюдячому та шашличному регістрах. Наступні приклади матимуть однаковий результат:

jest --collect-coverage
jest --collectCoverage

Аргументи також можуть бути змішаними:

jest --update-snapshot --detectOpenHandles

Параметри​

note

Параметри командного рядка мають перевагу над параметрами, вказаними в конфігурації.

Довідка​

jest <regexForTestFiles>​

У випадку запуску jest з аргументом, цей аргумент розглядається як регулярний вираз та порівнюється з файлами у проекті. Існує можливість запускати набори тестів, вказуючи патерн. Тільки тести з файлів, які співпадають з патерном будуть відібрані для виконання. В залежності від вашого терміналу, вам може знадобитися додати лапки навколо цього аргументу: jest "my.*(complex)?pattern". На Windows вам потрібно буде використовувати / як роздільник шляхів або екранувати \` як \\`.

--bail[=<n>]​

Псевдонім: -b. Зупинити тестування негайно, коли n тестів упали. За замовчуванням 1.

--cache​

Чи використовувати кеш. За замовчуванням true. Вимкніть кеш, використовуючи --no-cache.

caution

Кеш варто відключати лише в тоді, коли ви маєте проблеми, пов’язані з кешем. В середньому, відключення кешу робить Jest щонайменше вдвічі повільнішим.

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

--changedFilesWithAncestor​

Запускає тести, пов'язані з поточними змінами та змінами, внесеними в останньому коміті. Поведінка аналогічна до --onlyChanged.

--changedSince​

Запускає тести, пов'язані зі змінами після наданого хеша гілки або коміту. Якщо поточна гілка виходить із даної гілки, то тестуються лише зміни, внесені локально. Поведінка аналогічна до --onlyChanged.

--ci​

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

--clearCache​

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

caution

Очищення кешу знизить продуктивність.

--clearMocks​

Автоматично очищує імітації викликів, екземплярів, контекстів і результатів перед кожним тестом. Equivalent to calling jest.clearAllMocks() before each test. This does not remove any mock implementation that may have been provided.

--collectCoverageFrom=<glob>​

Шаблон пошуку по масці відносний до rootDir, що підбирає файли, по яким потрібно збирати інформацію про покриття.

--colors​

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

note

Крім того, ви можете встановити змінну середовища FORCE_COLOR=true для примусового ввімкнення або FORCE_COLOR=false для вимкнення додавання кольорів до виводу. Використання FORCE_COLOR замінює всі інші перевірки підтримки кольорів.

--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. Вказує, що інформація про покриття тестами повинна збиратися і виводитися разом з результатами тестів. Необов'язково можна передати <boolean>, щоб перевизначити параметр, встановлений у конфігурації.

--coverageDirectory=<path>​

The directory where Jest should output its coverage files.

--coverageProvider=<provider>​

Вказує, який постачальник повинен використовуватися для перевірки покриття коду. Allowed values are babel (default) or 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. Implemented using 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.

--filter=<file>​

Path to a module exporting a filtering function. This asynchronous function receives a list of test paths which can be manipulated to exclude tests from running and must return an object with shape { filtered: Array<string> } containing the tests that should be run by Jest. Especially useful when used in conjunction with a testing infrastructure to filter known broken tests.

my-filter.js
// This filter when applied will only run tests ending in .spec.js (not the best way to do it, but it's just an example):
const filteringFunction = testPath => testPath.endsWith('.spec.js');

module.exports = testPaths => {
  const allowedPaths = testPaths.filter(filteringFunction); // ["path1.spec.js", "path2.spec.js", etc]

  return {
    filtered: allowedPaths,
  };
};

--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 примусово завершувати роботу після виконання всіх тестів. Це може бути корисно, якщо ресурси, підготовлені тестовим кодом, не можуть бути коректно очищені.

caution

Ця опція - це обхідний механізм. Якщо Jest не завершує роботу рісля виконання тестів, це значить, що зовнішні ресурси не звільнено або таймери очікують виконання у вашому коді. Рекомендується звільняти зовнішні ресурси після кожного тесту, щоб Jest міг коректно завершувати роботу. Ви можете використовувати --detectOpenHandles щоб відстежити такі випадки.

--help​

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

--ignoreProjects <project1> ... <projectN>​

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

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

Prints the test results in JSON. This mode will send all other test output and user messages to stderr.

--lastCommit​

Run all tests affected by file changes in the last commit made. Поведінка аналогічна до --onlyChanged.

--listTests​

Lists all test files that Jest will run given the arguments, and exits.

--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. Вказує максимальну кількість робочих процесів, які можуть бути створені під час виконання тестів. В одиничному режимі, це значення за замовчуванням дорівнює кількості ядер доступних на вашому комп'ютері мінус один для головного процесу. У режимі перегляду, це за замовчуванням половина доступних ядер на вашому комп’ютері для того, щоб Jest був ненав'язливим і не зупинив роботу вашої машини. Це може бути корисно в оточеннях з обмеженими ресурсами, таких, як CI, але значення за замовчуванням повинно бути адекватним для більшості випадків.

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

--noStackTrace​

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

--notify​

Activates native OS notifications for test results. Good for when you don't want your consciousness to be able to focus on anything except JavaScript testing. To display the notifications Jest needs the node-notifier package, which must be installed separately.

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

--onlyFailures​

Alias: -f. Run tests that failed in the previous execution.

--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. Значення 0 вимкне це попередження. За замовчуванням дорівнює 1000.

--outputFile=<filename>​

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

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

Якщо файли конфігурації знаходяться в зазначених шляхах, запустяться всі проєкти, вказані в цих файлах.

--randomize​

Перемішує порядок тестів всередині файлу. Перемішування базується на тестових даних. Детальніше в --seed=<num>.

Тестове значення відображується, коли встановлено цей параметр. Еквівалентно встановленню параметра командного рядка --showSeed.

jest --randomize --seed 1234
note

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

--reporters​

Run tests with specified reporters. Reporter options are not available via CLI. Example with multiple 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​

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. Це дозволяє їм уникнути перетворення в регулярний вираз і його порівняння з кожним файлом.

Для прикладу, візьмемо наступну файлову структуру:

__tests__
└── t1.test.js # test
└── t2.test.js # test

При запуску з шаблоном, жоден тест не знаходиться:

jest --runTestsByPath __tests__/t

Вивід:

No tests found

Однак, передача точного шляху призведе до виконання лише заданого тесту:

jest --runTestsByPath __tests__/t1.test.js

Вивід:

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

Встановлює тестові дані, які можна отримати в тестовому файлі за допомогою 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.

Jest uses the seed internally for shuffling the order in which test suites are run. If the --randomize option is used, the seed is also used for shuffling the order of tests within each describe block. When dealing with flaky tests, rerunning with the same seed might help reproduce the failure.

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

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

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

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

--showSeed​

Виводить тестові дані в підсумковому звіті про тестування. Детальніше в --seed=<num>.

Також можна встановити в конфігурації. 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.

note

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

порада

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

--testPathPatterns=<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​

Alias: -v. Print the version and exit.

--waitNextEventLoopTurnForUnhandledRejectionEvents​

Gives one event loop turn to handle rejectionHandled, uncaughtException or unhandledRejection.

Without this flag Jest may report false-positive errors (e.g. actually handled rejection reported) or not report actually unhandled rejection (or report it for different test case).

This option may add a noticeable overhead for fast test suites.

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

порада

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 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 --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. За замовчуванням true. Disable using --no-watchman.

--workerThreads​

Whether to use worker threads for parallelization. Child processes are used by default.

caution

This is experimental feature. See the workerThreads configuration option for more details.