Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Map code coverage from transformers #2290

Merged
merged 10 commits into from
Mar 3, 2017
Merged

Map code coverage from transformers #2290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
835df36
source map support for coverage
jwbay Sep 10, 2016
6ad632d
be less dangerous
jwbay Feb 2, 2017
04cda59
lazy require for istanbul-lib-source-maps
jwbay Feb 7, 2017
4b6011f
add documentation for mapCoverage config option
jwbay Feb 9, 2017
ff8941a
store source maps on disk instead of in worker process memory
jwbay Feb 13, 2017
ad11e77
add mapCoverage to CLI, switch off by default
jwbay Feb 13, 2017
ecbde20
move source map info from coverage object to jest-runtime
jwbay Feb 16, 2017
998c640
Merge remote-tracking branch 'origin/master' into map-coverage-runtime
jwbay Feb 23, 2017
6a3ac5d
Merge remote-tracking branch 'origin/master' into map-coverage
jwbay Feb 24, 2017
254c619
tweak docs, fix a test
jwbay Feb 24, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions dangerfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,9 @@ const raiseIssueAboutPaths = (
};

const newJsFiles = danger.git.created_files.filter(path => path.endsWith('js'));
const isNotInTestFiles = path => !(includes(path, '__tests__')
|| includes(path, '__mocks__'));
const isSourceFile = path =>
includes(path, '/src/') &&
!includes(path, '__tests__');

