Excluding files from coverage when using Mocha and Istanbul

Question

How can I exclude folders and files (by path) from coverage report when using mocha and instanbul?

I want to exclude by a configuration and not

/*istanbul ignore next*/

in each file.

(The generated report use by Jenkins)

Thanks,

How are you running Istanbul? I ask because there's a command line option to exclude files. — JME, Jun 07 '15 at 12:06
I run: `istanbul cover _mocha -- --recursive -R tap test/ > test.tap && istanbul report clover` — Shai M., Jun 07 '15 at 12:29

Blaise · Accepted Answer · 2016-01-28T09:10:51.277

21

You can ignore files matching a certain pattern using the -x parameter.

 istanbul help cover

 ...
 -x <exclude-pattern> [-x <exclude-pattern>]
        one or more fileset patterns e.g. "**/vendor/**"
 ...

edited Jan 28 '16 at 09:10

answered Jun 07 '15 at 14:09

Blaise

11,664
8
59
89

How to do this in the Config Files, e.g. GruntFile? – Steve K Sep 08 '15 at 15:37
Depends on what grunt library you use to wrap istanbul. In `grunt-karma` I'm excluding a folder (`app/tests`) like this: `{..., preprocessors['app/{*.js,!(tests)/**/*.js}'] = ['coverage'], ...}` – Blaise Oct 19 '15 at 12:56

Rob Johansen · Answer 2 · 2016-10-05T21:32:41.573

If you run istanbul help config you'll see istanbul's default configuration. You can copy/paste the default config into a .istanbul.yml file at the root of your source tree, then store the exclusions in it.

Here's what mine looks like (this makes it easy to exclude many directories):

verbose: false
instrumentation:
    root: .
    extensions:
        - .js
    default-excludes: true
    excludes: ['**/tinymce/**', '**/lib/**', '**/tools/**', '**/build/**']
    embed-source: false
    variable: __coverage__
    compact: true
    preserve-comments: false
    complete-copy: false
    save-baseline: false
    baseline-file: ./coverage/coverage-baseline.json
    include-all-sources: true
    include-pid: false
    es-modules: false
reporting:
    print: summary
    reports:
        - lcov
    dir: ./tools/coverage
    watermarks:
        statements: [50, 80]
        lines: [50, 80]
        functions: [50, 80]
        branches: [50, 80]
    report-config:
        clover: {file: clover.xml}
        cobertura: {file: cobertura-coverage.xml}
        json: {file: coverage-final.json}
        json-summary: {file: coverage-summary.json}
        lcovonly: {file: lcov.info}
        teamcity: {file: null, blockName: Code Coverage Summary}
        text: {file: null, maxCols: 0}
        text-lcov: {file: lcov.info}
        text-summary: {file: null}
hooks:
    hook-run-in-context: false
    post-require-hook: null
    handle-sigint: false
check:
    global:
        statements: 0
        lines: 0
        branches: 0
        functions: 0
        excludes: []
    each:
        statements: 0
        lines: 0
        branches: 0
        functions: 0
        excludes: []

Are you sure excludes works with include-all-sources set to true? instrumentation: root: src include-all-sources: true verbose: true excludes: ["\*\*/src/client/\*\*"] reporting: dir: "coverage" And I'm still getting client files in my report. — Will Lovett, Feb 15 '17 at 22:20

score 4 · Answer 3 · answered Jun 07 '15 at 22:01

I your case I would use the following:

istanbul -x "**/pattern/to/exclude/**" cover _mocha -- --recursive -R tap test/ > test.tap && istanbul report clover –  snoof 9 hours ago

You can exclude multiple patterns just by adding multiple -x options.

score 4 · Answer 4 · edited Aug 17 '17 at 13:36

4

Thanks for the suggestions,

This was the solution:

istanbul cover -x '**/config/**'  _mocha -- --recursive -R tap test/ > test.tap && istanbul report clover

edited Aug 17 '17 at 13:36

GhostCat

127,190
21
146
218

answered Jun 08 '15 at 14:13

Shai M.

1,164
3
13
28

Excluding files from coverage when using Mocha and Istanbul

4 Answers4