docs: add missing override options for Jest config #9473

tobiasbueschel · 2020-08-12T03:57:04Z

Hi 👋

I've noticed that the documentation for overriding CRA's default Jest configuration has gone out of sync with the actual implementation:

create-react-app/packages/react-scripts/scripts/utils/createJestConfig.js

Lines 75 to 94 in 5e703a5

    
           const supportedKeys = [ 
        
             'clearMocks', 
        
             'collectCoverageFrom', 
        
             'coveragePathIgnorePatterns', 
        
             'coverageReporters', 
        
             'coverageThreshold', 
        
             'displayName', 
        
             'extraGlobals', 
        
             'globalSetup', 
        
             'globalTeardown', 
        
             'moduleNameMapper', 
        
             'resetMocks', 
        
             'resetModules', 
        
             'restoreMocks', 
        
             'snapshotSerializers', 
        
             'testMatch', 
        
             'transform', 
        
             'transformIgnorePatterns', 
        
             'watchPathIgnorePatterns', 
        
           ];

This PR fixes that!

tobiasbueschel · 2020-08-12T04:07:17Z

docusaurus/docs/running-tests.md

@@ -272,12 +272,13 @@ Note that tests run much slower with coverage so it is recommended to run it sep

 ### Configuration

-The default Jest coverage configuration can be overridden by adding any of the following supported keys to a Jest config in your package.json.


We no longer only allow coverage overrides, hence, I've also updated the wording here!

On a similar note, I've noticed that a few people would like an option to easily ignore certain files when running tests as mentioned in this StackOverflow post.

@iansu @amyrlam what do you think about including testPathIgnorePatterns in the override options? Happy to raise a PR for it.

tobiasbueschel · 2020-09-14T08:43:57Z

@ianschmitz @iansu @mrmckeb please let me know if you have any feedback on this PR, otherwise it is ready to be merged 😊 thanks

mrmckeb

Looks good to me, let's get a second review and this should be good to go. Thanks @tobiasbueschel!

tobiasbueschel · 2020-09-16T07:48:23Z

Looks good to me, let's get a second review and this should be good to go. Thanks @tobiasbueschel!

Thanks again for your reviews @mrmckeb! By the way, what do you think about the following?

including testPathIgnorePatterns in the override options?

I suppose that we want to keep any changes at a minimum for the time until v4 is ready? However, if this override is something you would generally be fine with, I can raise a PR for post v4.

mrmckeb · 2020-10-04T10:20:14Z

@ianschmitz or @iansu, it would be great to get a quick second review here.

tobiasbueschel · 2020-11-10T15:11:40Z

On a similar note, I've noticed that a few people would like an option to easily ignore certain files when running tests as mentioned in this StackOverflow post.
@iansu @amyrlam what do you think about including testPathIgnorePatterns in the override options? Happy to raise a PR for it.
#9473 (comment)

Hi @ianschmitz & @iansu, hope you are both well :)

Do you have any thoughts on the above idea & this PR?

Cheers

iansu · 2021-02-03T18:09:48Z

Thanks!

