UNPKG

15.7 kBTypeScriptView Raw
1/**
2 * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
3 *
4 * This source code is licensed under the MIT license found in the
5 * LICENSE file in the root directory of this source tree.
6 */
7import type { Config } from '@jest/types';
8export declare function check(argv: Config.Argv): true;
9export declare const usage = "Usage: $0 [--config=<pathToConfigFile>] [TestPathPattern]";
10export declare const docs = "Documentation: https://jestjs.io/";
11export declare const options: {
12 readonly all: {
13 readonly default: undefined;
14 readonly description: string;
15 readonly type: "boolean";
16 };
17 readonly automock: {
18 readonly default: undefined;
19 readonly description: "Automock all files by default.";
20 readonly type: "boolean";
21 };
22 readonly bail: {
23 readonly alias: "b";
24 readonly default: undefined;
25 readonly description: "Exit the test suite immediately after `n` number of failing tests.";
26 readonly type: "boolean";
27 };
28 readonly browser: {
29 readonly default: undefined;
30 readonly description: string;
31 readonly type: "boolean";
32 };
33 readonly cache: {
34 readonly default: undefined;
35 readonly description: string;
36 readonly type: "boolean";
37 };
38 readonly cacheDirectory: {
39 readonly description: string;
40 readonly type: "string";
41 };
42 readonly changedFilesWithAncestor: {
43 readonly default: undefined;
44 readonly description: string;
45 readonly type: "boolean";
46 };
47 readonly changedSince: {
48 readonly description: string;
49 readonly nargs: 1;
50 readonly type: "string";
51 };
52 readonly ci: {
53 readonly default: boolean;
54 readonly description: string;
55 readonly type: "boolean";
56 };
57 readonly clearCache: {
58 readonly default: undefined;
59 readonly description: string;
60 readonly type: "boolean";
61 };
62 readonly clearMocks: {
63 readonly default: undefined;
64 readonly description: string;
65 readonly type: "boolean";
66 };
67 readonly collectCoverage: {
68 readonly default: undefined;
69 readonly description: "Alias for --coverage.";
70 readonly type: "boolean";
71 };
72 readonly collectCoverageFrom: {
73 readonly description: string;
74 readonly type: "string";
75 };
76 readonly collectCoverageOnlyFrom: {
77 readonly description: "Explicit list of paths coverage will be restricted to.";
78 readonly string: true;
79 readonly type: "array";
80 };
81 readonly color: {
82 readonly default: undefined;
83 readonly description: string;
84 readonly type: "boolean";
85 };
86 readonly colors: {
87 readonly default: undefined;
88 readonly description: "Alias for `--color`.";
89 readonly type: "boolean";
90 };
91 readonly config: {
92 readonly alias: "c";
93 readonly description: string;
94 readonly type: "string";
95 };
96 readonly coverage: {
97 readonly default: undefined;
98 readonly description: string;
99 readonly type: "boolean";
100 };
101 readonly coverageDirectory: {
102 readonly description: "The directory where Jest should output its coverage files.";
103 readonly type: "string";
104 };
105 readonly coveragePathIgnorePatterns: {
106 readonly description: string;
107 readonly string: true;
108 readonly type: "array";
109 };
110 readonly coverageProvider: {
111 readonly choices: readonly ["babel", "v8"];
112 readonly description: "Select between Babel and V8 to collect coverage";
113 };
114 readonly coverageReporters: {
115 readonly description: string;
116 readonly string: true;
117 readonly type: "array";
118 };
119 readonly coverageThreshold: {
120 readonly description: string;
121 readonly type: "string";
122 };
123 readonly debug: {
124 readonly default: undefined;
125 readonly description: "Print debugging info about your jest config.";
126 readonly type: "boolean";
127 };
128 readonly detectLeaks: {
129 readonly default: false;
130 readonly description: string;
131 readonly type: "boolean";
132 };
133 readonly detectOpenHandles: {
134 readonly default: false;
135 readonly description: string;
136 readonly type: "boolean";
137 };
138 readonly env: {
139 readonly description: string;
140 readonly type: "string";
141 };
142 readonly errorOnDeprecated: {
143 readonly default: false;
144 readonly description: "Make calling deprecated APIs throw helpful error messages.";
145 readonly type: "boolean";
146 };
147 readonly expand: {
148 readonly alias: "e";
149 readonly default: undefined;
150 readonly description: "Use this flag to show full diffs instead of a patch.";
151 readonly type: "boolean";
152 };
153 readonly filter: {
154 readonly default: undefined;
155 readonly description: string;
156 readonly type: "string";
157 };
158 readonly findRelatedTests: {
159 readonly default: undefined;
160 readonly description: string;
161 readonly type: "boolean";
162 };
163 readonly forceExit: {
164 readonly default: undefined;
165 readonly description: string;
166 readonly type: "boolean";
167 };
168 readonly globalSetup: {
169 readonly description: "The path to a module that runs before All Tests.";
170 readonly type: "string";
171 };
172 readonly globalTeardown: {
173 readonly description: "The path to a module that runs after All Tests.";
174 readonly type: "string";
175 };
176 readonly globals: {
177 readonly description: string;
178 readonly type: "string";
179 };
180 readonly haste: {
181 readonly description: "A JSON string with map of variables for the haste module system";
182 readonly type: "string";
183 };
184 readonly init: {
185 readonly description: "Generate a basic configuration file";
186 readonly type: "boolean";
187 };
188 readonly json: {
189 readonly default: undefined;
190 readonly description: string;
191 readonly type: "boolean";
192 };
193 readonly lastCommit: {
194 readonly default: undefined;
195 readonly description: string;
196 readonly type: "boolean";
197 };
198 readonly listTests: {
199 readonly default: false;
200 readonly description: string;
201 readonly type: "boolean";
202 };
203 readonly logHeapUsage: {
204 readonly default: undefined;
205 readonly description: string;
206 readonly type: "boolean";
207 };
208 readonly mapCoverage: {
209 readonly default: undefined;
210 readonly description: string;
211 readonly type: "boolean";
212 };
213 readonly maxConcurrency: {
214 readonly default: 5;
215 readonly description: string;
216 readonly type: "number";
217 };
218 readonly maxWorkers: {
219 readonly alias: "w";
220 readonly description: string;
221 readonly type: "string";
222 };
223 readonly moduleDirectories: {
224 readonly description: string;
225 readonly string: true;
226 readonly type: "array";
227 };
228 readonly moduleFileExtensions: {
229 readonly description: string;
230 readonly string: true;
231 readonly type: "array";
232 };
233 readonly moduleNameMapper: {
234 readonly description: string;
235 readonly type: "string";
236 };
237 readonly modulePathIgnorePatterns: {
238 readonly description: string;
239 readonly string: true;
240 readonly type: "array";
241 };
242 readonly modulePaths: {
243 readonly description: string;
244 readonly string: true;
245 readonly type: "array";
246 };
247 readonly noStackTrace: {
248 readonly default: undefined;
249 readonly description: "Disables stack trace in test results output";
250 readonly type: "boolean";
251 };
252 readonly notify: {
253 readonly default: undefined;
254 readonly description: "Activates notifications for test results.";
255 readonly type: "boolean";
256 };
257 readonly notifyMode: {
258 readonly default: "failure-change";
259 readonly description: "Specifies when notifications will appear for test results.";
260 readonly type: "string";
261 };
262 readonly onlyChanged: {
263 readonly alias: "o";
264 readonly default: undefined;
265 readonly description: string;
266 readonly type: "boolean";
267 };
268 readonly onlyFailures: {
269 readonly alias: "f";
270 readonly default: undefined;
271 readonly description: "Run tests that failed in the previous execution.";
272 readonly type: "boolean";
273 };
274 readonly outputFile: {
275 readonly description: string;
276 readonly type: "string";
277 };
278 readonly passWithNoTests: {
279 readonly default: false;
280 readonly description: "Will not fail if no tests are found (for example while using `--testPathPattern`.)";
281 readonly type: "boolean";
282 };
283 readonly preset: {
284 readonly description: "A preset that is used as a base for Jest's configuration.";
285 readonly type: "string";
286 };
287 readonly prettierPath: {
288 readonly default: undefined;
289 readonly description: "The path to the \"prettier\" module used for inline snapshots.";
290 readonly type: "string";
291 };
292 readonly projects: {
293 readonly description: string;
294 readonly string: true;
295 readonly type: "array";
296 };
297 readonly reporters: {
298 readonly description: "A list of custom reporters for the test suite.";
299 readonly string: true;
300 readonly type: "array";
301 };
302 readonly resetMocks: {
303 readonly default: undefined;
304 readonly description: string;
305 readonly type: "boolean";
306 };
307 readonly resetModules: {
308 readonly default: undefined;
309 readonly description: string;
310 readonly type: "boolean";
311 };
312 readonly resolver: {
313 readonly description: "A JSON string which allows the use of a custom resolver.";
314 readonly type: "string";
315 };
316 readonly restoreMocks: {
317 readonly default: undefined;
318 readonly description: string;
319 readonly type: "boolean";
320 };
321 readonly rootDir: {
322 readonly description: string;
323 readonly type: "string";
324 };
325 readonly roots: {
326 readonly description: string;
327 readonly string: true;
328 readonly type: "array";
329 };
330 readonly runInBand: {
331 readonly alias: "i";
332 readonly default: undefined;
333 readonly description: string;
334 readonly type: "boolean";
335 };
336 readonly runTestsByPath: {
337 readonly default: false;
338 readonly description: string;
339 readonly type: "boolean";
340 };
341 readonly runner: {
342 readonly description: "Allows to use a custom runner instead of Jest's default test runner.";
343 readonly type: "string";
344 };
345 readonly setupFiles: {
346 readonly description: string;
347 readonly string: true;
348 readonly type: "array";
349 };
350 readonly setupFilesAfterEnv: {
351 readonly description: string;
352 readonly string: true;
353 readonly type: "array";
354 };
355 readonly showConfig: {
356 readonly default: undefined;
357 readonly description: "Print your jest config and then exits.";
358 readonly type: "boolean";
359 };
360 readonly silent: {
361 readonly default: undefined;
362 readonly description: "Prevent tests from printing messages through the console.";
363 readonly type: "boolean";
364 };
365 readonly skipFilter: {
366 readonly default: undefined;
367 readonly description: string;
368 readonly type: "boolean";
369 };
370 readonly snapshotSerializers: {
371 readonly description: string;
372 readonly string: true;
373 readonly type: "array";
374 };
375 readonly testEnvironment: {
376 readonly description: "Alias for --env";
377 readonly type: "string";
378 };
379 readonly testEnvironmentOptions: {
380 readonly description: string;
381 readonly type: "string";
382 };
383 readonly testFailureExitCode: {
384 readonly description: "Exit code of `jest` command if the test run failed";
385 readonly type: "string";
386 };
387 readonly testLocationInResults: {
388 readonly default: false;
389 readonly description: "Add `location` information to the test results";
390 readonly type: "boolean";
391 };
392 readonly testMatch: {
393 readonly description: "The glob patterns Jest uses to detect test files.";
394 readonly string: true;
395 readonly type: "array";
396 };
397 readonly testNamePattern: {
398 readonly alias: "t";
399 readonly description: "Run only tests with a name that matches the regex pattern.";
400 readonly type: "string";
401 };
402 readonly testPathIgnorePatterns: {
403 readonly description: string;
404 readonly string: true;
405 readonly type: "array";
406 };
407 readonly testPathPattern: {
408 readonly description: string;
409 readonly string: true;
410 readonly type: "array";
411 };
412 readonly testRegex: {
413 readonly description: "A string or array of string regexp patterns that Jest uses to detect test files.";
414 readonly string: true;
415 readonly type: "array";
416 };
417 readonly testResultsProcessor: {
418 readonly description: string;
419 readonly type: "string";
420 };
421 readonly testRunner: {
422 readonly description: string;
423 readonly type: "string";
424 };
425 readonly testSequencer: {
426 readonly description: string;
427 readonly type: "string";
428 };
429 readonly testTimeout: {
430 readonly description: "This option sets the default timeouts of test cases.";
431 readonly type: "number";
432 };
433 readonly testURL: {
434 readonly description: "This option sets the URL for the jsdom environment.";
435 readonly type: "string";
436 };
437 readonly timers: {
438 readonly description: string;
439 readonly type: "string";
440 };
441 readonly transform: {
442 readonly description: string;
443 readonly type: "string";
444 };
445 readonly transformIgnorePatterns: {
446 readonly description: string;
447 readonly string: true;
448 readonly type: "array";
449 };
450 readonly unmockedModulePathPatterns: {
451 readonly description: string;
452 readonly string: true;
453 readonly type: "array";
454 };
455 readonly updateSnapshot: {
456 readonly alias: "u";
457 readonly default: undefined;
458 readonly description: string;
459 readonly type: "boolean";
460 };
461 readonly useStderr: {
462 readonly default: undefined;
463 readonly description: "Divert all output to stderr.";
464 readonly type: "boolean";
465 };
466 readonly verbose: {
467 readonly default: undefined;
468 readonly description: "Display individual test results with the test suite hierarchy.";
469 readonly type: "boolean";
470 };
471 readonly version: {
472 readonly alias: "v";
473 readonly default: undefined;
474 readonly description: "Print the version and exit";
475 readonly type: "boolean";
476 };
477 readonly watch: {
478 readonly default: undefined;
479 readonly description: string;
480 readonly type: "boolean";
481 };
482 readonly watchAll: {
483 readonly default: undefined;
484 readonly description: string;
485 readonly type: "boolean";
486 };
487 readonly watchPathIgnorePatterns: {
488 readonly description: string;
489 readonly string: true;
490 readonly type: "array";
491 };
492 readonly watchman: {
493 readonly default: undefined;
494 readonly description: string;
495 readonly type: "boolean";
496 };
497};