15

Currently npm test is running all files that has .test.js extension. I would like some files to be ignored. Where do I configure that option? I tried 

 "jest": {
        "collectCoverageFrom": [
            "src/App.test.js"
        ]
    },

in package.json. I don't see any difference.

OneCricketeer
  • 179,855
  • 19
  • 132
  • 245
PCK
  • 1,254
  • 6
  • 20
  • 37

2 Answers2

32

package.json only allows you to override the following Jest configuration with create-react-app

"jest": {
  "collectCoverageFrom": [],
  "coverageThreshold": {},
  "coverageReporters": [],
  "snapshotSerializers": []
}

Solution 1

Eject Create React App and configure by using testPathIgnorePatterns.

Solution 2

You can still override Jest's configuration by passing the --testPathIgnorePatterns option to react-scripts test.

For example:

"test": "react-scripts test --testPathIgnorePatterns=src/ignoredDirectory --env=jsdom"
OneCricketeer
  • 179,855
  • 19
  • 132
  • 245
tobias
  • 934
  • 8
  • 17
  • What if I want to run tests only for the files in certain directories? – PCK Apr 12 '19 at 03:35
  • "test": "react-scripts test --env=jsdom --testMatch=src/App.test.js". I tried this so that only App.test.js runs. But npm test gives 0 matches. @tobias – PCK Apr 12 '19 at 04:25
  • Have a look at this answer: https://stackoverflow.com/questions/44446626/run-only-one-test-with-jest/44446669 which might help :) – tobias Apr 12 '19 at 06:38
  • 2
    Note that using `testPathIgnorePatterns` as a cli argument breaks the ability to run one test with either `npm test Testname` or `npm test -- -t TestName`. – badsyntax Mar 28 '21 at 07:40
6

You might be tempted to use testPathIgnorePatterns as a cli argument, but note this causes unexpected side effects, in that it breaks the ability to run single tests with npm test TestName or npm test -- -t TestName.

This is because, as far as i can tell, testPathIgnorePatterns is incredibly greedy, in that any argument after the testPathIgnorePatterns argument will be used as a value for testPathIgnorePatterns.

For example:

If I have the following set in my package.json:

"test": "react-scripts test --testPathIgnorePatterns=e2e",

And then run: npm test MyTest

Then the resulting command is: react-scripts test --testPathIgnorePatterns=e2e "App"

And jest will be ignore both e2e and App!

A workaround I have found is to not use the testPathIgnorePatterns cli arg, and instead use the testMatch jest config.

Let's say I want to ignore all files in an e2e directory, then I could use the following regex:

"testMatch": [
  "<rootDir>/src/(?!e2e)*/**/__tests__/**/*.{js,jsx,ts,tsx}",
  "<rootDir>/src/(?!e2e)*/**/*.{spec,test}.{js,jsx,ts,tsx}"
]

Or if i wanted to only include tests in a certain directory, I can use:

"testMatch": [
  "<rootDir>/src/modules/**/__tests__/**/*.{js,jsx,ts,tsx}",
  "<rootDir>/src/modules/**/*.{spec,test}.{js,jsx,ts,tsx}"
]
badsyntax
  • 9,394
  • 3
  • 49
  • 67
  • [Here are the docs on `testMatch`](https://jestjs.io/docs/configuration#testmatch-arraystring) for anyone curious about it. – Joe Sadoski Mar 24 '22 at 13:46
  • Additionally, `testPathIgnorePatterns` is configurable in `package.json` without any need to change the `npm test` command. – Joe Sadoski Mar 24 '22 at 13:49
  • 5
    According to https://create-react-app.dev/docs/running-tests/#configuration, `testPathIgnorePatterns` is not configurable in `package.json` – BobtheMagicMoose Mar 24 '22 at 20:40