// New JS files should have the FB copyright header + flow
const facebookLicenseHeaderComponents = [
Expand Down Expand Up @@ -80,7 +81,7 @@ if (noFBCopyrightFiles.length > 0) {
// Ensure the majority of all files use Flow
// Does not run for test files, and also offers a warning not an error.
const noFlowFiles = newJsFiles
.filter(isNotInTestFiles)
.filter(isSourceFile)
.filter(filepath => {
const content = fs.readFileSync(filepath).toString();
return !includes(content, '@flow');
Expand Down
17 changes: 17 additions & 0 deletions docs/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,23 @@ For example, the following would create a global `__DEV__` variable set to `true

Note that, if you specify a global reference value (like an object or array) here, and some code mutates that value in the midst of running a test, that mutation will *not* be persisted across test runs for other test files.

### `mapCoverage` [boolean]

##### available in Jest **20.0.0+**

Default: `false`

If you have [transformers](#transform-object-string-string) configured that emit source maps, Jest will use them to try and map code coverage against the original source code when writing [reports](#coveragereporters-array-string) and checking [thresholds](#coveragethreshold-object). This is done on a best-effort basis as some compile-to-JavaScript languages may provide more accurate source maps than others. This can also be resource-intensive. If Jest is taking a long time to calculate coverage at the end of a test run, try setting this option to `false`.

Both inline source maps and source maps returned directly from a transformer are supported. Source map URLs are not supported because Jest may not be able to locate them. To return source maps from a transformer, the `process` function can return an object like the following. The `map` property may either be the source map object, or the source map object as a JSON string.

```js
return {
code: 'the code',
map: 'the source map',
};
```

### `moduleFileExtensions` [array<string>]
Default: `["js", "json", "jsx", "node"]`

Expand Down
348 changes: 348 additions & 0 deletions integration_tests/__tests__/__snapshots__/coverage-remapping-test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,348 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`maps code coverage against original source 1`] = `
Object {
"covered.ts": Object {
"b": Object {
"0": Array [
1,
0,
],
"1": Array [
1,
0,
],
"2": Array [
1,
0,
0,
],
"3": Array [
1,
0,
],
},
"branchMap": Object {
"0": Object {
"loc": Object {
"end": Object {
"column": 9,
"line": 5,
},
"start": Object {
"column": 8,
"line": 5,
},
},
"locations": Array [
Object {
"end": Object {
"column": 9,
"line": 5,
},
"start": Object {
"column": 8,
"line": 5,
},
},
Object {
"end": Object {
"column": 9,
"line": 6,
},
"start": Object {
"column": 8,
"line": 6,
},
},
],
"type": "cond-expr",
},
"1": Object {
"loc": Object {
"end": Object {
"column": 37,
"line": 7,
},
"start": Object {
"column": 36,
"line": 7,
},
},
"locations": Array [
Object {
"end": Object {
"column": 37,
"line": 7,
},
"start": Object {
"column": 36,
"line": 7,
},
},
Object {
"end": Object {
"column": 41,
"line": 7,
},
"start": Object {
"column": 40,
"line": 7,
},
},
],
"type": "cond-expr",
},
"2": Object {
"loc": Object {
"end": Object {
"column": 33,
"line": 8,
},
"start": Object {
"column": 29,
"line": 8,
},
},
"locations": Array [
Object {
"end": Object {
"column": 33,
"line": 8,
},
"start": Object {
"column": 29,
"line": 8,
},
},
Object {
"end": Object {
"column": 41,
"line": 8,
},
"start": Object {
"column": 37,
"line": 8,
},
},
Object {
"end": Object {
"column": 50,
"line": 8,
},
"start": Object {
"column": 45,
"line": 8,
},
},
],
"type": "binary-expr",
},
"3": Object {
"loc": Object {
"end": Object {
"column": 42,
"line": 9,
},
"start": Object {
"column": 32,
"line": 9,
},
},
"locations": Array [
Object {
"end": Object {
"column": 42,
"line": 9,
},
"start": Object {
"column": 32,
"line": 9,
},
},
Object {
"end": Object {
"column": 55,
"line": 9,
},
"start": Object {
"column": 45,
"line": 9,
},
},
],
"type": "cond-expr",
},
},
"f": Object {
"0": 1,
"1": 0,
"2": 0,
},
"fnMap": Object {
"0": Object {
"decl": Object {
"end": Object {
"column": 28,
"line": 3,
},
"start": Object {
"column": 9,
"line": 3,
},
},
"loc": Object {
"end": Object {
"column": 1,
"line": 12,
},
"start": Object {
"column": 49,
"line": 3,
},
},
"name": "difference",
},
"1": Object {
"decl": Object {
"end": Object {
"column": 37,
"line": 9,
},
"start": Object {
"column": 32,
"line": 9,
},
},
"loc": Object {
"end": Object {
"column": 42,
"line": 9,
},
"start": Object {
"column": 32,
"line": 9,
},
},
"name": "(anonymous_1)",
},
"2": Object {
"decl": Object {
"end": Object {
"column": 50,
"line": 9,
},
"start": Object {
"column": 45,
"line": 9,
},
},
"loc": Object {
"end": Object {
"column": 55,
"line": 9,
},
"start": Object {
"column": 45,
"line": 9,
},
},
"name": "(anonymous_2)",
},
},
"path": "covered.ts",
"s": Object {
"0": 1,
"1": 1,
"2": 1,
"3": 1,
"4": 1,
"5": 0,
"6": 0,
"7": 1,
},
"statementMap": Object {
"0": Object {
"end": Object {
"column": 1,
"line": 12,
},
"start": Object {
"column": 0,
"line": 3,
},
},
"1": Object {
"end": Object {
"column": 9,
"line": 6,
},
"start": Object {
"column": 29,
"line": 4,
},
},
"2": Object {
"end": Object {
"column": 41,
"line": 7,
},
"start": Object {
"column": 29,
"line": 7,
},
},
"3": Object {
"end": Object {
"column": 50,
"line": 8,
},
"start": Object {
"column": 29,
"line": 8,
},
},
"4": Object {
"end": Object {
"column": 55,
"line": 9,
},
"start": Object {
"column": 25,
"line": 9,
},
},
"5": Object {
"end": Object {
"column": 42,
"line": 9,
},
"start": Object {
"column": 38,
"line": 9,
},
},
"6": Object {
"end": Object {
"column": 55,
"line": 9,
},
"start": Object {
"column": 51,
"line": 9,
},
},
"7": Object {
"end": Object {
"column": 17,
"line": 11,
},
"start": Object {
"column": 4,
"line": 11,
},
},
},
},
}
`;
Loading