Excluding files from coverage when using Karma and Istanbul

Question

I am using Karma to test my JavaScript and get coverage reports. I am using the Istanbul coverage report, which is the default. Here is my preprocessors parameter:

    preprocessors: {
        'framework/**/*.js':'coverage',            
        'framework/*.js':'coverage',
        '!framework/node/**/*.js':'coverage',         
        '!framework/test/**/*.js':'coverage',                                 
        'framework-lib/**/*.js':'coverage',
        '!framework-lib/tool-data-api/tool-data-api.js':'coverage'
    }

As you can see, I am trying to use the "!" as a negate command, which usually works with Node. However, it is not working here and none of my directories are being excluded.

Is there any way to do what I am trying to accomplish?

Just do not write the patterns/files you do not want to be covered. Or in case you need to preprocess them, just not write `coverage` as preprocessor in the list (for each file you can either specify a string or a list of strings). — MarcoL, Mar 20 '14 at 10:52
If you want to use the `!` to exclude paths it won't work: see this issue: https://github.com/karma-runner/karma/issues/440 — MarcoL, Mar 31 '14 at 08:37

Jon Hieb · Answer 1 · 2015-02-11T00:55:44.500

According to https://karma-runner.github.io/0.12/config/configuration-file.html:

**/*.js: All files with a "js" extension in all subdirectories
**/!(jquery).js: Same as previous, but excludes "jquery.js"
**/(foo|bar).js: In all subdirectories, all "foo.js" or "bar.js" files

So, based on this, I tried the following:

preprocessors: {
    'framework/**/!(node|test)/*.js': 'coverage',
    'framework-lib/**/!(tool-data-api).js': 'coverage'
}

Which seems to have accomplished what you are looking for.

As a note to others who come here looking for how to target all files EXCEPT .spec.js files, try:

'**/!(*spec).js'

Which seems to work for me.

score 3 · Answer 2 · answered May 13 '14 at 14:46

3

In the Karma used minimatch.js lib for mathing files. So you need rewrite you rules. For instance to exclude folder node node it should has

preprocessors: {
        'framework/*[!node]/*.js':'coverage',            
    }

answered May 13 '14 at 14:46

Alexandr Skachkov

550
4
8

3

minimatch.js uses extglob syntax which is the weirdest beast I've seen so far: http://mywiki.wooledge.org/glob#extglob – Kamil Szot Jul 22 '14 at 09:24
how would you ignore any node_modules folders? – SuperUberDuper Apr 07 '16 at 13:12

score 1 · Answer 3 · answered May 01 '14 at 15:15

I'm not sure if you are running "istanbul cover ..." to run your coverage report, but if you are, you can use the -x flag to exclude files/patterns. Typing in "istanbul help cover" will show you usage including this.

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

score 0 · Answer 4 · answered Apr 21 '14 at 15:53

0

Make sure that the directories / file you want to exclude are not loaded by any other include. for example, 'framework//.js':'coverage' will load files you are trying to exclude in '!framework/node//.js':'coverage'

answered Apr 21 '14 at 15:53

GP2

2,328
1
14
6

1

So how would you get ALL files from a directory EXCEPT `*spec.js` files? – Catfish Jun 03 '14 at 16:08

score 0 · Answer 5 · answered Nov 10 '22 at 16:11

0

you can modify in angular.json under test->options

"codeCoverageExclude": ["src/testing/**/*"]

answered Nov 10 '22 at 16:11

oezkany

201
3
10

Excluding files from coverage when using Karma and Istanbul

5 Answers5