monocart-coverage-reports 2.4.4 → 2.5.1

package/README.md

@@ -33,7 +33,14 @@
     - [Using `v8-to-istanbul`](#using-v8-to-istanbul)
     - [How Monocart Works](#how-monocart-works)
 * [Debug for Coverage and Sourcemap](#debug-for-coverage-and-sourcemap)
-* [Integration](#integration) - Playwright, Jest, Vitest, Codecov, Coveralls, Sonar Cloud
+* [Integration](#integration)
+    - [Playwright](#playwright)
+    - [Jest](#jest)
+    - [Vitest](#vitest)
+    - [Codecov](#codecov)
+    - [Coveralls](#coveralls)
+    - [Sonar Cloud](#sonar-cloud)
+    - [Integration with Any Testing Framework](#integration-with-any-testing-framework)
 * [Thanks](#thanks)
 
 ## Usage
@@ -56,24 +63,22 @@ console.log(coverageResults.summary);
 - [lib/default/options.js](https://github.com/cenfun/monocart-coverage-reports/blob/main/lib/default/options.js)
 
 ## Available Reports
-- `v8` (V8 data only)
-    - Test in browser
-        - Build with webpack: [V8](https://cenfun.github.io/monocart-coverage-reports/v8) and [V8 Minify](https://cenfun.github.io/monocart-coverage-reports/v8-minify)
-        - Build with [Rollup](https://cenfun.github.io/monocart-coverage-reports/v8-rollup) and [Esbuild](https://cenfun.github.io/monocart-coverage-reports/v8-esbuild)
-        - Collect with [puppeteer](https://cenfun.github.io/monocart-coverage-reports/puppeteer/) 
-        - [anonymous](https://cenfun.github.io/monocart-coverage-reports/anonymous/) and [css](https://cenfun.github.io/monocart-coverage-reports/css/)
-    - Test in Node.js
-        - Collect with [env](https://cenfun.github.io/monocart-coverage-reports/v8-node-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)
-        - Web server example: [koa](https://cenfun.github.io/monocart-coverage-reports/v8-node-koa/)
+> V8 build-in reports (V8 data only):
+- `v8`
+    - Browser: Build with webpack [V8](https://cenfun.github.io/monocart-coverage-reports/v8) and [V8 Minify](https://cenfun.github.io/monocart-coverage-reports/v8-minify); Build with [Rollup](https://cenfun.github.io/monocart-coverage-reports/v8-rollup) and [Esbuild](https://cenfun.github.io/monocart-coverage-reports/v8-esbuild); Collect with [puppeteer](https://cenfun.github.io/monocart-coverage-reports/puppeteer/); [anonymous](https://cenfun.github.io/monocart-coverage-reports/anonymous/) and [css](https://cenfun.github.io/monocart-coverage-reports/css/)
+    - Node.js: Collect with [env](https://cenfun.github.io/monocart-coverage-reports/v8-node-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); Web server example: [koa](https://cenfun.github.io/monocart-coverage-reports/v8-node-koa/)
 
 ![](test/v8.gif)
 
-- `v8-json` (V8 data only)
+- `v8-json`
     - [V8 coverage-report.json](https://cenfun.github.io/monocart-coverage-reports/v8-and-istanbul/coverage-report.json)
-- `codecov` (V8 data only)
+- `codecov`
     - coverage data for [Codecov](https://docs.codecov.com/docs/codecov-custom-coverage-format), see [example](https://app.codecov.io/github/cenfun/monocart-coverage-reports) 
+- `console-details` Show file coverage and uncovered lines in the console. Like `text`, but for V8.
 
-> Istanbul [build-in reports](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-reports/lib)
+![](test/console-details.png)
+
+> Istanbul build-in reports (both V8 and istanbul data):
 - `clover`
 - `cobertura`
 - `html`
@@ -93,9 +98,11 @@ console.log(coverageResults.summary);
 - `text-lcov`
 - `text-summary`
 
-> Other reports
-- `console-summary` shows coverage summary in console
+> Other reports:
+- `console-summary` shows coverage summary in the console
+
 ![](test/console-summary.png)
+
 - `raw` only keep all original data, which can be used for other reports input with `inputDir`
     - see [Merge Coverage Reports](#merge-coverage-reports)
 
@@ -645,65 +652,69 @@ When `logging` is `debug`, the raw report data will be preserved in `[outputDir]
 ![](./test/debug-sourcemap.png)
 
 ## 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)
-    ```js
-    const coverageOptions = {
-        outputDir: "./coverage-reports",
-        lcov: true
-    };
-    ```
-    - 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/*
-    ```
-- Integration with any testing framework
-    - First, you need to collect coverage data when any stage of the test is completed. Then, add the coverage data to the coverage report.
-    - Upon the completion of all tests, generate the coverage report. 
-    - see [Multiprocessing Support](#multiprocessing-support)
+### [Playwright](https://github.com/microsoft/playwright)
+- [monocart-reporter](https://github.com/cenfun/monocart-reporter) - A Playwright custom reporter, supports generating [Code Coverage Report](https://github.com/cenfun/monocart-reporter?#code-coverage-report)
+### [Jest](https://github.com/jestjs/jest/)
+- [jest-monocart-coverage](https://github.com/cenfun/jest-monocart-coverage) - A Jest custom reporter for coverage reports
+### [Vitest](https://github.com/vitest-dev/vitest)
+- [vitest-monocart-coverage](https://github.com/cenfun/vitest-monocart-coverage) - A 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)
+- Using `lcov` report:
+```js
+const coverageOptions = {
+    outputDir: "./coverage-reports",
+    lcov: true
+};
+```
+- 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)
+- Using `lcov` report. 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/*
+```
+### Integration with Any Testing Framework
+- Collecting coverage data when any stage of the test is completed, and adding the coverage data to the coverage reporter.
+- Generating the coverage reports after the completion of all tests.
+- see [Multiprocessing Support](#multiprocessing-support)
 
 ## Thanks
 - Special thanks to [@edumserrano](https://github.com/edumserrano)

package/lib/default/options.js

@@ -65,6 +65,9 @@ module.exports = {
     // {object} { bytes:[50,80], statements:[50,80], branches:[50,80], functions:[50,80], lines:[50,80] }
     watermarks: [50, 80],
 
+    // {boolean} clean previous files in output dir before generating report. Defaults to true.
+    clean: true,
+
     // {function} onEnd hook
     // onEnd: async (reportData) => {}
     onEnd: null

package/lib/generate.js

@@ -72,6 +72,7 @@ const getReportGroup = (reports, lcov, dataType) => {
         'v8': 'v8',
         'v8-json': 'v8',
         'codecov': 'v8',
+        'console-details': 'v8',
 
         // istanbul
         'clover': 'istanbul',
@@ -126,22 +127,9 @@ const getReportGroup = (reports, lcov, dataType) => {
 
 // ========================================================================================================
 
-const capitalizeFirstLetter = (string) => {
-    return string.charAt(0).toUpperCase() + string.slice(1);
-};
-
 const pFormatter = (v, row, column) => {
     if (typeof v === 'number') {
-        const p = Util.PSF(v, 100, 2);
-        if (row.status === 'low') {
-            return EC.red(p);
-        }
-        if (row.status === 'medium') {
-            return EC.yellow(p);
-        }
-        if (row.status === 'high') {
-            return EC.green(p);
-        }
+        return Util.getColorStrByStatus(Util.PSF(v, 100, 2), row.status);
     }
     return v;
 };
@@ -153,9 +141,12 @@ const nFormatter = (v) => {
     return v;
 };
 
-const showConsoleSummary = (reportData, reportOptions, options) => {
+const handleConsoleSummaryReport = (reportData, reportOptions, options) => {
 
-    const { metrics } = reportOptions;
+    const csOptions = {
+        metrics: [],
+        ... reportOptions
+    };
 
     const {
         summary, name, type
@@ -165,23 +156,12 @@ const showConsoleSummary = (reportData, reportOptions, options) => {
         EC.logCyan(name);
     }
 
-    const allMetrics = {
-        v8: ['bytes', 'statements', 'branches', 'functions', 'lines'],
-        istanbul: ['statements', 'branches', 'functions', 'lines']
-    };
-
-    let list = allMetrics[type];
-    if (Util.isList(metrics)) {
-        const newList = list.filter((k) => metrics.includes(k));
-        if (newList.length) {
-            list = newList;
-        }
-    }
+    const metrics = Util.getMetrics(type, csOptions.metrics);
 
-    const rows = list.map((k) => {
+    const rows = metrics.map((k) => {
         return {
             ... summary[k],
-            name: capitalizeFirstLetter(k)
+            name: Util.capitalizeFirstLetter(k)
         };
     });
 
@@ -216,7 +196,7 @@ const showConsoleSummary = (reportData, reportOptions, options) => {
     });
 };
 
-const saveRawReport = (reportData, reportOptions, options) => {
+const handleRawReport = (reportData, reportOptions, options) => {
     const rawOptions = {
         outputDir: 'raw',
         ... reportOptions
@@ -285,8 +265,8 @@ const generateCoverageReports = async (dataList, sourceCache, options) => {
     // console.log(Object.keys(coverageResults));
 
     const buildInBothReports = {
-        'console-summary': showConsoleSummary,
-        'raw': saveRawReport
+        'console-summary': handleConsoleSummaryReport,
+        'raw': handleRawReport
     };
 
     const bothGroup = options.reportGroup.both;

package/lib/index.d.ts

@@ -36,6 +36,11 @@ declare namespace MCR {
         ['codecov'] | ["codecov", {
             outputFile?: string;
         }] |
+        ['console-details'] | ['console-details', {
+            maxCols?: number;
+            skipPercent?: number;
+            metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
+        }] |
         ['clover'] | ['clover', {
             file?: string;
         }] |
@@ -232,6 +237,9 @@ declare namespace MCR {
         * {object} { bytes:[50,80], statements:[50,80], branches:[50,80], functions:[50,80], lines:[50,80] } */
         watermarks?: Watermarks;
 
+        /** {boolean} clean previous files in output dir before generating report. Defaults to true. */
+        clean?: boolean;
+
         /** {function} onEnd hook */
         onEnd?: (reportData: CoverageResults) => Promise<void>;
     }

package/lib/index.js

@@ -112,13 +112,15 @@ class CoverageReport {
         const outputDir = this.options.outputDir;
 
         if (fs.existsSync(outputDir)) {
-        // if assets dir is out of output dir will be ignore
-            fs.readdirSync(outputDir).forEach((itemName) => {
-                if (itemName === this.cacheDirName) {
-                    return;
-                }
-                Util.rmSync(path.resolve(outputDir, itemName));
-            });
+            // if assets dir is out of output dir will be ignore
+            if (this.options.clean) {
+                fs.readdirSync(outputDir).forEach((itemName) => {
+                    if (itemName === this.cacheDirName) {
+                        return;
+                    }
+                    Util.rmSync(path.resolve(outputDir, itemName));
+                });
+            }
         } else {
             fs.mkdirSync(outputDir, {
                 recursive: true