How can I exclude files from Jest watch?

Question

I'm doing some slightly bizarre stuff using Jest for testing where I'm writing some stuff to disk. If I use the watch flag in Jest however then I'm finding (quite obviously) that each time I write something to disk the tests refire again.

I don't currently have any sort of configuration, and I've taken a look at the documentation, but it's really not clear to me which option I need to be using to suppress watching particular files. I believe I can see options to exclude code from code-coverage and test execution, but not the actual watcher.

In my case I've got a setup like this and I just want to suppress my results directory:

__tests__
__snapshots__ (created by Jest)
results (created by me and the directory to exclude)

testfile1.js

How can I do this?

score 230 · Accepted Answer · edited Dec 29 '20 at 22:19

230

From the documentation you need to add modulePathIgnorePatterns which is an array of string values which will be matched against

modulePathIgnorePatterns [array<string>] #

(default: []) An array of regexp pattern strings that are matched against all module paths before those paths are to be considered 'visible' to the module loader. If a given module's path matches any of the patterns, it will not be require()-able in the test environment. These pattern strings match against the full path. Use the <rootDir> string token to include the path to your project's root directory to prevent it from accidentally ignoring all of your files in different environments that may have different root directories. Example: ['<rootDir>/build/'].

https://facebook.github.io/jest/docs/configuration.html#modulepathignorepatterns-array-string

Add this to your configuration...

modulePathIgnorePatterns: ["directoryNameToIgnore"]

or:

modulePathIgnorePatterns: ["<rootDir>/dist/"]

edited Dec 29 '20 at 22:19

Peter Mortensen

30,738
21
105
131

answered Nov 08 '16 at 12:13

Chris Hawkes

11,923
6
58
68

11

I've given this a try with `"jest": { "modulePathIgnorePatterns": ["__tests__/results/"] },` but it doesn't work unfortunately. – Ian Nov 08 '16 at 13:22
1

can you try shortening it? "jest": { "modulePathIgnorePatterns": ["__tests__"] }, – Chris Hawkes Nov 08 '16 at 13:27
`__tests__` is the default directory that `jest` uses to load its tests from. So it'd be awkward to rename, I could move my `results` directory up outside of `__tests__` but I'm reluctant to do so unless I can't find an alternative. – Ian Nov 08 '16 at 13:28
1

