Skip to content

Commit 90949fa

Browse files
connorjclarkconnorjclark
authored
feat: support ignore start/stop comment (bcoe#273)
Fixes bcoe#271
1 parent ebe92de commit 90949fa

7 files changed

+83
-29
lines changed

‎README.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,15 @@ To ignore lines, blocks, and functions, use the special comment:
6464

6565
`/* c8 ignore next */`.
6666

67-
### Ignoring the next element
67+
### Ignoring the next line
6868

6969
```js
7070
const myVariable = 99
7171
/* c8 ignore next */
7272
if (process.platform === 'win32') console.info('hello world')
7373
```
7474

75-
### Ignoring the next N elements
75+
### Ignoring the next N lines
7676

7777
```js
7878
const myVariable = 99
@@ -82,6 +82,16 @@ if (process.platform === 'win32') {
8282
}
8383
```
8484

85+
### Ignoring all lines until told
86+
87+
```js
88+
/* c8 ignore start */
89+
function dontMindMe() {
90+
// ...
91+
}
92+
/* c8 ignore stop */
93+
```
94+
8595
### Ignoring a block on the current line
8696

8797
```js

‎package-lock.json

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
"istanbul-reports": "^3.0.2",
4444
"rimraf": "^3.0.0",
4545
"test-exclude": "^6.0.0",
46-
"v8-to-istanbul": "^7.0.0",
46+
"v8-to-istanbul": "^7.1.0",
4747
"yargs": "^16.0.0",
4848
"yargs-parser": "^20.0.0"
4949
},

‎test/fixtures/c8-ignore-start-stop.js

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
const a = 99
2+
const b = true ? 1 : 2
3+
if (true) {
4+
console.info('covered')
5+
/* c8 ignore start */
6+
} else {
7+
console.info('uncovered')
8+
}
9+
/* c8 ignore stop */
10+
11+
/* c8 ignore start */ 'ignore me'
12+
function notExecuted () {
13+
14+
}
15+
/* c8 ignore stop */
16+
17+
if (true) {
18+
console.info('covered')
19+
} else { /* c8 ignore start */
20+
console.info('uncovered')
21+
}

‎test/integration.js

+15-1
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ describe('c8', () => {
272272
c8Path,
273273
'--exclude="test/*.js"',
274274
'--clean=false',
275-
'--temp-directory=tmp/normal',
275+
'--temp-directory=tmp/special-comment',
276276
nodePath,
277277
require.resolve('./fixtures/c8-ignore-next.js')
278278
])
@@ -294,6 +294,20 @@ describe('c8', () => {
294294
})
295295
})
296296

297+
describe('/* c8 ignore start/stop */', () => {
298+
it('ignores lines with special comment', () => {
299+
const { output } = spawnSync(nodePath, [
300+
c8Path,
301+
'--exclude="test/*.js"',
302+
'--clean=false',
303+
'--temp-directory=tmp/start-stop',
304+
nodePath,
305+
require.resolve('./fixtures/c8-ignore-start-stop.js')
306+
])
307+
output.toString('utf8').should.matchSnapshot()
308+
})
309+
})
310+
297311
describe('source-maps', () => {
298312
beforeEach(cb => rimraf('tmp/source-map', cb))
299313

‎test/integration.js.snap

+13-3
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,24 @@ covered
1616
-------------------|---------|----------|---------|---------|-------------------
1717
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
1818
-------------------|---------|----------|---------|---------|-------------------
19-
All files | 86.21 | 91.67 | 66.67 | 86.21 |
20-
async.js | 100 | 100 | 100 | 100 |
19+
All files | 90.91 | 100 | 100 | 90.91 |
2120
c8-ignore-next.js | 90.91 | 100 | 100 | 90.91 | 21-22
22-
normal.js | 75 | 66.67 | 33.33 | 75 | 14-16,18-20
2321
-------------------|---------|----------|---------|---------|-------------------
2422
,"
2523
`;
2624

25+
exports[`c8 /* c8 ignore start/stop */ ignores lines with special comment 1`] = `
26+
",covered
27+
covered
28+
-------------------------|---------|----------|---------|---------|-------------------
29+
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
30+
-------------------------|---------|----------|---------|---------|-------------------
31+
All files | 100 | 75 | 100 | 100 |
32+
c8-ignore-start-stop.js | 100 | 75 | 100 | 100 | 2
33+
-------------------------|---------|----------|---------|---------|-------------------
34+
,"
35+
`;
36+
2737
exports[`c8 --all reports coverage for unloaded js files as 0 for line, branch and function 1`] = `
2838
",zero
2939
positive

‎test/integration.js_10.snap

+18-19
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,24 @@ All files | 100 | 100 | 100 | 100 |
1313
exports[`c8 /* c8 ignore next */ ignores lines with special comment 1`] = `
1414
",covered
1515
covered
16-
--------------------------|---------|----------|---------|---------|--------------------------------
17-
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
18-
--------------------------|---------|----------|---------|---------|--------------------------------
19-
All files | 76.18 | 61.18 | 68.57 | 76.18 |
20-
bin | 78.85 | 60 | 66.67 | 78.85 |
21-
c8.js | 78.85 | 60 | 66.67 | 78.85 | 22,27-29,32-33,41-43,50-51
22-
lib | 80.67 | 52.73 | 84.21 | 80.67 |
23-
is-cjs-esm-bridge.js | 90 | 25 | 100 | 90 | 9
24-
parse-args.js | 96.13 | 45.45 | 100 | 96.13 | 109-110,118-119,132-133
25-
report.js | 75.17 | 60 | 84.62 | 75.17 | ...206,237-238,264-265,271-273
26-
source-map-from-file.js | 44 | 100 | 0 | 44 | 10-23
27-
lib/commands | 44.44 | 75 | 16.67 | 44.44 |
28-
check-coverage.js | 21.31 | 100 | 0 | 21.31 | 9-11,14-27,30-44,46-61
29-
report.js | 93.1 | 71.43 | 50 | 93.1 | 9-10
30-
test/fixtures | 86.21 | 91.67 | 71.43 | 86.21 |
31-
async.js | 100 | 100 | 100 | 100 |
32-
c8-ignore-next.js | 90.91 | 100 | 100 | 90.91 | 21-22
33-
normal.js | 75 | 66.67 | 33.33 | 75 | 14-16,18-20
34-
--------------------------|---------|----------|---------|---------|--------------------------------
16+
-------------------|---------|----------|---------|---------|-------------------
17+
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
18+
-------------------|---------|----------|---------|---------|-------------------
19+
All files | 90.91 | 100 | 100 | 90.91 |
20+
c8-ignore-next.js | 90.91 | 100 | 100 | 90.91 | 21-22
21+
-------------------|---------|----------|---------|---------|-------------------
22+
,"
23+
`;
24+
25+
exports[`c8 /* c8 ignore start/stop */ ignores lines with special comment 1`] = `
26+
",covered
27+
covered
28+
-------------------------|---------|----------|---------|---------|-------------------
29+
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
30+
-------------------------|---------|----------|---------|---------|-------------------
31+
All files | 100 | 75 | 100 | 100 |
32+
c8-ignore-start-stop.js | 100 | 75 | 100 | 100 | 2
33+
-------------------------|---------|----------|---------|---------|-------------------
3534
,"
3635
`;
3736

0 commit comments

Comments
 (0)