monocart-coverage-reports 2.4.4 → 2.5.0

package/README.md

@@ -56,24 +56,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 +91,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)
 

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;
         }] |