Code coverage comments like `/* istanbul ignore file */` are ignored for jsx files #6106

dbartholomae · 2018-12-31T00:30:08Z

Is this a bug report?

Yes

Did you try recovering your dependencies?

Yes - I have a minimum repo to reproduce.

Which terms did you search for in User Guide?

istanbul comment
coverage comment

Environment

System:
OS: Windows 10
CPU: x64 Intel(R) Core(TM) i7-8550U CPU @ 1.80GHz
Binaries:
Yarn: 1.12.3 - C:\Program Files (x86)\Yarn\bin\yarn.CMD
npm: 6.4.1 - C:\Program Files\nodejs\npm.CMD
Browsers:
Edge: 42.17134.1.0
Internet Explorer: 11.0.17134.1
npmPackages:
react: ^16.7.0 => 16.7.0
react-dom: ^16.7.0 => 16.7.0
react-scripts: 2.1.2 => 2.1.2
npmGlobalPackages:
create-react-app: Not Found

Steps to Reproduce

Code coverage comments like /* istanbul ignore file */ are ignored for jsx files. When you set up a new app, adding this line to index.js doesn't work. This seems to be related to the Babel config as pure JS files work fine.

Here's an example repo:

Clone https://github.com/dbartholomae/coverage-bug
Run npm test (note that the command is modified in package.json and includes the coverage flag)

This could be related to #5756

Expected Behavior

Neither index.js nor index-no-jsx.js should show up in the coverage-report.

Actual Behavior

index.js shows up in the coverage-report.

Reproducible Demo

See "Steps to Reproduce"

The text was updated successfully, but these errors were encountered:

mrmckeb · 2019-01-04T15:04:08Z

Hi @dbartholomae, you can actually use Jest here to ignore files. I know Istanbul comments work with Jest, but I'm not sure that specific comment does.

As an example, here I'm ignoring all tsx files (for no good reason):

  "jest": {
    "collectCoverageFrom": [
      "src/**/*.{js,jsx,ts}", 
      "!src/**/*.tsx"
    ],
  }

dbartholomae · 2019-01-04T15:16:27Z

Thanks! Unfortunately that solution isn't ideal as I will have to add it to multiple files, and adding it in a central file introduces unnecessary coupling that makes it harder to refactor later on.
Furthermore the comment is respected in the .js file, only in the .jsx it is ignored - as are other comments like ignoring the next line. I assume it has to do with Babel config, maybe Babel throws out comments?
Btw I'm happy to help if there is a good way of doing so.

mrmckeb · 2019-01-06T10:42:52Z

Hi @dbartholomae, I understand - I had assumed this was a jest issue, and that would explain why they have the coverage ignore patterns.

So, it sounds like the JSX transform is removing the comments... but that's also quite confusing, as it would be affecting a lot of people. Can you see the comments in your HTML report?

dbartholomae · 2019-01-06T19:40:02Z

Yes, the comments are shown. I've also set up a repo which reproduces the bug with basically 2 lines changed compared to the vanilla verion created by create-react-app:
https://github.com/dbartholomae/coverage-bug

FezVrasta · 2019-01-14T16:50:30Z

In my case, the file I add the comment to drops to 0% coverage even if it was higher without the comment (rather than ignoring it)

stale · 2019-02-13T16:53:33Z

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed in 5 days if no further activity occurs.

FezVrasta · 2019-02-13T17:29:39Z

@mrmckeb may you guys add some label to prevent this from getting auto-closed by the stale bot? This is a verified issue, there's no reason to close it automatically just because you guys are busy working on other things.

mrmckeb · 2019-02-18T07:23:59Z

Hi @FezVrasta, sorry about that. We need to investigate this more. Would anyone be interested in picking this up and submitting a PR? If not, I can take a look this week.

dragonghy · 2019-06-24T19:52:09Z

+1

FezVrasta · 2019-08-08T12:20:35Z

I'm trying to upgrade to 3.x one of my projects and now I'm reproducing this issue even on .js files. Is there any progress on this issue?

Thanks!

jensbodal · 2019-11-05T23:51:54Z

FWIW, for me the file was was only ignored if I placed this comment at the top of the file and had a newline between it and the next block:

WORKS

/* istanbul ignore file */

import { Foo } from 'bar';

DOES NOT WORK

/* istanbul ignore file */
import { Foo } from 'bar';

nickserv · 2020-10-25T13:16:58Z

I don't seem to have this issue on src/index.tsx

bratanon · 2022-06-06T00:18:24Z

What @jensbodal said is true also for .ts files.

However I'm experience some confusing results my code

This works

/* istanbul ignore file */
import classnames from 'classnames';
import React from 'react';

but this doesn't work (swapping imports order)

/* istanbul ignore file */
import React from 'react';
import classnames from 'classnames';

Adding a newline results in both working.

* Babel for ESLint import assertion: * https://stackoverflow.com/a/73225592 * https://stackoverflow.com/a/72167806 * DISABLE instanbul for inspecting JSON imports * facebook/create-react-app#6106 (comment)

