Descriptions.js 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. 'use strict';
  2. Object.defineProperty(exports, '__esModule', {
  3. value: true
  4. });
  5. exports.default = void 0;
  6. /**
  7. * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
  8. *
  9. * This source code is licensed under the MIT license found in the
  10. * LICENSE file in the root directory of this source tree.
  11. */
  12. const descriptions = {
  13. automock: 'All imported modules in your tests should be mocked automatically',
  14. bail: 'Stop running tests after `n` failures',
  15. cacheDirectory:
  16. 'The directory where Jest should store its cached dependency information',
  17. clearMocks:
  18. 'Automatically clear mock calls, instances and results before every test',
  19. collectCoverage:
  20. 'Indicates whether the coverage information should be collected while executing the test',
  21. collectCoverageFrom:
  22. 'An array of glob patterns indicating a set of files for which coverage information should be collected',
  23. coverageDirectory:
  24. 'The directory where Jest should output its coverage files',
  25. coveragePathIgnorePatterns:
  26. 'An array of regexp pattern strings used to skip coverage collection',
  27. coverageProvider:
  28. 'Indicates which provider should be used to instrument code for coverage',
  29. coverageReporters:
  30. 'A list of reporter names that Jest uses when writing coverage reports',
  31. coverageThreshold:
  32. 'An object that configures minimum threshold enforcement for coverage results',
  33. dependencyExtractor: 'A path to a custom dependency extractor',
  34. errorOnDeprecated:
  35. 'Make calling deprecated APIs throw helpful error messages',
  36. forceCoverageMatch:
  37. 'Force coverage collection from ignored files using an array of glob patterns',
  38. globalSetup:
  39. 'A path to a module which exports an async function that is triggered once before all test suites',
  40. globalTeardown:
  41. 'A path to a module which exports an async function that is triggered once after all test suites',
  42. globals:
  43. 'A set of global variables that need to be available in all test environments',
  44. maxWorkers:
  45. 'The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.',
  46. moduleDirectories:
  47. "An array of directory names to be searched recursively up from the requiring module's location",
  48. moduleFileExtensions: 'An array of file extensions your modules use',
  49. moduleNameMapper:
  50. 'A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module',
  51. modulePathIgnorePatterns:
  52. "An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader",
  53. notify: 'Activates notifications for test results',
  54. notifyMode:
  55. 'An enum that specifies notification mode. Requires { notify: true }',
  56. preset: "A preset that is used as a base for Jest's configuration",
  57. projects: 'Run tests from one or more projects',
  58. reporters: 'Use this configuration option to add custom reporters to Jest',
  59. resetMocks: 'Automatically reset mock state before every test',
  60. resetModules: 'Reset the module registry before running each individual test',
  61. resolver: 'A path to a custom resolver',
  62. restoreMocks:
  63. 'Automatically restore mock state and implementation before every test',
  64. rootDir:
  65. 'The root directory that Jest should scan for tests and modules within',
  66. roots:
  67. 'A list of paths to directories that Jest should use to search for files in',
  68. runner:
  69. "Allows you to use a custom runner instead of Jest's default test runner",
  70. setupFiles:
  71. 'The paths to modules that run some code to configure or set up the testing environment before each test',
  72. setupFilesAfterEnv:
  73. 'A list of paths to modules that run some code to configure or set up the testing framework before each test',
  74. slowTestThreshold:
  75. 'The number of seconds after which a test is considered as slow and reported as such in the results.',
  76. snapshotSerializers:
  77. 'A list of paths to snapshot serializer modules Jest should use for snapshot testing',
  78. testEnvironment: 'The test environment that will be used for testing',
  79. testEnvironmentOptions: 'Options that will be passed to the testEnvironment',
  80. testLocationInResults: 'Adds a location field to test results',
  81. testMatch: 'The glob patterns Jest uses to detect test files',
  82. testPathIgnorePatterns:
  83. 'An array of regexp pattern strings that are matched against all test paths, matched tests are skipped',
  84. testRegex:
  85. 'The regexp pattern or array of patterns that Jest uses to detect test files',
  86. testResultsProcessor:
  87. 'This option allows the use of a custom results processor',
  88. testRunner: 'This option allows use of a custom test runner',
  89. testURL:
  90. 'This option sets the URL for the jsdom environment. It is reflected in properties such as location.href',
  91. timers:
  92. 'Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"',
  93. transform: 'A map from regular expressions to paths to transformers',
  94. transformIgnorePatterns:
  95. 'An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation',
  96. unmockedModulePathPatterns:
  97. 'An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them',
  98. verbose:
  99. 'Indicates whether each individual test should be reported during the run',
  100. watchPathIgnorePatterns:
  101. 'An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode',
  102. watchman: 'Whether to use watchman for file crawling'
  103. };
  104. var _default = descriptions;
  105. exports.default = _default;