fix: coverage config moved to project (jestjs#9628)

Moved the following config props from globalConfig to projectConfig: collectCoverageFrom, collectCoverageOnlyFrom, coverageThreshold You can now specify those properties per project. As a side effect, they were removed from the whitelist of watch-able properties.
salto-io · Mar 25, 2020 · 6976680 · 6976680
1 parent cd98198
commit 6976680
Show file tree

Hide file tree

Showing 22 changed files with 217 additions and 151 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ### Features
 
+- `[jest-config]` [**BREAKING**] Move coverage options to project config ([#9633](https://github.com/facebook/jest/pull/9633))
 - `[jest-runtime]` Require stack when a module cannot be resolved ([#9681](https://github.com/facebook/jest/pull/9681))
 - `[jest-config]` Support ESM config files with `.js` extension ([#9573](https://github.com/facebook/jest/pull/9573)).
 - `[jest-runtime]` Override `module.createRequire` to return a Jest-compatible `require` function ([#9469](https://github.com/facebook/jest/pull/9469))

diff --git a/TestUtils.ts b/TestUtils.ts
@@ -12,12 +12,9 @@ const DEFAULT_GLOBAL_CONFIG: Config.GlobalConfig = {
   changedFilesWithAncestor: false,
   changedSince: '',
   collectCoverage: false,
-  collectCoverageFrom: [],
-  collectCoverageOnlyFrom: null,
   coverageDirectory: 'coverage',
   coverageProvider: 'babel',
   coverageReporters: [],
-  coverageThreshold: {global: {}},
   detectLeaks: false,
   detectOpenHandles: false,
   enabledTestsMap: null,
@@ -71,7 +68,10 @@ const DEFAULT_PROJECT_CONFIG: Config.ProjectConfig = {
   cache: false,
   cacheDirectory: '/test_cache_dir/',
   clearMocks: false,
+  collectCoverageFrom: [],
+  collectCoverageOnlyFrom: null,
   coveragePathIgnorePatterns: [],
+  coverageThreshold: {global: {}},
   cwd: '/test_root_dir/',
   detectLeaks: false,
   detectOpenHandles: false,

diff --git a/docs/WatchPlugins.md b/docs/WatchPlugins.md
@@ -157,8 +157,6 @@ For stability and safety reasons, only part of the global configuration keys can
 - [`bail`](configuration.html#bail-number--boolean)
 - [`changedSince`](cli.html#--changedsince)
 - [`collectCoverage`](configuration.html#collectcoverage-boolean)
-- [`collectCoverageFrom`](configuration.html#collectcoveragefrom-array)
-- [`collectCoverageOnlyFrom`](configuration.html#collectcoverageonlyfrom-array)
 - [`coverageDirectory`](configuration.html#coveragedirectory-string)
 - [`coverageReporters`](configuration.html#coveragereporters-arraystring)
 - [`notify`](configuration.html#notify-boolean)

diff --git a/e2e/__tests__/__snapshots__/showConfig.test.ts.snap b/e2e/__tests__/__snapshots__/showConfig.test.ts.snap
@@ -9,6 +9,7 @@ exports[`--showConfig outputs config info and exits 1`] = `
       "cache": false,
       "cacheDirectory": "/tmp/jest",
       "clearMocks": false,
+      "collectCoverageFrom": [],
       "coveragePathIgnorePatterns": [
         "/node_modules/"
       ],
@@ -82,7 +83,6 @@ exports[`--showConfig outputs config info and exits 1`] = `
     "bail": 0,
     "changedFilesWithAncestor": false,
     "collectCoverage": false,
-    "collectCoverageFrom": [],
     "coverageDirectory": "<<REPLACED_ROOT_DIR>>/coverage",
     "coverageProvider": "babel",
     "coverageReporters": [

diff --git a/packages/jest-config/src/index.ts b/packages/jest-config/src/index.ts
@@ -109,12 +109,9 @@ const groupOptions = (
     changedFilesWithAncestor: options.changedFilesWithAncestor,
     changedSince: options.changedSince,
     collectCoverage: options.collectCoverage,
-    collectCoverageFrom: options.collectCoverageFrom,
-    collectCoverageOnlyFrom: options.collectCoverageOnlyFrom,
     coverageDirectory: options.coverageDirectory,
     coverageProvider: options.coverageProvider,
     coverageReporters: options.coverageReporters,
-    coverageThreshold: options.coverageThreshold,
     detectLeaks: options.detectLeaks,
     detectOpenHandles: options.detectOpenHandles,
     enabledTestsMap: options.enabledTestsMap,
@@ -167,7 +164,10 @@ const groupOptions = (
     cache: options.cache,
     cacheDirectory: options.cacheDirectory,
     clearMocks: options.clearMocks,
+    collectCoverageFrom: options.collectCoverageFrom,
+    collectCoverageOnlyFrom: options.collectCoverageOnlyFrom,
     coveragePathIgnorePatterns: options.coveragePathIgnorePatterns,
+    coverageThreshold: options.coverageThreshold,
     cwd: options.cwd,
     dependencyExtractor: options.dependencyExtractor,
     detectLeaks: options.detectLeaks,

diff --git a/packages/jest-core/src/__tests__/watch.test.js b/packages/jest-core/src/__tests__/watch.test.js
@@ -600,11 +600,8 @@ describe('Watch mode flows', () => {
     ${'✖︎'} | ${'changedFilesWithAncestor'}
     ${'✔︎'} | ${'changedSince'}
     ${'✔︎'} | ${'collectCoverage'}
-    ${'✔︎'} | ${'collectCoverageFrom'}
-    ${'✔︎'} | ${'collectCoverageOnlyFrom'}
     ${'✔︎'} | ${'coverageDirectory'}
     ${'✔︎'} | ${'coverageReporters'}
-    ${'✖︎'} | ${'coverageThreshold'}
     ${'✖︎'} | ${'detectLeaks'}
     ${'✖︎'} | ${'detectOpenHandles'}
     ${'✖︎'} | ${'enabledTestsMap'}

diff --git a/packages/jest-core/src/lib/__tests__/__snapshots__/log_debug_messages.test.ts.snap b/packages/jest-core/src/lib/__tests__/__snapshots__/log_debug_messages.test.ts.snap
@@ -8,7 +8,12 @@ exports[`prints the config object 1`] = `
     "cache": false,
     "cacheDirectory": "/test_cache_dir/",
     "clearMocks": false,
+    "collectCoverageFrom": [],
+    "collectCoverageOnlyFrom": null,
     "coveragePathIgnorePatterns": [],
+    "coverageThreshold": {
+      "global": {}
+    },
     "cwd": "/test_root_dir/",
     "detectLeaks": false,
     "detectOpenHandles": false,
@@ -68,14 +73,9 @@ exports[`prints the config object 1`] = `
     "changedFilesWithAncestor": false,
     "changedSince": "",
     "collectCoverage": false,
-    "collectCoverageFrom": [],
-    "collectCoverageOnlyFrom": null,
     "coverageDirectory": "coverage",
     "coverageProvider": "babel",
     "coverageReporters": [],
-    "coverageThreshold": {
-      "global": {}
-    },
     "detectLeaks": false,
     "detectOpenHandles": false,
     "enabledTestsMap": null,

diff --git a/packages/jest-core/src/lib/update_global_config.ts b/packages/jest-core/src/lib/update_global_config.ts
@@ -56,14 +56,6 @@ export default (
     newConfig.collectCoverage = options.collectCoverage || false;
   }
 
-  if (options.collectCoverageFrom !== undefined) {
-    newConfig.collectCoverageFrom = options.collectCoverageFrom;
-  }
-
-  if (options.collectCoverageOnlyFrom !== undefined) {
-    newConfig.collectCoverageOnlyFrom = options.collectCoverageOnlyFrom;
-  }
-
   if (options.coverageDirectory !== undefined) {
     newConfig.coverageDirectory = options.coverageDirectory;
   }

diff --git a/packages/jest-core/src/watch.ts b/packages/jest-core/src/watch.ts
@@ -103,8 +103,6 @@ export default function watch(
     bail,
     changedSince,
     collectCoverage,
-    collectCoverageFrom,
-    collectCoverageOnlyFrom,
     coverageDirectory,
     coverageReporters,
     mode,
@@ -122,8 +120,6 @@ export default function watch(
       bail,
       changedSince,
       collectCoverage,
-      collectCoverageFrom,
-      collectCoverageOnlyFrom,
       coverageDirectory,
       coverageReporters,
       mode,