123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452 |
- /**
- * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
- import type { Config } from '@jest/types';
- export declare function check(argv: Config.Argv): true;
- export declare const usage = "Usage: $0 [--config=<pathToConfigFile>] [TestPathPattern]";
- export declare const docs = "Documentation: https://jestjs.io/";
- export declare const options: {
- readonly all: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly automock: {
- readonly description: "Automock all files by default.";
- readonly type: "boolean";
- };
- readonly bail: {
- readonly alias: "b";
- readonly description: "Exit the test suite immediately after `n` number of failing tests.";
- readonly type: "boolean";
- };
- readonly browser: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly cache: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly cacheDirectory: {
- readonly description: string;
- readonly type: "string";
- };
- readonly changedFilesWithAncestor: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly changedSince: {
- readonly description: string;
- readonly nargs: 1;
- readonly type: "string";
- };
- readonly ci: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly clearCache: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly clearMocks: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly collectCoverage: {
- readonly description: "Alias for --coverage.";
- readonly type: "boolean";
- };
- readonly collectCoverageFrom: {
- readonly description: string;
- readonly type: "string";
- };
- readonly collectCoverageOnlyFrom: {
- readonly description: "Explicit list of paths coverage will be restricted to.";
- readonly string: true;
- readonly type: "array";
- };
- readonly color: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly colors: {
- readonly description: "Alias for `--color`.";
- readonly type: "boolean";
- };
- readonly config: {
- readonly alias: "c";
- readonly description: string;
- readonly type: "string";
- };
- readonly coverage: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly coverageDirectory: {
- readonly description: "The directory where Jest should output its coverage files.";
- readonly type: "string";
- };
- readonly coveragePathIgnorePatterns: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly coverageProvider: {
- readonly choices: readonly ["babel", "v8"];
- readonly description: "Select between Babel and V8 to collect coverage";
- };
- readonly coverageReporters: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly coverageThreshold: {
- readonly description: string;
- readonly type: "string";
- };
- readonly debug: {
- readonly description: "Print debugging info about your jest config.";
- readonly type: "boolean";
- };
- readonly detectLeaks: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly detectOpenHandles: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly env: {
- readonly description: string;
- readonly type: "string";
- };
- readonly errorOnDeprecated: {
- readonly description: "Make calling deprecated APIs throw helpful error messages.";
- readonly type: "boolean";
- };
- readonly expand: {
- readonly alias: "e";
- readonly description: "Use this flag to show full diffs instead of a patch.";
- readonly type: "boolean";
- };
- readonly filter: {
- readonly description: string;
- readonly type: "string";
- };
- readonly findRelatedTests: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly forceExit: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly globalSetup: {
- readonly description: "The path to a module that runs before All Tests.";
- readonly type: "string";
- };
- readonly globalTeardown: {
- readonly description: "The path to a module that runs after All Tests.";
- readonly type: "string";
- };
- readonly globals: {
- readonly description: string;
- readonly type: "string";
- };
- readonly haste: {
- readonly description: "A JSON string with map of variables for the haste module system";
- readonly type: "string";
- };
- readonly init: {
- readonly description: "Generate a basic configuration file";
- readonly type: "boolean";
- };
- readonly injectGlobals: {
- readonly description: "Should Jest inject global variables or not";
- readonly type: "boolean";
- };
- readonly json: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly lastCommit: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly listTests: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly logHeapUsage: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly maxConcurrency: {
- readonly description: string;
- readonly type: "number";
- };
- readonly maxWorkers: {
- readonly alias: "w";
- readonly description: string;
- readonly type: "string";
- };
- readonly moduleDirectories: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly moduleFileExtensions: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly moduleNameMapper: {
- readonly description: string;
- readonly type: "string";
- };
- readonly modulePathIgnorePatterns: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly modulePaths: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly noStackTrace: {
- readonly description: "Disables stack trace in test results output";
- readonly type: "boolean";
- };
- readonly notify: {
- readonly description: "Activates notifications for test results.";
- readonly type: "boolean";
- };
- readonly notifyMode: {
- readonly description: "Specifies when notifications will appear for test results.";
- readonly type: "string";
- };
- readonly onlyChanged: {
- readonly alias: "o";
- readonly description: string;
- readonly type: "boolean";
- };
- readonly onlyFailures: {
- readonly alias: "f";
- readonly description: "Run tests that failed in the previous execution.";
- readonly type: "boolean";
- };
- readonly outputFile: {
- readonly description: string;
- readonly type: "string";
- };
- readonly passWithNoTests: {
- readonly description: "Will not fail if no tests are found (for example while using `--testPathPattern`.)";
- readonly type: "boolean";
- };
- readonly preset: {
- readonly description: "A preset that is used as a base for Jest's configuration.";
- readonly type: "string";
- };
- readonly prettierPath: {
- readonly description: "The path to the \"prettier\" module used for inline snapshots.";
- readonly type: "string";
- };
- readonly projects: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly reporters: {
- readonly description: "A list of custom reporters for the test suite.";
- readonly string: true;
- readonly type: "array";
- };
- readonly resetMocks: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly resetModules: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly resolver: {
- readonly description: "A JSON string which allows the use of a custom resolver.";
- readonly type: "string";
- };
- readonly restoreMocks: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly rootDir: {
- readonly description: string;
- readonly type: "string";
- };
- readonly roots: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly runInBand: {
- readonly alias: "i";
- readonly description: string;
- readonly type: "boolean";
- };
- readonly runTestsByPath: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly runner: {
- readonly description: "Allows to use a custom runner instead of Jest's default test runner.";
- readonly type: "string";
- };
- readonly selectProjects: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly setupFiles: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly setupFilesAfterEnv: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly showConfig: {
- readonly description: "Print your jest config and then exits.";
- readonly type: "boolean";
- };
- readonly silent: {
- readonly description: "Prevent tests from printing messages through the console.";
- readonly type: "boolean";
- };
- readonly skipFilter: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly snapshotSerializers: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly testEnvironment: {
- readonly description: "Alias for --env";
- readonly type: "string";
- };
- readonly testEnvironmentOptions: {
- readonly description: string;
- readonly type: "string";
- };
- readonly testFailureExitCode: {
- readonly description: "Exit code of `jest` command if the test run failed";
- readonly type: "string";
- };
- readonly testLocationInResults: {
- readonly description: "Add `location` information to the test results";
- readonly type: "boolean";
- };
- readonly testMatch: {
- readonly description: "The glob patterns Jest uses to detect test files.";
- readonly string: true;
- readonly type: "array";
- };
- readonly testNamePattern: {
- readonly alias: "t";
- readonly description: "Run only tests with a name that matches the regex pattern.";
- readonly type: "string";
- };
- readonly testPathIgnorePatterns: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly testPathPattern: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly testRegex: {
- readonly description: "A string or array of string regexp patterns that Jest uses to detect test files.";
- readonly string: true;
- readonly type: "array";
- };
- readonly testResultsProcessor: {
- readonly description: string;
- readonly type: "string";
- };
- readonly testRunner: {
- readonly description: string;
- readonly type: "string";
- };
- readonly testSequencer: {
- readonly description: string;
- readonly type: "string";
- };
- readonly testTimeout: {
- readonly description: "This option sets the default timeouts of test cases.";
- readonly type: "number";
- };
- readonly testURL: {
- readonly description: "This option sets the URL for the jsdom environment.";
- readonly type: "string";
- };
- readonly timers: {
- readonly description: string;
- readonly type: "string";
- };
- readonly transform: {
- readonly description: string;
- readonly type: "string";
- };
- readonly transformIgnorePatterns: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly unmockedModulePathPatterns: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly updateSnapshot: {
- readonly alias: "u";
- readonly description: string;
- readonly type: "boolean";
- };
- readonly useStderr: {
- readonly description: "Divert all output to stderr.";
- readonly type: "boolean";
- };
- readonly verbose: {
- readonly description: "Display individual test results with the test suite hierarchy.";
- readonly type: "boolean";
- };
- readonly version: {
- readonly alias: "v";
- readonly description: "Print the version and exit";
- readonly type: "boolean";
- };
- readonly watch: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly watchAll: {
- readonly description: string;
- readonly type: "boolean";
- };
- readonly watchPathIgnorePatterns: {
- readonly description: string;
- readonly string: true;
- readonly type: "array";
- };
- readonly watchman: {
- readonly description: string;
- readonly type: "boolean";
- };
- };
|