Опції командного рядка
Командний рядок 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 # запускає "jest -o" за замовчуванням
jest --watchAll # запускає всі тести
Режим спостереження також дозволяє вказувати ім’я або шлях до файлу, щоб сфокусуватися на певному наборі тестів.
Використання з 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 підтримує аргументи в верблюдячому та шашличному регістрах. Наступні приклади матимуть однаковий результат:
jest --collect-coverage
jest --collectCoverage
Аргументи також можуть бути змішаними:
jest --update-snapshot --detectOpenHandles
Параметри
Параметри командного рядка мають перевагу над параметрами, вказаними в конфігурації.
- Використання з npm скриптами
- Підтримка регістрів
- Параметри
- Довідка
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
--init
--injectGlobals
--json
--lastCommit
--listTests
--logHeapUsage
--maxConcurrency=<num>
--maxWorkers=<num>|<string>
--noStackTrace
--notify
--onlyChanged
--outputFile=<filename>
--passWithNoTests
--projects <path1> ... <pathN>
--reporters
--resetMocks
--restoreMocks
--roots
--runInBand
--runTestsByPath
--selectProjects <project1> ... <projectN>
--setupFilesAfterEnv <path1> ... <pathN>
--showConfig
--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
Довідка
jest <regexForTestFiles>
У випадку запуску jest
з аргументом, цей аргумент розглядається як регулярний вираз та порівнюється з файлами у проекті. Існує можливість запускати набори тестів, вказуючи патерн. Тільки тести з файлів, які співпадають з патерном будуть відібрані для виконання. В залежності від вашого терміналу, вам може знадобитися додати лапки навколо цього аргументу: jest "my.*(complex)?pattern"
. On Windows, you will need to use /
as a path separator or escape \
as \\
.
--bail[=<n>]
Псевдонім: -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
.
Очищення кешу знизить продуктивність.
--clearMocks
Automatically clear mock calls, instances 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>
Шаблон пошуку по масці відносний до rootDir
, що підбирає файли, по яким потрібно збирати інформацію про покриття.
--colors
Примушує додавати кольори до виводу результатів тестів, навіть коли stdout не TTY.
Крім того, ви можете встановити змінну середовища 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
. Вказує, що інформація про покриття тестами повинна збиратися і виводитися разом з результатами тестів. Optionally pass <boolean>
to override option set in configuration.
--coverageDirectory=<path>
The directory where Jest should output its coverage files.
--coverageProvider=<provider>
Indicates which provider should be used to instrument code for coverage. Allowed values are babel
(default) or v8
.
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>
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 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>
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 міг коректно завершувати роботу. Ви можете використовувати --detectOpenHandles
щоб відстежити такі випадки.
--help
Відобразити довідку, схожу на цю сторінку.
--init
Згенеруйте основний файл конфігурації. 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);
});
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
. Вказує максимальну кількість робочих процесів, які можуть бути створені під час виконання тестів. 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
Activates notifications for test results. 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).
--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.
Якщо файли конфігурації знаходяться в зазначених шляхах, запустяться всі проєкти, вказані в цих файлах.
--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.
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.
--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.
--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.
--showConfig
Забороняє тестам виводити повідомлення в консоль.
--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
. Run only tests with a name that matches the regex. Наприклад, припустимо, ви хочете запустити лише тести, пов'язані з авторизацією, які матимуть назви типу 'GET /api/posts with auth'
, то можна використати 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>
Регулярний вираз, який порівнюється зі шляхом до файла з тестами перед його запуском. On Windows, you will need to use /
as a path separator or escape \
as \\
.
--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
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.
Використовуйте --no-watch
(або --watch=false
) для явного вимкнення режиму спостереження, якщо його було ввімкнено за допомогою --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.
Використовуйте --no-watchAll
(або --watchAll=false
) для явного вимкнення режиму спостереження, якщо його було ввімкнено за допомогою --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
.