Descriptions.js 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. 'use strict';
  2. Object.defineProperty(exports, '__esModule', {
  3. value: true
  4. });
  5. exports.default = void 0;
  6. /**
  7. * Copyright (c) Meta Platforms, Inc. and affiliates.
  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, contexts 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. fakeTimers: 'The default configuration for fake timers',
  37. forceCoverageMatch:
  38. 'Force coverage collection from ignored files using an array of glob patterns',
  39. globalSetup:
  40. 'A path to a module which exports an async function that is triggered once before all test suites',
  41. globalTeardown:
  42. 'A path to a module which exports an async function that is triggered once after all test suites',
  43. globals:
  44. 'A set of global variables that need to be available in all test environments',
  45. maxWorkers:
  46. '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.',
  47. moduleDirectories:
  48. "An array of directory names to be searched recursively up from the requiring module's location",
  49. moduleFileExtensions: 'An array of file extensions your modules use',
  50. moduleNameMapper:
  51. 'A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module',
  52. modulePathIgnorePatterns:
  53. "An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader",
  54. notify: 'Activates notifications for test results',
  55. notifyMode:
  56. 'An enum that specifies notification mode. Requires { notify: true }',
  57. preset: "A preset that is used as a base for Jest's configuration",
  58. projects: 'Run tests from one or more projects',
  59. reporters: 'Use this configuration option to add custom reporters to Jest',
  60. resetMocks: 'Automatically reset mock state before every test',
  61. resetModules: 'Reset the module registry before running each individual test',
  62. resolver: 'A path to a custom resolver',
  63. restoreMocks:
  64. 'Automatically restore mock state and implementation before every test',
  65. rootDir:
  66. 'The root directory that Jest should scan for tests and modules within',
  67. roots:
  68. 'A list of paths to directories that Jest should use to search for files in',
  69. runner:
  70. "Allows you to use a custom runner instead of Jest's default test runner",
  71. setupFiles:
  72. 'The paths to modules that run some code to configure or set up the testing environment before each test',
  73. setupFilesAfterEnv:
  74. 'A list of paths to modules that run some code to configure or set up the testing framework before each test',
  75. slowTestThreshold:
  76. 'The number of seconds after which a test is considered as slow and reported as such in the results.',
  77. snapshotSerializers:
  78. 'A list of paths to snapshot serializer modules Jest should use for snapshot testing',
  79. testEnvironment: 'The test environment that will be used for testing',
  80. testEnvironmentOptions: 'Options that will be passed to the testEnvironment',
  81. testLocationInResults: 'Adds a location field to test results',
  82. testMatch: 'The glob patterns Jest uses to detect test files',
  83. testPathIgnorePatterns:
  84. 'An array of regexp pattern strings that are matched against all test paths, matched tests are skipped',
  85. testRegex:
  86. 'The regexp pattern or array of patterns that Jest uses to detect test files',
  87. testResultsProcessor:
  88. 'This option allows the use of a custom results processor',
  89. testRunner: 'This option allows use of a custom test runner',
  90. transform: 'A map from regular expressions to paths to transformers',
  91. transformIgnorePatterns:
  92. 'An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation',
  93. unmockedModulePathPatterns:
  94. 'An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them',
  95. verbose:
  96. 'Indicates whether each individual test should be reported during the run',
  97. watchPathIgnorePatterns:
  98. 'An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode',
  99. watchman: 'Whether to use watchman for file crawling'
  100. };
  101. var _default = descriptions;
  102. exports.default = _default;