yes you're probably right, I'm just wondering if the pathName is somehow choking due to the slashes. In most cases when I'm using exclude directories in webpack I don't include the forward slashes and just the names of the directories like "node_module" etc... – Chris Hawkes Nov 08 '16 at 13:29
true. I've just tried moving the directory up, didn't seem to make any difference. I have worked out it's specifically a JSON file within there that I'm modifying that's causing the problem. Trying to just exclude that still doesn't seem to do much though :( – Ian Nov 08 '16 at 13:32
1

In what file? *package.json*? Can you add it to your answer? – Peter Mortensen Dec 29 '20 at 22:35
I just want to make sure: Does Jest automatically ignore checking the node_modules directory? (Most probably it must be the case!) – aderchox Dec 16 '21 at 17:15

score 84 · Answer 2 · edited Dec 29 '20 at 22:21

84

To exclude a directory from Jest testing, use testPathIgnorePatterns

testPathIgnorePatterns

"testPathIgnorePatterns": ["directory to ignore"]

Below in file package.json, I have configured to ignore the "src" directory

{
      "name": "learn-test",
      "jest": {
        "testPathIgnorePatterns": ["src"]
      },
      "version": "0.1.0",
      "private": true,
      "dependencies": {
        "react": "^16.4.1",
        "react-dom": "^16.4.1",
        "react-scripts": "1.1.4"
      },
      "scripts": {
        "start": "react-scripts start",
        "build": "react-scripts build",
        "test": "jest --watch",
        "eject": "react-scripts eject",

      },

      "devDependencies": {}
    }

edited Dec 29 '20 at 22:21

Peter Mortensen

30,738
21
105
131

answered Jul 12 '18 at 18:45

manas

6,119
10
45
56

2

`"testPathIgnorePatterns": ["/cypress/"]` see here: https://github.com/wallabyjs/public/issues/2245 – Felix Oct 23 '19 at 07:00
5

Best answer after 10 mins of searching. – japes Sophey Mar 17 '20 at 11:37
3

What's the difference with `modulePathIgnorePatterns` ? – Yohan Dahmani Aug 04 '20 at 13:58
3

This one worked for me unlike modulePathIgnorePatterns – Aaron Cowie Aug 31 '20 at 14:33
Thanks I couldn't get testPathIgnorePatterns to do anything. – Mark Jul 28 '21 at 17:51
best answer after after 2 mins of searching – Aleks Jan 27 '23 at 10:30
1

This is the answer I was looking for.`modulePathIgnorePatterns` is not for excluding tests, it's for excluding other libs from being required during the test runners setup process. Just FYI for those looking to excluded tests in a build directory from running for example – Luke Watts Apr 16 '23 at 14:20
how to allow few in these ignored folders to run? – til Jul 27 '23 at 12:01

score 18 · Answer 3 · edited Dec 29 '20 at 22:23

18

I had the same problem when I had a directory that must not be tested, although I still wanted it to be inside of the __tests__ directory (e.g., __mocks__).

You should not use a use relative paths in such case (no slashes). So inside of your package.json file add:

jest: {
  "modulePathIgnorePatterns": ["__mocks__"]
}

That solved my problem.

edited Dec 29 '20 at 22:23

Peter Mortensen

30,738
21
105
131

answered Jan 10 '19 at 06:46

Islam Murtazaev

1,488
2
17
27

1

Best answer so far... BUT, [create-react-app](https://create-react-app.dev) and derived boilerplates won't support that option. I used [watchPathIgnorePatterns](https://jestjs.io/docs/en/configuration#watchpathignorepatterns-array-string) instead. Just put it in your package.json's jest prop: `"jest": {"watchPathIgnorePatterns":["__mocks__"]}` – Malek Boubakri Aug 03 '22 at 18:43

Nima Soroush · Answer 4 · 2020-12-30T12:10:06.053

13

Based on Jest documentation, watchPathIgnorePatterns should be the way you want to go. That works in Jest 23.x.x and later.

You can add this config to jest.config.js or package.json > jest

edited Dec 30 '20 at 12:10

answered Oct 18 '18 at 16:30

Nima Soroush

12,242
4
52
53

helped with me with vs-code tests doing all sorts of magic and failing. Also had to change `"jest.jestCommandLine": "npm run test:jest --"` in the vs code extension options – David Apr 13 '23 at 11:38

score 8 · Answer 5 · answered Oct 25 '21 at 23:02

8

jest version: 27.2.1

In order to exclude from test and coverage:

"testPathIgnorePatterns" : [
  "tests/login/default/MockStrategy.js",
],
coveragePathIgnorePatterns: [
  "tests/login/default/MockStrategy.js"
],

answered Oct 25 '21 at 23:02

JRichardsz

14,356
6
59
94

score 7 · Answer 6 · edited Dec 29 '20 at 22:31

7

I use the following pattern and it works for me:

collectCoverageFrom: [
    'src/**/*.js',
    '!src/api/graphql/**/*.js',
    '!src/action/**/*.js',
    '!src/utils/dev/*.js',
    '!src/**/*.e2e.js',
],

! means we exclude the folder or file.

edited Dec 29 '20 at 22:31

Peter Mortensen

30,738
21
105
131

answered Oct 11 '20 at 10:12

Faris Rayhan

4,500
1
22
19

In what file? *package.json*? Can you add it to your answer? – Peter Mortensen Dec 29 '20 at 22:36
1

within jest.config.js file – himanshupareek66 Jun 17 '21 at 11:24

score 6 · Answer 7 · edited Dec 29 '20 at 22:29

6

To exclude an entire folder, add the following in the "jest" property of the package.json file:

"modulePathIgnorePatterns": [
  "<rootDir>/src/services"
],

To exclude an individual file:

"collectCoverageFrom": [
  "!src/index.js"
],

edited Dec 29 '20 at 22:29

Peter Mortensen

30,738
21
105
131

answered Jul 21 '20 at 02:09

yasarui

6,209
8
41
75

1

Thanks, Working Added regular expression sample "collectCoverageFrom": [ "src/**/*.{ts,js}", "!src/db_access/*.{ts,js}", "!src/**/__fixtures/.{ts,js,json}", "!src/**/__removed__/.{ts,js,json}", "!src/models/.{ts,js,json}" ] – Abhijith v Mar 30 '21 at 10:56

score 3 · Answer 8 · answered Jun 11 '21 at 15:59

3

In most of cases you will get the error: Your test suite must contain at least one test.

To ignore/exclude file or folders from the test, please modify the package.json

If the block "jest" does not exist add it like that:

...
"jest": {
    "collectCoverage": true,
    "testPathIgnorePatterns" : [
      "__tests__/properties.js",
      "__tests__/properties.js.sample"
    ]
},
...

answered Jun 11 '21 at 15:59

Yuriy

69
2

1

It actually works quite well. I prefer this cause I dont need to add folders. One thing I notice you have to restart the 'watch' for it to take effect. – Álvaro Sep 23 '21 at 04:16

score 3 · Answer 9 · answered Oct 03 '22 at 20:41

I was looking for the command-line way of doing this without editing the config file everytime I try changing things.

This following runs jest in watch mode but excludes end-to-end test folders, independent from npm. you may have it in scripts section but if you do so then do not forget to remove "npx".

npx jest --watchAll --testPathIgnorePatterns "e2e_a/" "e2e_b/"

PS: some tests, especially E2E ones, may need to be run sequentially with -i, --runInBand flag. This comes in useful to exclude them from watch mode provided that they have their own folders. So prefer to have them in separate folders.

score 2 · Answer 10 · answered Sep 13 '21 at 14:44

here are my 2 cents on this, as I feel there is some confusion in above answers:

Following is the jest segment in package.json file :

"jest": {
"testPathIgnorePatterns": ["wallet-svc/src/db/"],
"coveragePathIgnorePatterns": ["wallet-svc/src/db/"],
"modulePathIgnorePatterns": ["wallet-svc/src/db/"],
"moduleFileExtensions": [
  "js",
  "json",
  "ts"
],
"rootDir": "src",
"testRegex": ".*\\.spec\\.ts$",
"transform": {
  "^.+\\.(t|j)s$": "ts-jest"
},
"collectCoverageFrom": [
  "**/*.(t|j)s"
],
"coverageDirectory": "../coverage",
"testEnvironment": "node"
}

If you notice I have mentioned 3 ignores - "testPathIgnorePatterns", "coveragePathIgnorePatterns" and "modulePathIgnorePatterns". It so happens at time when you are running tests, the files are ignored but when you run the coverage, jest does not ignore those file and you see them in the coverage report. Better to include all 3 tags.

I found this thread helpful : https://github.com/facebook/jest/issues/1815#issuecomment-684882428

score 1 · Answer 11 · answered Aug 24 '22 at 13:45

1

I had a similar situation, and adding testRegex in the jest.config.js was the complete solution for me, which specify which files exactly to be tested!

testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$'

answered Aug 24 '22 at 13:45

Solly

496
1
6
14

score 0 · Answer 12 · edited Dec 29 '20 at 22:29

0

Skipping files in the test cases report collection is possible using "collectCoverageFrom" in the latest version of create-react-app, jest:

"jest": {
    "collectCoverageFrom": [
        "src/**/*.{js,jsx,ts,tsx}",
        "!<rootDir>/src/registerServiceWorker.js",
        "!<rootDir>/src/serviceWorker.js",
        "!<rootDir>/node_modules/"
    ]
},

edited Dec 29 '20 at 22:29

Peter Mortensen

30,738
21
105
131

answered Aug 04 '20 at 10:22

Sachin Khedkar

11

1

In what file? What is the name of the file? – Peter Mortensen Dec 29 '20 at 22:30
Missing: `Note: This option requires collectCoverage to be set to true or Jest to be invoked with --coverage.` – Timo Mar 23 '21 at 16:40

score 0 · Answer 13 · answered Jun 15 '21 at 05:27

0

I used this config in my package.json to exclude index.js and reportWebVitals.js files from coverage report.

  "jest": {
    "collectCoverageFrom": [
      "!<rootDir>/src/reportWebVitals.js",
      "!<rootDir>/src/index.js"
    ],
  }

answered Jun 15 '21 at 05:27

coderpc

4,119
6
51
93

How can I exclude files from Jest watch?

13 Answers13

Linked