Skip to content

Commit

Permalink
Make coverage and snapshot Jest options overridable in package.json (f…
Browse files Browse the repository at this point in the history
…acebook#1830)

* Override Jest config collectCoverageFrom with package.json

* Protect against overriding other options

* Better error message

* Create Jest config early on eject

* Tweak wording

* Dry it up
  • Loading branch information
ryansully authored and gaearon committed May 16, 2017
1 parent dab6459 commit 7a05ea1
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 6 deletions.
13 changes: 8 additions & 5 deletions scripts/eject.js
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@ inquirer
folders.forEach(verifyAbsent);
files.forEach(verifyAbsent);

// Prepare Jest config early in case it throws
const jestConfig = createJestConfig(
filePath => path.posix.join('<rootDir>', filePath),
null,
true
);

console.log();
console.log(cyan(`Copying files into ${appPath}`));

Expand Down Expand Up @@ -151,11 +158,7 @@ inquirer
console.log(cyan('Configuring package.json'));
// Add Jest config
console.log(` Adding ${cyan('Jest')} configuration`);
appPackage.jest = createJestConfig(
filePath => path.posix.join('<rootDir>', filePath),
null,
true
);
appPackage.jest = jestConfig;

// Add Babel config
console.log(` Adding ${cyan('Babel')} preset`);
Expand Down
41 changes: 40 additions & 1 deletion scripts/utils/createJestConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
'use strict';

const fs = require('fs');
const chalk = require('chalk');
const paths = require('../../config/paths');

module.exports = (resolve, rootDir, isEjecting) => {
Expand All @@ -27,7 +28,7 @@ module.exports = (resolve, rootDir, isEjecting) => {
setupTestFrameworkScriptFile: setupTestsFile,
testMatch: [
'<rootDir>/src/**/__tests__/**/*.js?(x)',
'<rootDir>/src/**/?(*.)(spec|test).js?(x)'
'<rootDir>/src/**/?(*.)(spec|test).js?(x)',
],
testEnvironment: 'node',
testURL: 'http://localhost',
Expand All @@ -46,5 +47,43 @@ module.exports = (resolve, rootDir, isEjecting) => {
if (rootDir) {
config.rootDir = rootDir;
}
const overrides = Object.assign({}, require(paths.appPackageJson).jest);
const supportedKeys = [
'collectCoverageFrom',
'coverageReporters',
'coverageThreshold',
'snapshotSerializers',
];
if (overrides) {
supportedKeys.forEach(key => {
if (overrides.hasOwnProperty(key)) {
config[key] = overrides[key];
delete overrides[key];
}
});
const unsupportedKeys = Object.keys(overrides);
if (unsupportedKeys.length) {
console.error(
chalk.red(
'Out of the box, Create React App only supports overriding ' +
'these Jest options:\n\n' +
supportedKeys.map(key => chalk.bold(' \u2022 ' + key)).join('\n') +
'.\n\n' +
'These options in your package.json Jest configuration ' +
'are not currently supported by Create React App:\n\n' +
unsupportedKeys
.map(key => chalk.bold(' \u2022 ' + key))
.join('\n') +
'\n\nIf you wish to override other Jest options, you need to ' +
'eject from the default setup. You can do so by running ' +
chalk.bold('npm run eject') +
' but remember that this is a one-way operation. ' +
'You may also file an issue with Create React App to discuss ' +
'supporting more options out of the box.\n'
)
);
process.exit(1);
}
}
return config;
};

0 comments on commit 7a05ea1

Please sign in to comment.