monocart-coverage-reports 2.0.6 → 2.0.8

package/README.md

@@ -19,6 +19,7 @@
 * [How to convert V8 to Istanbul](#how-to-convert-v8-to-istanbul)
     - [Using `v8-to-istanbul`](#using-v8-to-istanbul)
     - [How Monocart Works](#how-monocart-works)
+* [Ignoring Uncovered Lines](#ignoring-uncovered-lines)
 * [Chromium Coverage API](#chromium-coverage-api)
 * [Istanbul Introduction](#istanbul-introduction)
 * [Thanks](#thanks)
@@ -43,24 +44,6 @@ console.log(coverageResults.summary);
 - [lib/default/options.js](https://github.com/cenfun/monocart-coverage-reports/blob/main/lib/default/options.js)
 
 ## Available Reports
-```js
-const CoverageReport = require('monocart-coverage-reports');
-const options = {
-    outputDir: './coverage-reports',
-    reports: [
-        ['console-summary'],
-        ['v8'],
-        ['html', {
-            subdir: 'istanbul'
-        }],
-        ['json', {
-            file: 'my-json-file.json'
-        }],
-        'lcovonly'
-    ]
-}
-const coverageReport = new CoverageReport(options);
-```
 - `v8` (V8 data only)
     - [V8 html](https://cenfun.github.io/monocart-coverage-reports/v8) - Example for browser, build with webpack, and also [Rollup](https://cenfun.github.io/monocart-coverage-reports/v8-rollup) and [Esbuild](https://cenfun.github.io/monocart-coverage-reports/v8-esbuild)
     - [V8 Node](https://cenfun.github.io/monocart-coverage-reports/v8-node-env) - Example for Node.js using env, and also [V8 API](https://cenfun.github.io/monocart-coverage-reports/v8-node-api), [Inspector](https://cenfun.github.io/monocart-coverage-reports/v8-node-ins) and [CDP](https://cenfun.github.io/monocart-coverage-reports/v8-node-cdp)
@@ -94,6 +77,25 @@ const coverageReport = new CoverageReport(options);
 - `text-lcov`
 - `text-summary`
 
+```js
+const CoverageReport = require('monocart-coverage-reports');
+const options = {
+    outputDir: './coverage-reports',
+    reports: [
+        ['console-summary'],
+        ['v8'],
+        ['html', {
+            subdir: 'istanbul'
+        }],
+        ['json', {
+            file: 'my-json-file.json'
+        }],
+        'lcovonly'
+    ]
+}
+const coverageReport = new CoverageReport(options);
+```
+
 ## Integration
 - [monocart-reporter](https://cenfun.github.io/monocart-reporter/) - Test reporter for [Playwright](https://github.com/microsoft/playwright)
 - [vitest-monocart-coverage](https://github.com/cenfun/vitest-monocart-coverage) - Integration with [Vitest](https://github.com/vitest-dev/vitest) coverage
@@ -165,8 +167,9 @@ console.log(coverageResults.summary);
 
 ## Collecting V8 Coverage Data
 - For source code: enable `sourcemap` and do not compress/minify:
-    - Webpack: with `source-map` [devtool](https://webpack.js.org/configuration/devtool/) and `development` [mode](https://webpack.js.org/configuration/mode/), example [webpack.config-v8.js](https://github.com/cenfun/monocart-coverage-reports/blob/main/test/webpack.config-v8.js)
-    - Rollup: [options](https://rollupjs.org/configuration-options/) `sourcemap: true`
+    - Webpack: build with `source-map` [devtool](https://webpack.js.org/configuration/devtool/) and `development` [mode](https://webpack.js.org/configuration/mode/), example [webpack.config-v8.js](https://github.com/cenfun/monocart-coverage-reports/blob/main/test/webpack.config-v8.js)
+    - Rollup: build with [options](https://rollupjs.org/configuration-options/) `sourcemap: true`
+    - Vite: build with [options](https://vitejs.dev/config/build-options.html) `sourcemap: true` and `minify: false` 
 - Browser (Chromium Only)
     > Collecting coverage data with [Chromium Coverage API](#chromium-coverage-api), see [example](https://github.com/cenfun/monocart-coverage-reports/blob/main/test/test-v8.js)
 - Node.js
@@ -246,11 +249,9 @@ functions.forEach(block => {
             // Problem: not every block is branch, and the first block is actually function.
             if (block.functionName && i === 0) {
                 // v8-to-istanbul: count range as function here. 
-                // Problem: there is no function name if the function is anonymous or expression.
             }
         } else if (block.functionName) {
             // v8-to-istanbul: count range as function here. 
-            // Problem: same as above function.
         }
     }
 });
@@ -271,6 +272,28 @@ We have removed `v8-to-istanbul` because of the two major problems and implement
 | LogicalExpression | ✔ Not Perfect | 
 | SwitchStatement | ✔ Not Perfect | 
 
+## Ignoring Uncovered Codes
+To ignore codes, use the special comment which starts with `v8 ignore `:
+- ignoring all until told
+```js
+/* v8 ignore start */
+function uncovered() {
+}
+/* v8 ignore stop */
+```
+- ignoring the next line or next N lines
+```js
+/* v8 ignore next */
+const os = platform === 'wind32' ? 'Windows' : 'Other';
+
+const os = platform === 'wind32' ? 'Windows' /* v8 ignore next */ : 'Other';
+
+/* v8 ignore next 3 */
+if (platform === 'linux') {
+    console.info('hello linux');
+}
+```
+
 ## Chromium Coverage API
 - [V8 coverage report](https://v8.dev/blog/javascript-code-coverage) - Native support for JavaScript code coverage to V8. (Chromium only)
 - [Puppeteer Coverage Class](https://pptr.dev/api/puppeteer.coverage)

package/lib/converter/ast.js

@@ -3,9 +3,8 @@ const {
 } = require('../packages/monocart-coverage-vendor.js');
 const Util = require('../utils/util.js');
 
-const {
-    createBranches, collectBranches, findInRanges
-} = require('./branches.js');
+const { createBranches, collectBranches } = require('./branches.js');
+const findInRanges = require('./find-in-ranges.js');
 
 const getFunctionRange = (start, end, state) => {
 

package/lib/converter/branches.js

@@ -1,40 +1,5 @@
 const Util = require('../utils/util.js');
-
-const quickFindRange = (position, ranges) => {
-    let start = 0;
-    let end = ranges.length - 1;
-    while (end - start > 1) {
-        const i = Math.floor((start + end) * 0.5);
-        const item = ranges[i];
-        if (position < item.startOffset) {
-            end = i;
-            continue;
-        }
-        if (position > item.endOffset) {
-            start = i;
-            continue;
-        }
-        return ranges[i];
-    }
-    // last two items, less is start
-    const endItem = ranges[end];
-    if (position < endItem.startOffset) {
-        return ranges[start];
-    }
-    return ranges[end];
-};
-
-
-const findInRanges = (start, end, ranges) => {
-    if (!Util.isList(ranges)) {
-        return;
-    }
-    const range = quickFindRange(start, ranges);
-    if (start >= range.startOffset && end <= range.endOffset) {
-        return range;
-    }
-};
-
+const findInRanges = require('./find-in-ranges.js');
 
 const findBranchBlock = (start, end, functionInfo) => {
     const { range } = functionInfo;
@@ -432,7 +397,6 @@ const collectBranches = (branchMap) => {
 };
 
 module.exports = {
-    findInRanges,
     createBranches,
     collectBranches
 };