monocart-coverage-reports 2.3.1 → 2.3.3

package/README.md

@@ -23,13 +23,13 @@
 * [Node.js V8 Coverage Report for Server Side](#nodejs-v8-coverage-report-for-server-side)
 * [Multiprocessing Support](#multiprocessing-support)
 * [Merge Coverage Reports](#merge-coverage-reports)
-* [Integration](#integration)
 * [Ignoring Uncovered Codes](#ignoring-uncovered-codes)
 * [Chromium Coverage API](#chromium-coverage-api)
 * [V8 Coverage Data Format](#v8-coverage-data-format)
 * [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)
+* [Integration](#integration) - Playwright, Jest, Vitest, Codecov, Coveralls, Sonar Cloud
 * [Istanbul Introduction](#istanbul-introduction)
 * [Thanks](#thanks)
 
@@ -342,7 +342,7 @@ Possible solutions:
     - Sets Node.js env `NODE_V8_COVERAGE`=`dir` before the program running, the coverage data will be saved to the `dir` after the program exits gracefully.
     - Read the JSON file(s) from the `dir` and generate coverage report.
     - Example:
-    > cross-env NODE_V8_COVERAGE=`.temp/v8-coverage-env` node [./test/test-node-env.js](./test/test-node-env.js) && node [./test/generate-node-report.js](./test/generate-node-report.js)
+    > cross-env NODE_V8_COVERAGE=`.temp/v8-coverage-env` node [./test/test-node-env.js](./test/test-node-env.js) && node [./test/generate-report.js](./test/generate-report.js)
 
 - [V8](https://nodejs.org/docs/latest/api/v8.html#v8takecoverage) API + NODE_V8_COVERAGE
     - Writing the coverage started by NODE_V8_COVERAGE to disk on demand with `v8.takeCoverage()`, it does not require waiting until the program exits gracefully.
@@ -460,11 +460,6 @@ const coverageOptions = {
 ```
 see example: [./test/test-merge.js](./test/test-merge.js)
 
-## Integration
-- [monocart-reporter](https://cenfun.github.io/monocart-reporter/) - Test reporter for [Playwright](https://github.com/microsoft/playwright)
-- [jest-monocart-coverage](https://github.com/cenfun/jest-monocart-coverage) - Integration with [Jest](https://github.com/jestjs/jest/) for coverage reports
-- [vitest-monocart-coverage](https://github.com/cenfun/vitest-monocart-coverage) - Integration with [Vitest](https://github.com/vitest-dev/vitest) for coverage reports
-
 ## Ignoring Uncovered Codes
 To ignore codes, use the special comment which starts with `v8 ignore `:
 - Ignoring all until stop
@@ -582,6 +577,58 @@ We implemented new converter instead of v8-to-istanbul:
 | LogicalExpression     | ✔ Not Perfect | 
 | SwitchStatement       | ✔ Not Perfect | 
 
+## Integration
+- [monocart-reporter](https://github.com/cenfun/monocart-reporter) - A [Playwright](https://github.com/microsoft/playwright) custom reporter, supports generating [Code Coverage Report](https://github.com/cenfun/monocart-reporter?#code-coverage-report)
+- [jest-monocart-coverage](https://github.com/cenfun/jest-monocart-coverage) - A [Jest](https://github.com/jestjs/jest/) custom reporter for coverage reports
+- [vitest-monocart-coverage](https://github.com/cenfun/vitest-monocart-coverage) - A [Vitest](https://github.com/vitest-dev/vitest) custom provider module for coverage reports
+- [Codecov](https://codecov.com/) 
+    - [![codecov](https://codecov.io/gh/cenfun/monocart-coverage-reports/graph/badge.svg?token=H0LW7UKYU3)](https://codecov.io/gh/cenfun/monocart-coverage-reports)
+    - Supports native `codecov` built-in report ([specification](https://docs.codecov.com/docs/codecov-custom-coverage-format))
+    ```js
+    const coverageOptions = {
+        outputDir: "./coverage-reports",
+        reports: [
+            ['codecov']
+        ]
+    };
+    ```
+    - Github Actions example:
+    ```yml
+    - name: Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          files: ./coverage-reports/codecov.json
+    ```
+- [Coveralls](https://coveralls.io/)
+    - [![Coverage Status](https://coveralls.io/repos/github/cenfun/monocart-coverage-reports/badge.svg?branch=main)](https://coveralls.io/github/cenfun/monocart-coverage-reports?branch=main)
+    - Github Actions example:
+    ```yml
+    - name: Coveralls
+        uses: coverallsapp/github-action@v2
+        with:
+          files: ./coverage-reports/lcov.info
+    ```
+ - [Sonar Cloud](https://sonarcloud.io/)
+    - [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=monocart-coverage-reports&metric=coverage)](https://sonarcloud.io/summary/new_code?id=monocart-coverage-reports)
+    - Github Actions example:
+    ```yml
+    - name: Analyze with SonarCloud
+        uses: sonarsource/sonarcloud-github-action@master
+        env: 
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          projectBaseDir: ./
+          args: >
+            -Dsonar.organization=cenfun
+            -Dsonar.projectKey=monocart-coverage-reports
+            -Dsonar.projectName=monocart-coverage-reports
+            -Dsonar.javascript.lcov.reportPaths=docs/mcr/lcov.info
+            -Dsonar.sources=lib
+            -Dsonar.tests=test
+            -Dsonar.exclusions=dist/*,packages/*
+    ```
+
+
 ## Istanbul Introduction
 - [Istanbul coverage report](https://istanbul.js.org/) - Instrumenting source codes and generating coverage reports
 - [babel-plugin-istanbul](https://github.com/istanbuljs/babel-plugin-istanbul)

package/lib/cli.js

@@ -16,12 +16,7 @@ const defaultOptions = require('./default/options.js');
 const version = require('../package.json').version;
 
 const cleanDir = (dir) => {
-    if (fs.existsSync(dir)) {
-        fs.rmSync(dir, {
-            recursive: true,
-            force: true
-        });
-    }
+    Util.rmSync(dir);
 };
 
 const initOptions = (cliOptions) => {
@@ -127,6 +122,7 @@ program
     .option('-o, --outputDir <dir>', 'output dir for reports')
     .option('-r, --reports <name[,name]>', 'coverage reports to use')
     .option('-n, --name <name>', 'report name for title')
+    .option('-i, --inputDir <dir>', 'input dir for merging raw files')
 
     .option('--outputFile <path>', 'output file for v8 report')
     .option('--inline', 'inline html for v8 report')

package/lib/converter/ast.js

@@ -43,7 +43,7 @@ const collectAstInfo = (ast, state) => {
             count: functionRoot.count,
             range: functionRoot
         };
-        createBranches(ast, rootFunctionInfo, branchMap);
+        createBranches(rootFunctionInfo, branchMap, ast);
     }
 
     // functions branches
@@ -63,7 +63,7 @@ const collectAstInfo = (ast, state) => {
         },
 
         // Function include FunctionDeclaration, ArrowFunctionExpression, FunctionExpression
-        Function(node) {
+        Function(node, parents) {
 
             const {
                 start, end, id
@@ -94,7 +94,7 @@ const collectAstInfo = (ast, state) => {
 
             functions.push(functionInfo);
 
-            createBranches(node.body, functionInfo, branchMap);
+            createBranches(functionInfo, branchMap, node.body, node.params, parents);
 
         }
 

package/lib/converter/branches.js

@@ -146,12 +146,30 @@ const addNodeCount = (node, parents, functionInfo) => {
 
 // =======================================================================================
 
-const createBranches = (ast, functionInfo, branchMap) => {
+const addAssignmentPattern = (params, parents, functionInfo, branchMap, locationMap) => {
+    if (!Util.isList(params)) {
+        return;
+    }
+
+    params.forEach((param) => {
+        if (param.type !== 'AssignmentPattern') {
+            return;
+        }
+        const start = param.start;
+        const group = createBranchGroup('AssignmentPattern', start, parents, branchMap, functionInfo);
+        addBranch(group, param, locationMap, functionInfo);
+    });
+};
+
+const createBranches = (functionInfo, branchMap, body, params, functionParents = []) => {
 
     // locationMap for chain LogicalExpression locations
     const locationMap = new Map();
 
-    Util.visitAst(ast, {
+    // function's arguments
+    addAssignmentPattern(params, functionParents, functionInfo, branchMap, locationMap);
+
+    Util.visitAst(body, {
 
         Function() {
             return 'break';
@@ -195,7 +213,7 @@ const createBranches = (ast, functionInfo, branchMap) => {
 
         // binary-expr
         // var b = a || b || c;
-        // do not using BinaryExpression
+        // do not use BinaryExpression
         LogicalExpression: (node, parents) => {
             addNodeCount(node, parents, functionInfo);
 
@@ -245,10 +263,6 @@ const createBranches = (ast, functionInfo, branchMap) => {
             });
         }
 
-        // default-arg - seems that V8 coverage do NOT supported
-        // (a = 0) => {}
-        // AssignmentPattern: (node) => {}
-
     });
 
 };
@@ -367,7 +381,10 @@ const updateBranchCount = (group) => {
         SwitchStatement
     };
 
-    handlers[type](group, parentCount, noBlockList, blockCount);
+    const handler = handlers[type];
+    if (handler) {
+        handler(group, parentCount, noBlockList, blockCount);
+    }
 
 };
 

package/lib/converter/collect-source-maps.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 const EC = require('eight-colors');
-const { fileURLToPath } = require('url');
+const { fileURLToPath, pathToFileURL } = require('url');
 const Concurrency = require('../platform/concurrency.js');
 const { convertSourceMap, axios } = require('../packages/monocart-coverage-vendor.js');
 
@@ -21,7 +21,7 @@ const request = async (options) => {
 
 const loadSourceMap = async (url = '') => {
 
-    if (url.startsWith('file://')) {
+    if (url.startsWith('file:')) {
         const p = fileURLToPath(url);
         const content = Util.readFileSync(p);
         if (!content) {
@@ -55,6 +55,10 @@ const getSourceMapUrl = (content, url) => {
     // for some odd reason //# .. captures in 1 and /* .. */ in 2
     const filename = r[1] || r[2];
 
+    if (!URL.canParse(filename, url)) {
+        url = pathToFileURL(url).toString();
+    }
+
     let mapUrl;
 
     try {

package/lib/converter/find-in-ranges.js

@@ -1,16 +1,16 @@
 const Util = require('../utils/util.js');
 
-const quickFindRange = (position, ranges) => {
+const quickFindRange = (position, ranges, startKey, endKey) => {
     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) {
+        if (position < item[startKey]) {
             end = i;
             continue;
         }
-        if (position > item.endOffset) {
+        if (position > item[endKey]) {
             start = i;
             continue;
         }
@@ -18,19 +18,19 @@ const quickFindRange = (position, ranges) => {
     }
     // last two items, less is start
     const endItem = ranges[end];
-    if (position < endItem.startOffset) {
+    if (position < endItem[startKey]) {
         return ranges[start];
     }
     return ranges[end];
 };
 
 
-const findInRanges = (start, end, ranges) => {
+const findInRanges = (start, end, ranges, startKey = 'startOffset', endKey = 'endOffset') => {
     if (!Util.isList(ranges)) {
         return;
     }
-    const range = quickFindRange(start, ranges);
-    if (start >= range.startOffset && end <= range.endOffset) {
+    const range = quickFindRange(start, ranges, startKey, endKey);
+    if (start >= range[startKey] && end <= range[endKey]) {
         return range;
     }
 };

package/lib/converter/ignore.js

@@ -26,7 +26,13 @@ const getNextN = (content, currentLine, item, locator) => {
 
 const addNextIgnore = (list, content, item, locator) => {
 
-    const { lineParser } = locator;
+    const { lineParser, source } = locator;
+    const maxLength = source.length;
+    let startOffset = item.start;
+    // extend left
+    while (startOffset > 0 && Util.isBlank(source[startOffset - 1])) {
+        startOffset -= 1;
+    }
 
     // findLine 0-base
     const currentLine = lineParser.findLine(item.end);
@@ -37,18 +43,34 @@ const addNextIgnore = (list, content, item, locator) => {
     // getLine 1-base
     const line = currentLine.line + 1;
     const endLine = locator.getLine(line + n);
-    const endOffset = endLine ? endLine.end : locator.source.length;
+    let endOffset = endLine ? endLine.end : maxLength;
+    // extend right
+    while (endOffset < maxLength && Util.isBlank(source[endOffset + 1])) {
+        endOffset += 1;
+    }
 
     const nextItem = {
         type: 'next',
         n,
-        startOffset: item.end,
+        startOffset,
         endOffset
     };
 
     list.push(nextItem);
 };
 
+// both v8 or c8
+const hasIgnoreKey = (content) => {
+    const v8Key = 'v8 ignore';
+    if (content.startsWith(v8Key)) {
+        return v8Key.length;
+    }
+    const c8Key = 'c8 ignore';
+    if (content.startsWith(c8Key)) {
+        return c8Key.length;
+    }
+};
+
 const getIgnoredRanges = (locator, options) => {
     if (!options.v8Ignore) {
         return;
@@ -71,17 +93,17 @@ const getIgnoredRanges = (locator, options) => {
         let content = block ? text.slice(2, -2) : text.slice(2);
         content = content.trim();
 
-        const v8IgnoreKey = 'v8 ignore';
-        if (!content.startsWith(v8IgnoreKey)) {
+        const ignoreKey = hasIgnoreKey(content);
+        if (!ignoreKey) {
             return;
         }
 
-        content = content.slice(v8IgnoreKey.length).trim();
+        content = content.slice(ignoreKey).trim();
 
         if (ignoreStart) {
             // v8 ignore stop
             if (content === 'stop') {
-                ignoreStart.endOffset = start;
+                ignoreStart.endOffset = end;
                 ignoreStart = null;
             }
             return;
@@ -91,9 +113,9 @@ const getIgnoredRanges = (locator, options) => {
         if (content === 'start') {
             // add first for sort by start
             ignoreStart = {
-                type: 'start',
-                startOffset: end,
-                endOffset: end
+                type: 'start-stop',
+                startOffset: start,
+                endOffset: start
             };
             list.push(ignoreStart);
             return;

package/lib/istanbul/istanbul.js

@@ -52,7 +52,7 @@ const saveIstanbulReports = (coverageData, fileSources, options) => {
         coverageMap,
         // The summarizer to default to (may be overridden by some reports)
         // values can be nested/flat/pkg. Defaults to 'pkg'
-        defaultSummarizer: options.defaultSummarizer || 'pkg',
+        defaultSummarizer: options.defaultSummarizer || 'nested',
 
         dir: options.outputDir,
         watermarks,