Version: 27.1

Jest CLI 选项

jest 命令行运行器拥有诸多有用的选项。 运行jest --help可以查看所有可用的选项 下面所示选项都可一起使用，以你想要的方式来运行测试。 下面所示选项都可一起使用，以你想要的方式来运行测试。 每一条 Jest 的 配置选项 都可以通过命令行来指定.

大致简述如下：

在命令行运行

运行所有测试(默认)

<code>jest</code>

监视模式还能够指定名称或文件路径，从而运行特定的一组测试。

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

仅运行符合指定用模板或文件名的测试︰

jest -o

运行基于 hg/git (未提交的文件) 修改的文件的测试︰

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

运行类似 path/to/fileA.js 和 path/to/fileB.js的测试︰

jest -t name-of-spec

运行匹配特定名称的测试用例(主要是匹配 describe 或 test的名称)。

jest --watch #runs jest -o by default
jest --watchAll #runs all tests

运行监视模式︰

Using with yarn

If you run Jest via yarn test, you can pass the command line arguments directly as Jest arguments.

Instead of:

jest -u -t="ColorPicker"

现在你可以使用

yarn test -u -t="ColorPicker"

使用npm脚本

If you run Jest via npm test, you can still use the command line arguments by inserting a -- between npm test and the Jest arguments.

Instead of:

jest -u -t="ColorPicker"

现在你可以使用

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

Camelcase & dashed args support

Jest supports both camelcase and dashed arg formats. The following examples will have an equal result: The following examples will have an equal result:

jest --collect-coverage
jest --collectCoverage

Arguments can also be mixed:

jest --update-snapshot --detectOpenHandles

Options

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

• jest
• --bail
• --cache
• --changedFilesWithAncestor
• --changedSince
• --ci
• --clearCache
• --collectCoverageFrom=
• --colors
• --config=
• --coverage[=]
• --coverageProvider=
• --debug
• --detectOpenHandles
• --env=
• --errorOnDeprecated
• --expand
• --filter=
• --findRelatedTests
• --forceExit
• --help
• --init
• --injectGlobals
• --json
• --outputFile=
• --lastCommit
• --listTests
• --logHeapUsage
• --maxConcurrency=
• --maxWorkers=|
• --noStackTrace
• --notify
• --onlyChanged
• --passWithNoTests
• --projects …
• --reporters
• --roots
• --runInBand
• --selectProjects …
• --runTestsByPath
• --setupFilesAfterEnv …
• --showConfig
• --silent
• --testNamePattern=
• --testLocationInResults
• --testPathPattern=
• --testPathIgnorePatterns=|[array]
• --testRunner=
• --testSequencer=
• --testTimeout=
• --updateSnapshot
• --useStderr
• --verbose
• --version
• --watch
• --watchAll
• --watchman

Reference

jest <regexForTestFiles>

当你在运行 jest时附加参数，参数会以正则表达式来匹配项目中的文件。 可通过提供的模式来运行测试。 只会选择并运行匹配模式的测试文件。 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`. On Windows, you will need to use / as a path separator or escape \ as \\.

--bail

Alias: -b. Alias: -b. Exit the test suite immediately upon n number of failing test suite. Defaults to 1. 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. 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. 与 --onlyChanged 的行为相似。

--changedSince

Runs tests related to the changes since the provided branch or commit hash. 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. 与 --onlyChanged 的行为相似。 与 --onlyChanged 的行为相似。

--ci

指定该参数时，Jest会认为正在CI环境上运行。 当遇到新的快照时，这会改变原来的行为。 不再是自动的保存新的快照，取而代之的是，它会将测试标记失败，并要求运行Jest时增加--updateSnapshot参数。

--clearCache

删除 Jest 的缓存目录, 然后不运行测试直接退出。 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. * 注意：清除缓存将降低性能。 The default cache directory can be found by calling jest --showConfig. 注意：清除缓存将降低性能。

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

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

--env=<environment>

所有测试都使用该测试环境设定。 可以指向任何文件或者node模块。 例如jsdom, node or path/to/my-environment.js

--errorOnDeprecated

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

--expand

别名︰ -e。 使用该参数来对比完整的差异和错误，而非修复。

--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. 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在所有测试运行完后退出。 对于一些由测试所生成但无法充分清理的资源来说，这是很有用的。 注意︰ 此功能是escape-hatch。 如果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.

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

以JSON模式显示测试结果。 该模式会包其他所有测试和用户信息都发送到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. 与 --onlyChanged 的行为相似。

--listTests

通过JSON的形式列出所有将要运行的测试并退出. 与--findRelatedTests 一起使用可以知道那个测试将要运行 This can be used together with --findRelatedTests to know which tests Jest will run.

--logHeapUsage

记录每个测试后的记录堆使用情况。 主要用来调试内存泄漏。 与 --runInBand 和 --expose-gc一起使用.

--maxConcurrency=<num>

Prevents Jest from executing more than the specified amount of tests at the same time. 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 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. 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. 特别是当你不想专心致志等待 JavaScript 测试结果时。

--onlyChanged

或: -o. 尝试确定根据当前存储库中哪些已经更改的文件来运行的测试。 只有在此刻 git/hg 存储库中运行测试，需要静态依赖关系图时有用（例如. 无动态要求）。

--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. 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. Run tests with specified reporters. Reporter options are not available via CLI. Example with multiple reporters: 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. 或: -i. 仅在当前的进程中连续运行所有测试，而非通过创建的子进程的工作池来运行测试。 This can be useful for debugging.

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

Run only the tests of the specified projects. 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. If you use this option, you should provide a displayName to all your projects.

--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 This option replaces the regex matching logic and by that optimizes the time it takes Jest to filter specific test files

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

输出Jest配置，然后退出。

--silent

阻止所有测试通过控制台输出信息。

--testNamePattern=<regex>

别名︰ -t。 Run only tests with a name that matches the regex. 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. Useful if you want to report the location of a test in a reporter.

请注意 column 是从 0 开始，而 line 不是。

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

--testPathPattern=<regex>

在运行测试前，匹配的regexp模式字符串的测试文件路径。 On Windows, you will need to use / as a path separator or escape \ as \\.

--testPathIgnorePatterns=<regex>|[array]

A single or array of regexp pattern strings that are tested against all tests paths before executing the test. 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.

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

监视文件更改，并重新运行与已更改的文件相关的测试。 当文件发生更改时，如果你想要重新运行所有测试，可以使用 --watchAll 选项。

--watchAll

监视文件的更改并在任何更改时重新运行所有测试。 若果你是想要重新运行仅基于已更改文件的测试，那么请使用 --watch 选项。

Use --watchAll=false to explicitly disable the watch mode. Note that in most CI environments, this is automatically handled for you. 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.