{
"name": "jest",
"description": "A delightful JavaScript Testing Framework with a focus on simplicity",
"options": [
{
"names": [
"--bail",
"-b"
],
"description": "Exit the test suite immediately upon n number of failing test suite. Defaults to 1",
"takes_arg": true,
"arg": {
"name": "n"
}
},
{
"names": [
"--cache"
],
"description": "Whether to use the cache"
},
{
"names": [
"--no-cache"
],
"description": "Whether to use the cache"
},
{
"names": [
"--changedFilesWithAncestor"
],
"description": "Runs tests related to the current changes and the changes made in the last commit"
},
{
"names": [
"--changedSince"
],
"description": "Runs tests related to the changes since the provided branch or commit hash",
"takes_arg": true,
"arg": {
"name": "since"
}
},
{
"names": [
"--ci"
],
"description": "Instead of the regular behavior of storing a new snapshot automatically, will fail the test and require Jest to be run with --updateSnapshot"
},
{
"names": [
"--clearCache"
],
"description": "Deletes the Jest cache directory and then exits without running tests",
"takes_arg": true,
"arg": {
"name": "cacheDirectory"
}
},
{
"names": [
"--collectCoverageFrom"
],
"description": "A glob pattern relative to rootDir matching the files that coverage info needs to be collected from",
"takes_arg": true,
"arg": {
"name": "glob"
}
},
{
"names": [
"--colors"
],
"description": "Forces test results output highlighting even if stdout is not a TTY"
},
{
"names": [
"--config",
"-c"
],
"description": "The path to a Jest config file specifying how to find and execute tests",
"takes_arg": true,
"arg": {
"name": "path",
"template": "filepaths"
}
},
{
"names": [
"--coverage"
],
"description": "Enable or disable coverage, disabled by default",
"takes_arg": true,
"arg": {
"name": "true|false",
"suggestions": [
"true",
"false"
]
}
},
{
"names": [
"--coverageProvider"
],
"description": "Indicates which provider should be used to instrument code for coverage",
"takes_arg": true,
"arg": {
"name": "babel|v8",
"suggestions": [
"babel",
"v8"
]
}
},
{
"names": [
"--debug"
],
"description": "Print debugging info about your Jest config"
},
{
"names": [
"--detectOpenHandles"
],
"description": "Attempt to collect and print open handles preventing Jest from exiting cleanly"
},
{
"names": [
"--env"
],
"description": "The test environment used for all tests",
"takes_arg": true,
"arg": {
"name": "jsdom|node|path/to/env.js",
"suggestions": [
"jsdom",
"node"
],
"template": "filepaths"
}
},
{
"names": [
"--errorOnDeprecated"
],
"description": "Make calling deprecated APIs throw helpful error messages"
},
{
"names": [
"--expand",
"-e"
],
"description": "Use this flag to show full diffs and errors instead of a patch"
},
{
"names": [
"--findRelatedTests"
],
"description": "Find and run the tests that cover a space separated list of source files that were passed in as arguments",
"takes_arg": true,
"arg": {
"name": "<path1> ... <pathN>"
}
},
{
"names": [
"--forceExit"
],
"description": "Force Jest to exit after all tests have completed running"
},
{
"names": [
"--help"
],
"description": "Show the help information"
},
{
"names": [
"--init"
],
"description": "Generate a basic configuration file"
},
{
"names": [
"--injectGlobals"
],
"description": "Insert Jest's globals (expect, test, describe, beforeEach etc.) into the global environment"
},
{
"names": [
"--json"
],
"description": "Prints the test results in JSON"
},
{
"names": [
"--outputFile"
],
"description": "Write test results to a file when the --json option is also specified",
"takes_arg": true,
"arg": {
"name": "filename"
}
},
{
"names": [
"--lastCommit"
],
"description": "Run all tests affected by file changes in the last commit made"
},
{
"names": [
"--listTests"
],
"description": "Lists all tests as JSON that Jest will run given the arguments, and exits"
},
{
"names": [
"--logHeapUsage"
],
"description": "Logs the heap usage after every test"
},
{
"names": [
"--maxConcurrency"
],
"description": "Prevents Jest from executing more than the specified amount of tests at the same time",
"takes_arg": true,
"arg": {
"name": "num"
}
},
{
"names": [
"--maxWorkers",
"-w"
],
"description": "Specifies the maximum number of workers the worker-pool will spawn for running tests",
"takes_arg": true,
"arg": {
"name": "<num>|<string>"
}
},
{
"names": [
"--noStackTrace"
],
"description": "Disables stack trace in test results output"
},
{
"names": [
"--notify"
],
"description": "Activates notifications for test results"
},
{
"names": [
"--onlyChanged",
"-o"
],
"description": "Attempts to identify which tests to run based on which files have changed in the current repository"
},
{
"names": [
"--passWithNoTests"
],
"description": "Allows the test suite to pass when no files are found"
},
{
"names": [
"--projects"
],
"description": "Run tests from one or more projects, found in the specified paths; also takes path globs",
"takes_arg": true,
"arg": {
"name": "<path1> ... <pathN>",
"is_variadic": true,
"template": "filepaths"
}
},
{
"names": [
"--reporters"
],
"description": "Run tests with specified reporters",
"takes_arg": true,
"arg": {
"name": "reporter"
}
},
{
"names": [
"--roots"
],
"description": "A list of paths to directories that Jest should use to search for files in",
"takes_arg": true,
"arg": {
"name": "<path1> ... <pathN>",
"is_variadic": true,
"template": "folders"
}
},
{
"names": [
"--runInBand",
"-i"
],
"description": "Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests"
},
{
"names": [
"--selectProjects"
],
"description": "Run only the tests of the specified projects",
"takes_arg": true,
"arg": {
"name": "<project1> ... <projectN>"
}
},
{
"names": [
"--runTestsByPath"
],
"description": "Run only the tests that were specified with their exact paths"
},
{
"names": [
"--setupTestFrameworkScriptFile"
],
"description": "The path to a module that runs some code to configure or set up the testing framework before each test",
"takes_arg": true,
"arg": {
"name": "file",
"template": "filepaths"
}
},
{
"names": [
"--showConfig"
],
"description": "Print your Jest config and then exits"
},
{
"names": [
"--silent"
],
"description": "Prevent tests from printing messages through the console"
},
{
"names": [
"--testNamePattern",
"-t"
],
"description": "Run only tests with a name that matches the regex",
"takes_arg": true,
"arg": {
"name": "regex"
}
},
{
"names": [
"--testLocationInResults"
],
"description": "Adds a location field to test results"
},
{
"names": [
"--testPathPattern"
],
"description": "A regexp pattern string that is matched against all tests paths before executing the test",
"takes_arg": true,
"arg": {
"name": "regex"
}
},
{
"names": [
"--testPathIgnorePatterns"
],
"description": "An array of regexp pattern strings that are tested against all tests paths before executing the test",
"takes_arg": true,
"arg": {
"name": "[array]"
}
},
{
"names": [
"--testRunner"
],
"description": "Lets you specify a custom test runner",
"takes_arg": true,
"arg": {
"name": "path",
"template": "filepaths"
}
},
{
"names": [
"--testSequencer"
],
"description": "Lets you specify a custom test sequencer",
"takes_arg": true,
"arg": {
"name": "path",
"template": "filepaths"
}
},
{
"names": [
"--testTimeout"
],
"description": "Default timeout of a test in milliseconds",
"takes_arg": true,
"arg": {
"name": "timeout in ms"
}
},
{
"names": [
"--updateSnapshot",
"-u"
],
"description": "Use this flag to re-record every snapshot that fails during this test run"
},
{
"names": [
"--useStderr"
],
"description": "Divert all output to stderr"
},
{
"names": [
"--verbose"
],
"description": "Display individual test results with the test suite hierarchy"
},
{
"names": [
"--version",
"-v"
],
"description": "Print the version and exit"
},
{
"names": [
"--watch"
],
"description": "Watch files for changes and rerun tests related to changed files"
},
{
"names": [
"--watchAll"
],
"description": "Watch files for changes and rerun all tests when something changes"
},
{
"names": [
"--watchman"
],
"description": "Whether to use watchman for file crawling"
},
{
"names": [
"--no-watchman"
],
"description": "Whether to use watchman for file crawling"
}
]
}