bratanon · 2023-11-22T12:18:13Z

When using coverageProvider: "v8", the /* istanbul ignore file */ is totally ignored.

facebook/create-react-app#6106 (comment)

anonymous1654 · 2023-12-20T06:40:10Z

same issue

//istanbul ignore next works for individual functions, but /* istanbul ignore file */ doesn't work at all

raafaelgomees10 · 2024-04-04T21:18:33Z

When using coverageProvider: "v8", the /* istanbul ignore file */ is totally ignored.

Any istanbul ignore works when using `coverageProvider: "v8"...

/* istanbul ignore if */
/* istanbul ignore else */
/* istanbul ignore next */
/* istanbul ignore file */

AndreyTheWeb · 2024-05-08T07:24:29Z

FWIW, for me the file was was only ignored if I placed this comment at the top of the file and had a newline between it and the next block:

WORKS
/* istanbul ignore file */

import { Foo } from 'bar';
DOES NOT WORK
/* istanbul ignore file */
import { Foo } from 'bar';

If I use coverageProvider: “v8” then the whole file becomes covered, even if there is only one test.
I have a similar problem, /* istanbul ignore next */ does not work.

olegafx · 2025-04-30T17:08:58Z

If you're using it with vite/vitest, try to add @preserve to a comment:

/* istanbul ignore file @preserve */

Miqlo · 2025-04-30T17:42:56Z

/* istanbul ignore file @preserve */Carlos Benavides

mrmckeb self-assigned this Jan 4, 2019

stale bot added the stale label Feb 13, 2019

stale bot removed the stale label Feb 13, 2019

ianschmitz added issue: bug issue: needs investigation and removed issue: bug labels Feb 14, 2019

remarkablemark added a commit to lilboards/lilboards that referenced this issue Nov 27, 2023

test(src): fix istanbul ignore file by adding newline

ea44ffb

facebook/create-react-app#6106 (comment)

anonymous1654 mentioned this issue Dec 20, 2023

Exclude files from coverage gotwarlost/istanbul#118

Closed

iliapolo mentioned this issue Jan 1, 2025

chore(cli): function to turn yargs output to cliArguments aws/aws-cdk#32696

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Code coverage comments like `/* istanbul ignore file */` are ignored for jsx files #6106

Code coverage comments like `/* istanbul ignore file */` are ignored for jsx files #6106

dbartholomae commented Dec 31, 2018

mrmckeb commented Jan 4, 2019

dbartholomae commented Jan 4, 2019

mrmckeb commented Jan 6, 2019

dbartholomae commented Jan 6, 2019

FezVrasta commented Jan 14, 2019

stale bot commented Feb 13, 2019

FezVrasta commented Feb 13, 2019

mrmckeb commented Feb 18, 2019

dragonghy commented Jun 24, 2019

FezVrasta commented Aug 8, 2019

jensbodal commented Nov 5, 2019

nickserv commented Oct 25, 2020

bratanon commented Jun 6, 2022 •

edited

Loading

bratanon commented Nov 22, 2023

anonymous1654 commented Dec 20, 2023 •

edited

Loading

raafaelgomees10 commented Apr 4, 2024 •

edited

Loading

AndreyTheWeb commented May 8, 2024

olegafx commented Apr 30, 2025

Miqlo commented Apr 30, 2025

Code coverage comments like /* istanbul ignore file */ are ignored for jsx files #6106

Code coverage comments like /* istanbul ignore file */ are ignored for jsx files #6106

Comments

dbartholomae commented Dec 31, 2018

Is this a bug report?

Did you try recovering your dependencies?

Which terms did you search for in User Guide?

Environment

Steps to Reproduce

Expected Behavior

Actual Behavior

Reproducible Demo

mrmckeb commented Jan 4, 2019

dbartholomae commented Jan 4, 2019

mrmckeb commented Jan 6, 2019

dbartholomae commented Jan 6, 2019

FezVrasta commented Jan 14, 2019

stale bot commented Feb 13, 2019

FezVrasta commented Feb 13, 2019

mrmckeb commented Feb 18, 2019

dragonghy commented Jun 24, 2019

FezVrasta commented Aug 8, 2019

jensbodal commented Nov 5, 2019

nickserv commented Oct 25, 2020

bratanon commented Jun 6, 2022 • edited Loading

bratanon commented Nov 22, 2023

anonymous1654 commented Dec 20, 2023 • edited Loading

raafaelgomees10 commented Apr 4, 2024 • edited Loading

AndreyTheWeb commented May 8, 2024

olegafx commented Apr 30, 2025

Miqlo commented Apr 30, 2025

Code coverage comments like `/* istanbul ignore file */` are ignored for jsx files #6106

Code coverage comments like `/* istanbul ignore file */` are ignored for jsx files #6106

bratanon commented Jun 6, 2022 •

edited

Loading

anonymous1654 commented Dec 20, 2023 •

edited

Loading

raafaelgomees10 commented Apr 4, 2024 •

edited

Loading