args.d.ts 13.7 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
/**
 * 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 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";
    };
};