monocart-coverage-reports 2.8.7 → 2.9.0

package/README.md

@@ -139,22 +139,27 @@ For more information, see [Command Line](#command-line)
 
 > Other build-in reports (both V8 and Istanbul data):
 
-- `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) 
+- `codecov` Save coverage data to a json file with [Codecov](https://docs.codecov.com/docs/codecov-custom-coverage-format) format (defaults to `codecov.json`), see [example](https://app.codecov.io/github/cenfun/monocart-coverage-reports).
 
-- `codacy`
-    - coverage data for [Codacy](https://api.codacy.com/swagger#tocscoveragereport) API
+- `codacy` Save coverage data to a json file with [Codacy API](https://api.codacy.com/swagger#tocscoveragereport) format (defaults to `codacy.json`).
 
-- `console-summary` shows coverage summary in the console
+- `console-summary` shows coverage summary in the console.
 
 ![](./assets/console-summary.png)
 
-- `console-details` Show file coverage and uncovered lines in the console. Like `text`, but for V8. For Github actions, we can enforce color with env: `FORCE_COLOR: true`.
+- `console-details` Show coverage details in the console. Like `text`, but for V8. For Github actions, we can enforce color with env: `FORCE_COLOR: true`.
 
 ![](./assets/console-details.png)
 
-- `raw` only keep all original data, which can be used for other reports input with `inputDir`
-    - see [Merge Coverage Reports](#merge-coverage-reports)
+- `markdown-summary` Save coverage summary to a markdown file (defaults to `coverage-summary.md`). For Github actions, we can show the markdown content to [a job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary)
+```sh
+cat path-to/coverage-summary.md >> $GITHUB_STEP_SUMMARY
+```
+![](./assets/markdown-summary.png)
+
+- `markdown-details` Save coverage details to a markdown file (defaults to `coverage-details.md`).
+
+- `raw` only keep all original data, which can be used for other reports input with `inputDir`. see [Merge Coverage Reports](#merge-coverage-reports)
 
 - Custom Reporter
     ```js

package/README.zh-Hans.md

@@ -139,11 +139,9 @@ mcr node my-app.js -r v8,console-details
 
 > 其他内置报告 (V8和Istanbul格式数据都支持):
 
-- `codecov`
-    - 专属支持[Codecov](https://docs.codecov.com/docs/codecov-custom-coverage-format)的报告, see [example](https://app.codecov.io/github/cenfun/monocart-coverage-reports) 
+- `codecov` 保存覆盖率数据到 [Codecov](https://docs.codecov.com/docs/codecov-custom-coverage-format) 专属的json文件 (默认是`codecov.json`), 见[例子](https://app.codecov.io/github/cenfun/monocart-coverage-reports) 
 
-- `codacy`
-    - 专属支持[Codacy](https://api.codacy.com/swagger#tocscoveragereport) API的报告
+- `codacy` 保存覆盖率数据到 [Codacy](https://api.codacy.com/swagger#tocscoveragereport) 专属的json文件 (默认是`codacy.json`)
 
 - `console-summary` 在控制台显示覆盖率概要
 
@@ -153,8 +151,15 @@ mcr node my-app.js -r v8,console-details
 
 ![](./assets/console-details.png)
 
-- `raw` 只是保存原始覆盖率数据, 用于使用`inputDir`参数来导入多个原始数据进行合并报告
-    - 参见 [合并覆盖率报告](#merge-coverage-reports)
+- `markdown-summary` 保存概要信息到markdown文件 (默认是`coverage-summary.md`)。 如果是Github actions, 可以把markdown的内容添加到[a job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary)
+```sh
+cat path-to/coverage-summary.md >> $GITHUB_STEP_SUMMARY
+```
+![](./assets/markdown-summary.png)
+
+- `markdown-details` 保存覆盖率详情到markdown文件 (默认是 `coverage-details.md`)
+
+- `raw` 只是保存原始覆盖率数据, 用于使用`inputDir`参数来导入多个原始数据进行合并报告。参见 [合并覆盖率报告](#merge-coverage-reports)
 
 - 自定义报告
     ```js

package/lib/converter/converter.js

@@ -115,24 +115,30 @@ const handleLinesCoverage = (bytes, locator, ignoredRanges) => {
     // init lines
     let blankCount = 0;
     let commentCount = 0;
+    const dataExtras = {};
     // line 1 based
     const lineMap = new Map();
     locator.lines.forEach((lineItem) => {
+        // line 1-base
+        const line = lineItem.line + 1;
+
         // exclude blank and comment
         if (lineItem.blank) {
             blankCount += 1;
+            dataExtras[line] = 'b';
             return;
         }
         if (lineItem.comment) {
             commentCount += 1;
+            dataExtras[line] = 'c';
             return;
         }
         const ignored = Util.findInRanges(lineItem.start, lineItem.end, ignoredRanges);
         if (ignored) {
+            dataExtras[line] = 'i';
             return;
         }
-        // line 1-base
-        const line = lineItem.line + 1;
+
         lineItem.coveredCount = 1;
         lineItem.uncoveredEntire = null;
         lineItem.uncoveredPieces = [];
@@ -164,6 +170,7 @@ const handleLinesCoverage = (bytes, locator, ignoredRanges) => {
 
     return {
         dataLines,
+        dataExtras,
         summaryLines
     };
 };
@@ -262,9 +269,12 @@ const collectFileCoverage = (v8Data, state, options) => {
     // ==========================================
     // lines
     // after bytes with ignored, before calculateV8Lines
-    const { dataLines, summaryLines } = handleLinesCoverage(data.bytes, locator, ignoredRanges);
+    const {
+        dataLines, dataExtras, summaryLines
+    } = handleLinesCoverage(data.bytes, locator, ignoredRanges);
 
     data.lines = dataLines;
+    data.extras = dataExtras;
 
     // console.log('statements', state.sourcePath, statements.length);
 

package/lib/default/options.js

@@ -27,6 +27,9 @@ module.exports = {
     // {string} base dir for normalizing the relative source path, defaults to cwd
     baseDir: null,
 
+    // {string} coverage data dir, alternative to method `addFromDir()`, defaults to null
+    dataDir: null,
+
     // (V8 only) {function} A filter function to execute for each element in the V8 list.
     // entryFilter: (entry) => {
     //     if (entry.url.indexOf('googleapis.com') !== -1) {

package/lib/generate.js

@@ -16,6 +16,7 @@ const { resolveSourceMap } = require('./converter/collect-source-maps.js');
 
 const { minimatch } = require('./packages/monocart-coverage-vendor.js');
 const { getGroupedRows } = require('./utils/snapshot.js');
+const generateMarkdownGrid = require('./utils/markdown.js');
 
 // ========================================================================================================
 
@@ -93,6 +94,8 @@ const getReportGroup = (reports, lcov, dataType) => {
         'codacy': 'both',
         'console-details': 'both',
         'console-summary': 'both',
+        'markdown-details': 'both',
+        'markdown-summary': 'both',
         'raw': 'both'
     };
 
@@ -129,13 +132,6 @@ const getReportGroup = (reports, lcov, dataType) => {
 
 // ========================================================================================================
 
-const pFormatter = (v, row, column) => {
-    if (typeof v === 'number') {
-        return Util.getColorStrByStatus(Util.PSF(v, 100, 2), row.status);
-    }
-    return v;
-};
-
 const nFormatter = (v) => {
     if (typeof v === 'number') {
         return Util.NF(v);
@@ -143,7 +139,7 @@ const nFormatter = (v) => {
     return v;
 };
 
-const getRowData = (rowName, summary, metrics) => {
+const getRowData = (rowName, summary, metrics, color) => {
     const summaryRow = {};
     let lowest = {
         pct: 100,
@@ -158,7 +154,7 @@ const getRowData = (rowName, summary, metrics) => {
         if (typeof percent !== 'number') {
             return;
         }
-        summaryRow[k] = Util.getColorStrByStatus(Util.PSF(percent, 100, 2), s.status);
+        summaryRow[k] = Util.getColorStrByStatus(Util.PSF(percent, 100, 2), s.status, color);
         if (percent < lowest.pct) {
             lowest = s;
         }
@@ -168,65 +164,7 @@ const getRowData = (rowName, summary, metrics) => {
     return summaryRow;
 };
 
-const getUncoveredLines = (file) => {
-    const lines = [];
-
-    const dataLines = file.data.lines;
-
-    let startLine;
-    let endLine;
-
-    const addLines = () => {
-        if (!startLine) {
-            return;
-        }
-        if (endLine) {
-            // range
-            const link = startLine.color === 'yellow' && endLine.color === 'yellow' ? EC.yellow('-') : EC.red('-');
-            lines.push(EC[startLine.color](startLine.line) + link + EC[endLine.color](endLine.line));
-            startLine = null;
-            endLine = null;
-        } else {
-            // only start
-            lines.push(EC[startLine.color](startLine.line));
-            startLine = null;
-        }
-    };
-
-    const setLines = (line, color) => {
-        if (startLine) {
-            endLine = {
-                line,
-                color
-            };
-            return;
-        }
-        startLine = {
-            line,
-            color
-        };
-    };
-
-    Object.keys(dataLines).forEach((line) => {
-        const count = dataLines[line];
-        if (count === 0) {
-            setLines(line, 'red');
-            return;
-        }
-        // 0 < count < 1
-        if (typeof count === 'string') {
-            setLines(line, 'yellow');
-            return;
-        }
-        // count >= 1
-        addLines();
-    });
-    addLines();
-
-    return lines.join(',');
-};
-
-const getDetailsRows = (files, metrics, cdOptions) => {
+const getDetailsRows = (files, metrics, cdOptions, color) => {
 
     const skipPercent = cdOptions.skipPercent;
     if (typeof skipPercent === 'number' && skipPercent > 0) {
@@ -251,8 +189,8 @@ const getDetailsRows = (files, metrics, cdOptions) => {
         }
 
         const { sourcePath, summary } = file;
-        const fileRow = getRowData(sourcePath, summary, metrics);
-        fileRow.uncoveredLines = getUncoveredLines(file);
+        const fileRow = getRowData(sourcePath, summary, metrics, color);
+        fileRow.uncoveredLines = Util.getUncoveredLines(file.data.lines, color);
         flatRows.push(fileRow);
     });
 
@@ -333,11 +271,13 @@ const handleConsoleDetailsReport = (reportData, reportOptions, options) => {
         Util.logInfo(EC.cyan(name));
     }
 
+    const color = 'ansicode';
+
     const metrics = Util.getMetrics(cdOptions.metrics, type);
-    const rows = getDetailsRows(files, metrics, cdOptions);
-    const summaryRow = getRowData('Summary', summary, metrics);
+    const rows = getDetailsRows(files, metrics, cdOptions, color);
+    const summaryRow = getRowData('Summary', summary, metrics, color);
     if (summaryRow.nameStatus) {
-        summaryRow.name = Util.getColorStrByStatus(summaryRow.name, summaryRow.nameStatus);
+        summaryRow.name = Util.getColorStrByStatus(summaryRow.name, summaryRow.nameStatus, color);
     }
     // no rows if skipped all by skipPercent
     if (rows.length) {
@@ -372,6 +312,41 @@ const handleConsoleDetailsReport = (reportData, reportOptions, options) => {
     });
 };
 
+const getSummaryColumns = (color) => {
+
+    const columns = [{
+        id: 'name',
+        name: 'Name'
+    }, {
+        id: 'pct',
+        name: 'Coverage %',
+        align: 'right',
+        formatter: (v, row, column) => {
+            if (typeof v === 'number') {
+                return Util.getColorStrByStatus(Util.PSF(v, 100, 2), row.status, color);
+            }
+            return v;
+        }
+    }, {
+        id: 'covered',
+        name: 'Covered',
+        align: 'right',
+        formatter: nFormatter
+    }, {
+        id: 'uncovered',
+        name: 'Uncovered',
+        align: 'right',
+        formatter: nFormatter
+    }, {
+        id: 'total',
+        name: 'Total',
+        align: 'right',
+        formatter: nFormatter
+    }];
+
+    return columns;
+};
+
 const handleConsoleSummaryReport = (reportData, reportOptions, options) => {
 
     const csOptions = {
@@ -396,35 +371,136 @@ const handleConsoleSummaryReport = (reportData, reportOptions, options) => {
         };
     });
 
+    const columns = getSummaryColumns('ansicode');
+
+    CG({
+        columns,
+        rows
+    });
+};
+
+const handleMarkdownDetailsReport = async (reportData, reportOptions, options) => {
+    const mdOptions = {
+        baseUrl: '',
+        // unicode, html, or empty for no color
+        color: 'unicode',
+        skipPercent: 0,
+        metrics: [],
+        outputFile: 'coverage-details.md',
+        ... reportOptions
+    };
+
+    const color = Util.normalizeColorType(mdOptions.color);
+    const baseUrl = mdOptions.baseUrl;
+
+    const mdPath = path.resolve(options.outputDir, mdOptions.outputFile);
+
+    const metrics = Util.getMetrics(mdOptions.metrics, reportData.type);
+
+    let files = reportData.files;
+    const skipPercent = mdOptions.skipPercent;
+    if (typeof skipPercent === 'number' && skipPercent > 0) {
+        files = files.filter((file) => {
+            const { summary } = file;
+            for (const k of metrics) {
+                const percent = summary[k].pct;
+                if (typeof percent === 'number' && percent < skipPercent) {
+                    return true;
+                }
+            }
+            return false;
+        });
+    }
+
+    const rows = [];
+    files.forEach((file) => {
+
+        // do NOT add debug file
+        if (file.debug) {
+            return;
+        }
+
+        const { sourcePath, summary } = file;
+
+        const fileRow = getRowData(sourcePath, summary, metrics, color);
+        if (fileRow.nameStatus) {
+            const nameColor = baseUrl && color === 'tex' ? '' : color;
+            fileRow.name = Util.getColorStrByStatus(fileRow.name, fileRow.nameStatus, nameColor);
+        }
+        if (baseUrl) {
+            fileRow.name = `[${fileRow.name}](${baseUrl + sourcePath})`;
+        }
+
+        fileRow.uncoveredLines = Util.getUncoveredLines(file.data.lines, color);
+        rows.push(fileRow);
+    });
+
+    const summaryRow = getRowData('Summary', reportData.summary, metrics, color);
+    if (summaryRow.nameStatus) {
+        summaryRow.name = Util.getColorStrByStatus(summaryRow.name, summaryRow.nameStatus, color);
+    }
+    rows.push(summaryRow);
+
     const columns = [{
         id: 'name',
         name: 'Name'
-    }, {
-        id: 'pct',
-        name: 'Coverage %',
-        align: 'right',
-        formatter: pFormatter
-    }, {
-        id: 'covered',
-        name: 'Covered',
-        align: 'right',
-        formatter: nFormatter
-    }, {
-        id: 'uncovered',
-        name: 'Uncovered',
-        align: 'right',
-        formatter: nFormatter
-    }, {
-        id: 'total',
-        name: 'Total',
-        align: 'right',
-        formatter: nFormatter
+    }, ... metrics.map((m) => {
+        return {
+            id: m,
+            name: Util.capitalizeFirstLetter(m),
+            align: 'right'
+        };
+    }), {
+        id: 'uncoveredLines',
+        name: 'Uncovered Lines'
     }];
 
-    CG({
+    const markdownGrid = generateMarkdownGrid({
+        options: {
+            name: reportData.name
+        },
         columns,
         rows
     });
+
+    await Util.writeFile(mdPath, markdownGrid);
+    return Util.relativePath(mdPath);
+};
+
+const handleMarkdownSummaryReport = async (reportData, reportOptions, options) => {
+    const msOptions = {
+        // unicode, html, or empty for no color
+        color: 'unicode',
+        metrics: [],
+        outputFile: 'coverage-summary.md',
+        ... reportOptions
+    };
+
+    const color = Util.normalizeColorType(msOptions.color);
+
+    const mdPath = path.resolve(options.outputDir, msOptions.outputFile);
+
+    const metrics = Util.getMetrics(msOptions.metrics, reportData.type);
+
+    const rows = metrics.map((k) => {
+        return {
+            ... reportData.summary[k],
+            name: Util.capitalizeFirstLetter(k)
+        };
+    });
+
+    const columns = getSummaryColumns(color);
+
+    const markdownGrid = generateMarkdownGrid({
+        options: {
+            name: reportData.name
+        },
+        columns,
+        rows
+    });
+
+    await Util.writeFile(mdPath, markdownGrid);
+    return Util.relativePath(mdPath);
 };
 
 const handleRawReport = (reportData, reportOptions, options) => {
@@ -504,6 +580,8 @@ const generateCoverageReports = async (dataList, sourceCache, options) => {
         'codacy': handleCodacyReport,
         'console-details': handleConsoleDetailsReport,
         'console-summary': handleConsoleSummaryReport,
+        'markdown-details': handleMarkdownDetailsReport,
+        'markdown-summary': handleMarkdownSummaryReport,
         'raw': handleRawReport
     };
 

package/lib/index.d.ts

@@ -44,12 +44,18 @@ declare namespace MCR {
 
     export type ReportDescription =
         ['v8'] | ["v8", {
+            /**
+             * defaults to `index.html`
+             */
             outputFile?: string;
             inline?: boolean;
             assetsPath?: string;
             metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
         }] |
         ['v8-json'] | ["v8-json", {
+            /**
+             * defaults to `coverage-report.json`
+             */
             outputFile?: string;
         }] |
         ['clover'] | ['clover', {
@@ -105,9 +111,15 @@ declare namespace MCR {
             file?: string;
         }] |
         ['codecov'] | ["codecov", {
+            /**
+             * defaults to `codecov.json`
+             */
             outputFile?: string;
         }] |
         ['codacy'] | ["codacy", {
+            /**
+             * defaults to `codacy.json`
+             */
             outputFile?: string;
         }] |
         ['console-summary'] | ['console-summary', {
@@ -118,6 +130,24 @@ declare namespace MCR {
             skipPercent?: number;
             metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
         }] |
+        ['markdown-summary'] | ['markdown-summary', {
+            color: 'unicode' | 'html' | 'tex' | string;
+            metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
+            /**
+             * defaults to `coverage-summary.md`
+             */
+            outputFile?: string;
+        }] |
+        ['markdown-details'] | ['markdown-details', {
+            baseUrl?: string;
+            color: 'unicode' | 'html' | 'tex' | string;
+            skipPercent?: number;
+            metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
+            /**
+             * defaults to `coverage-details.md`
+             */
+            outputFile?: string;
+        }] |
         ['raw'] | ['raw', {
             outputDir?: string;
         }] |
@@ -193,10 +223,23 @@ declare namespace MCR {
             branches?: CoverageRange[];
             functions?: CoverageRange[];
             ignores?: IgnoredRange[];
-            /** common json format */
-            lines: {
+            lines?: {
+                /** 
+                 * key: line number;
+                 * number: hits (0 means uncovered);
+                 * string: partial covered 
+                 */
                 [key: string]: number | string;
             };
+            extras?: {
+                /** 
+                 * key: line number;
+                 * b: blank;
+                 * c: comment;
+                 * i: ignored;
+                 */
+                [key: string]: "b" | "c" | "i";
+            }
         }
     }
 
@@ -237,6 +280,9 @@ declare namespace MCR {
         /** {string} base dir for normalizing the relative source path, defaults to cwd */
         baseDir?: string;
 
+        /** {string} coverage data dir, alternative to method `addFromDir()`, defaults to null */
+        dataDir?: string;
+
         /** (V8 only) 
          * 
          * {string} `minimatch` pattern for entry url; 
@@ -416,6 +462,7 @@ declare namespace MCR {
                 functions: string;
                 lines: string;
                 uncoveredLines: string;
+                extras: string;
             }
         }
     }

package/lib/index.js

@@ -136,6 +136,11 @@ class CoverageReport {
 
         this.initOptions();
 
+        const dataDir = this.options.dataDir;
+        if (dataDir) {
+            await this.addFromDir(dataDir);
+        }
+
         const inputData = await getInputData(this);
         if (!inputData) {
             return;

package/lib/istanbul/istanbul-summary.js

@@ -32,12 +32,15 @@ class IstanbulSummary extends ReportBase {
 
         const fileCoverage = node.getFileCoverage();
         const lines = fileCoverage.getLineCoverage();
+        // no extras for istanbul
+        const extras = {};
 
         this.files.push({
             sourcePath,
             summary: fileSummary,
             data: {
-                lines
+                lines,
+                extras
             }
         });
     }