* Fix noFallthroughCasesInSwitch/jsx object is not extensible (facebook#9921) Co-authored-by: Konstantin Simeonov <kon.simeonov@protonmail.com> * Add logo license to README * Remove trailing space in reportWebVitals.ts (facebook#10040) * docs: add React Testing Library as a library requiring jsdom (facebook#10052) Co-authored-by: Ian Schmitz <ianschmitz@gmail.com> * Increase Workbox's maximumFileSizeToCacheInBytes (facebook#10048) * Create FUNDING.yml * replace inquirer with prompts (facebook#10083) - remove `react-dev-utils/inquirer` public import * Prepare 4.0.1 release * Prepare 4.0.1 release * Publish - cra-template-typescript@1.1.1 - cra-template@1.1.1 - create-react-app@4.0.1 - react-dev-utils@11.0.1 - react-scripts@4.0.1 * chore: bump web-vital dependency version (facebook#10143) * chore: bump typescript version (facebook#10141) Co-authored-by: Ian Schmitz <ianschmitz@gmail.com> * Add TypeScript 4.x as peerDependency to react-scripts(facebook#9964) * remove chalk from formatWebpackMessages (facebook#10198) * Upgrade @svgr/webpack to fix build error (facebook#10213) Co-authored-by: Ian Schmitz <ianschmitz@gmail.com> * Improve vendor chunk names in development (facebook#9569) * Update postcss packages (facebook#10003) Co-authored-by: Ian Schmitz <ianschmitz@gmail.com> * Recovered some integration tests (facebook#10091) * Upgrade sass-loader (facebook#9988) * Move ESLint cache file into node_modules (facebook#9977) Co-authored-by: Ian Schmitz <ianschmitz@gmail.com> * Revert "Update postcss packages" (facebook#10216) This reverts commit 580ed5d. * Remove references to Node 8 (facebook#10214) * fix(react-scripts): add missing peer dependency react and update react-refresh-webpack-plugin (facebook#9872) * Update using-the-public-folder.md (facebook#10314) Some library --> Some libraries * docs: add missing override options for Jest config (facebook#9473) * Fix CI tests (facebook#10217) * appTsConfig immutability handling by immer (facebook#10027) Co-authored-by: mad-jose <joset@yeswearemad.com> * Add support for new BUILD_PATH advanced configuration variable (facebook#8986) * Add opt-out for eslint-webpack-plugin (facebook#10170) * Prepare 4.0.2 release * Publish - cra-template-typescript@1.1.2 - cra-template@1.1.2 - create-react-app@4.0.2 - react-dev-utils@11.0.2 - react-error-overlay@6.0.9 - react-scripts@4.0.2 * tests: update test case to match the description (facebook#10384) * Bump webpack-dev-server 3.11.0 -> 3.11.1 (facebook#10312) Resolves facebook#10084 security vulnerability in websocket-driver library version 0.5.6, imported transitively by sockjs * Upgrade eslint-webpack-plugin to fix opt-out flag (facebook#10590) * update immer to 8.0.1 to address vulnerability (facebook#10412) Resolves facebook#10411 Bumps immer version to 8.0.1 to address the prototype pollution vulnerability with the current 7.0.9 version. * Prepare 4.0.3 release * Update CHANGELOG * Publish - create-react-app@4.0.3 - react-dev-utils@11.0.3 - react-scripts@4.0.3 Co-authored-by: Ryota Murakami <dojce1048@gmail.com> Co-authored-by: Konstantin Simeonov <kon.simeonov@protonmail.com> Co-authored-by: Ian Sutherland <ian@iansutherland.ca> Co-authored-by: sho90 <aznecosann@gmail.com> Co-authored-by: Anyul Rivas <anyulled@gmail.com> Co-authored-by: Ian Schmitz <ianschmitz@gmail.com> Co-authored-by: Jeffrey Posnick <jeffy@google.com> Co-authored-by: Evan Bacon <baconbrix@gmail.com> Co-authored-by: Sahil Purav <sahil5684@gmail.com> Co-authored-by: Hakjoon Sim <trainto@gmail.com> Co-authored-by: Chris Shepherd <chris@chrisshepherd.me> Co-authored-by: Jason Williams <936006+jasonwilliams@users.noreply.github.com> Co-authored-by: Jabran Rafique⚡️ <jabranr@users.noreply.github.com> Co-authored-by: John Ruble <johnruble@gmail.com> Co-authored-by: Morten N.O. Nørgaard Henriksen <morten.n.o.henriksen@icloud.com> Co-authored-by: Sergey Makarov <serega.s.makar@gmail.com> Co-authored-by: EhsanKhaki <ehsankhfr@gmail.com> Co-authored-by: Kristoffer K <merceyz@users.noreply.github.com> Co-authored-by: Aviv Hadar <Avivhdr@gmail.com> Co-authored-by: Tobias Büschel <13087421+tobiasbueschel@users.noreply.github.com> Co-authored-by: mad-jose <44253495+josezone@users.noreply.github.com> Co-authored-by: mad-jose <joset@yeswearemad.com> Co-authored-by: Andrew Hyndman <ajhyndman@hotmail.com> Co-authored-by: Brody McKee <mrmckeb@users.noreply.github.com> Co-authored-by: James George <jamesgeorge998001@gmail.com> Co-authored-by: Dion Woolley <woolley.dion@gmail.com> Co-authored-by: Walker Clem <51654951+wclem4@users.noreply.github.com>

docs: add missing override options for Jest config

27df3ac

tobiasbueschel requested review from amyrlam and iansu as code owners August 12, 2020 03:57

facebook-github-bot added the CLA Signed label Aug 12, 2020

tobiasbueschel commented Aug 12, 2020

View reviewed changes

amyrlam removed their request for review August 23, 2020 04:24

mrmckeb approved these changes Sep 14, 2020

View reviewed changes

mrmckeb added this to In progress in v4 via automation Oct 4, 2020

mrmckeb added this to the 4.0 milestone Oct 4, 2020

iansu modified the milestones: 4.0, 4.0.1 Oct 23, 2020

iansu modified the milestones: 4.0.1, 4.0.2 Nov 23, 2020

iansu added the tag: documentation label Feb 3, 2021

iansu merged commit c9a24db into facebook:master Feb 3, 2021

v4 automation moved this from In progress to Done Feb 3, 2021

tobiasbueschel deleted the docs/running-tests branch February 3, 2021 19:25

drich7449 mentioned this pull request Feb 23, 2021

[Snyk] Security upgrade react-dev-utils from 9.1.0 to 11.0.3 drich7449/create-react-app#22

Open

hzhz mentioned this pull request Feb 23, 2021

[Snyk] Security upgrade react-dev-utils from 10.2.1 to 11.0.3 hzhz/create-react-app#15

Open

sirinartk mentioned this pull request Feb 23, 2021

[Snyk] Security upgrade react-dev-utils from 9.1.0 to 11.0.3 sirinartk/create-react-app#17

Closed

tobiasbueschel mentioned this pull request Mar 15, 2021

feat: add testPathIgnorePatterns override option to createJestConfig #10688

Open

wombleton pushed a commit to AurorNZ/create-react-app that referenced this pull request Jun 1, 2021

docs: add missing override options for Jest config (facebook#9473)

dd36ecd

abhiisheek pushed a commit to abhiisheek/create-react-app that referenced this pull request May 19, 2023

docs: add missing override options for Jest config (facebook#9473)

af3bd35

abhiisheek pushed a commit to abhiisheek/create-react-app that referenced this pull request May 24, 2023

docs: add missing override options for Jest config (facebook#9473)

5699600

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add missing override options for Jest config #9473

docs: add missing override options for Jest config #9473

tobiasbueschel commented Aug 12, 2020

tobiasbueschel Aug 12, 2020

tobiasbueschel commented Sep 14, 2020

mrmckeb left a comment •

edited

tobiasbueschel commented Sep 16, 2020

mrmckeb commented Oct 4, 2020

tobiasbueschel commented Nov 10, 2020

iansu commented Feb 3, 2021

	const supportedKeys = [
	'clearMocks',
	'collectCoverageFrom',
	'coveragePathIgnorePatterns',
	'coverageReporters',
	'coverageThreshold',
	'displayName',
	'extraGlobals',
	'globalSetup',
	'globalTeardown',
	'moduleNameMapper',
	'resetMocks',
	'resetModules',
	'restoreMocks',
	'snapshotSerializers',
	'testMatch',
	'transform',
	'transformIgnorePatterns',
	'watchPathIgnorePatterns',
	];

		@@ -272,12 +272,13 @@ Note that tests run much slower with coverage so it is recommended to run it sep

		### Configuration

		The default Jest coverage configuration can be overridden by adding any of the following supported keys to a Jest config in your package.json.

docs: add missing override options for Jest config #9473

docs: add missing override options for Jest config #9473

Conversation

tobiasbueschel commented Aug 12, 2020

tobiasbueschel Aug 12, 2020

Choose a reason for hiding this comment

tobiasbueschel commented Sep 14, 2020

mrmckeb left a comment • edited

Choose a reason for hiding this comment

tobiasbueschel commented Sep 16, 2020

mrmckeb commented Oct 4, 2020

tobiasbueschel commented Nov 10, 2020

iansu commented Feb 3, 2021

mrmckeb left a comment •

edited