monocart-coverage-reports 2.9.2 → 2.10.0

package/lib/generate.js

@@ -1,38 +1,78 @@
 const fs = require('fs');
 const path = require('path');
-const CG = require('console-grid');
-const EC = require('eight-colors');
 const { pathToFileURL, fileURLToPath } = require('url');
 
+const EC = require('eight-colors');
+const { minimatch } = require('./packages/monocart-coverage-vendor.js');
+
 const Util = require('./utils/util.js');
+const { convertV8List } = require('./converter/converter.js');
+const { resolveSourceMap } = require('./converter/collect-source-maps.js');
+
+// ========================================================================================================
+// built-in reports
+
+// istanbul
 const {
     initIstanbulData, mergeIstanbulCoverage, saveIstanbulReports
 } = require('./istanbul/istanbul.js');
 
+// v8
 const { mergeV8Coverage, saveV8Report } = require('./v8/v8.js');
 
-const { convertV8List } = require('./converter/converter.js');
-const { resolveSourceMap } = require('./converter/collect-source-maps.js');
+// both
+const { codecovReport } = require('./reports/codecov.js');
+const { codacyReport } = require('./reports/codacy.js');
 
-const { minimatch } = require('minimatch');
-const { getGroupedRows } = require('./utils/snapshot.js');
-const generateMarkdownGrid = require('./utils/markdown.js');
+const { consoleDetailsReport } = require('./reports/console-details.js');
+const { consoleSummaryReport } = require('./reports/console-summary.js');
 
-// ========================================================================================================
+const { markdownDetailsReport } = require('./reports/markdown-details.js');
+const { markdownSummaryReport } = require('./reports/markdown-summary.js');
 
-// maybe v8 or to istanbul reports
-const generateV8ListReports = async (v8list, coverageData, fileSources, options) => {
-    let istanbulReportPath;
-    // v8 to istanbul reports
-    if (options.reportGroup.istanbul) {
-        const istanbulCoverageResults = await saveIstanbulReports(coverageData, fileSources, options);
-        istanbulReportPath = istanbulCoverageResults.reportPath;
-    }
+const { rawReport } = require('./reports/raw.js');
 
-    // v8 reports and v8 coverage results
-    // could be no v8 or v8-json, but requires v8 coverage results
-    const v8CoverageResults = await saveV8Report(v8list, options, istanbulReportPath);
-    return v8CoverageResults;
+const allBuiltInReports = {
+    // v8
+    'v8': 'v8',
+    'v8-json': 'v8',
+
+    // istanbul
+    'clover': 'istanbul',
+    'cobertura': 'istanbul',
+    'html': 'istanbul',
+    'html-spa': 'istanbul',
+    'json': 'istanbul',
+    'json-summary': 'istanbul',
+    'lcov': 'istanbul',
+    'lcovonly': 'istanbul',
+    'none': 'istanbul',
+    'teamcity': 'istanbul',
+    'text': 'istanbul',
+    'text-lcov': 'istanbul',
+    'text-summary': 'istanbul',
+
+    // both
+    'codecov': 'both',
+    'codacy': 'both',
+    'console-details': 'both',
+    'console-summary': 'both',
+    'markdown-details': 'both',
+    'markdown-summary': 'both',
+    'raw': 'both'
+};
+
+const bothBuiltInReports = {
+    'codecov': codecovReport,
+    'codacy': codacyReport,
+
+    'console-details': consoleDetailsReport,
+    'console-summary': consoleSummaryReport,
+
+    'markdown-details': markdownDetailsReport,
+    'markdown-summary': markdownSummaryReport,
+
+    'raw': rawReport
 };
 
 // ========================================================================================================
@@ -69,469 +109,54 @@ const getReportGroup = (reports, lcov, dataType) => {
         reportMap.lcovonly = {};
     }
 
-    const allBuildInReports = {
-        // v8
-        'v8': 'v8',
-        'v8-json': 'v8',
-
-        // istanbul
-        'clover': 'istanbul',
-        'cobertura': 'istanbul',
-        'html': 'istanbul',
-        'html-spa': 'istanbul',
-        'json': 'istanbul',
-        'json-summary': 'istanbul',
-        'lcov': 'istanbul',
-        'lcovonly': 'istanbul',
-        'none': 'istanbul',
-        'teamcity': 'istanbul',
-        'text': 'istanbul',
-        'text-lcov': 'istanbul',
-        'text-summary': 'istanbul',
-
-        // both
-        'codecov': 'both',
-        'codacy': 'both',
-        'console-details': 'both',
-        'console-summary': 'both',
-        'markdown-details': 'both',
-        'markdown-summary': 'both',
-        'raw': 'both'
-    };
-
     // group v8 and istanbul
-    const reportGroup = {};
+    const groupMap = new Map();
     Object.keys(reportMap).forEach((k) => {
         const options = reportMap[k];
 
-        let type = allBuildInReports[k];
+        let type = allBuiltInReports[k];
         if (!type) {
             // for custom reporter
             type = options.type || 'v8';
         }
 
-        let group = reportGroup[type];
+        let group = groupMap.get(type);
         if (!group) {
-            group = {};
-            reportGroup[type] = group;
+            group = new Map();
+            groupMap.set(type, group);
         }
 
-        group[k] = options;
+        group.set(k, options);
 
     });
 
     // requires a default istanbul report if data is istanbul
-    if (dataType === 'istanbul' && !reportGroup.istanbul) {
-        reportGroup.istanbul = {
-            html: {}
-        };
+    if (dataType === 'istanbul' && !groupMap.has('istanbul')) {
+        const istanbulGroup = new Map();
+        istanbulGroup.set('html', {});
+        groupMap.set('istanbul', istanbulGroup);
     }
 
-    return reportGroup;
+    return groupMap;
 };
 
 // ========================================================================================================
 
-const nFormatter = (v) => {
-    if (typeof v === 'number') {
-        return Util.NF(v);
-    }
-    return v;
-};
-
-const getRowData = (rowName, summary, metrics, color) => {
-    const summaryRow = {};
-    let lowest = {
-        pct: 100,
-        status: 'high'
-    };
-    metrics.map((k) => {
-        const s = summary[k];
-        if (!s) {
-            return;
-        }
-        const percent = s.pct;
-        if (typeof percent !== 'number') {
-            return;
-        }
-        summaryRow[k] = Util.getColorStrByStatus(Util.PSF(percent, 100, 2), s.status, color);
-        if (percent < lowest.pct) {
-            lowest = s;
-        }
-    });
-    summaryRow.nameStatus = lowest.status;
-    summaryRow.name = rowName;
-    return summaryRow;
-};
-
-const getDetailsRows = (files, metrics, cdOptions, color) => {
-
-    const skipPercent = cdOptions.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 flatRows = [];
-    files.forEach((file) => {
-
-        // do NOT add debug file
-        if (file.debug) {
-            return;
-        }
-
-        const { sourcePath, summary } = file;
-        const fileRow = getRowData(sourcePath, summary, metrics, color);
-        fileRow.uncoveredLines = Util.getUncoveredLines(file.data.lines, color);
-        flatRows.push(fileRow);
-    });
-
-    return getGroupedRows(flatRows);
-};
-
-const handleCodecovReport = async (reportData, reportOptions, options) => {
-    const codecovOptions = {
-        outputFile: 'codecov.json',
-        ... reportOptions
-    };
-
-    const jsonPath = path.resolve(options.outputDir, codecovOptions.outputFile);
-
-    // https://docs.codecov.com/docs/codecov-custom-coverage-format
-    const coverage = {};
-    reportData.files.forEach((item) => {
-        const { sourcePath, data } = item;
-        coverage[sourcePath] = data.lines;
-    });
-    const codecovData = {
-        coverage
-    };
-
-    await Util.writeFile(jsonPath, JSON.stringify(codecovData));
-    return Util.relativePath(jsonPath);
-};
-
-const handleCodacyReport = async (reportData, reportOptions, options) => {
-    const codacyOptions = {
-        outputFile: 'codacy.json',
-        ... reportOptions
-    };
-
-    const jsonPath = path.resolve(options.outputDir, codacyOptions.outputFile);
-
-    // https://api.codacy.com/swagger#tocscoveragereport
-    const fileReports = [];
-    reportData.files.forEach((item) => {
-        const { sourcePath, data } = item;
-
-        const coverage = {};
-        for (const [key, value] of Object.entries(data.lines)) {
-            if (typeof value === 'number') {
-                coverage[key] = value;
-            } else {
-                // partial coverage not supported?
-                coverage[key] = 0;
-            }
-        }
-
-        fileReports.push({
-            filename: sourcePath,
-            coverage
-        });
-    });
-    const codacyData = {
-        fileReports
-    };
-
-    await Util.writeFile(jsonPath, JSON.stringify(codacyData));
-    return Util.relativePath(jsonPath);
-};
-
-const handleConsoleDetailsReport = (reportData, reportOptions, options) => {
-    const cdOptions = {
-        maxCols: 50,
-        skipPercent: 0,
-        metrics: [],
-        ... reportOptions
-    };
-
-    const {
-        type, name, summary, files
-    } = reportData;
-
-    if (name) {
-        Util.logInfo(EC.cyan(name));
-    }
-
-    const color = 'ansicode';
-
-    const metrics = Util.getMetrics(cdOptions.metrics, type);
-    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, color);
-    }
-    // no rows if skipped all by skipPercent
-    if (rows.length) {
-        rows.push({
-            innerBorder: true
-        });
-    }
-    rows.push(summaryRow);
-
-    const columns = [{
-        id: 'name',
-        name: 'Name'
-    }, ... metrics.map((m) => {
-        return {
-            id: m,
-            name: Util.capitalizeFirstLetter(m),
-            align: 'right'
-        };
-    }), {
-        id: 'uncoveredLines',
-        name: 'Uncovered Lines'
-    }];
-
-    return CG({
-        options: {
-            silent: cdOptions.silent,
-            nullPlaceholder: '',
-            defaultMaxWidth: cdOptions.maxCols
-        },
-        columns,
-        rows
-    });
-};
-
-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 = {
-        metrics: [],
-        ... reportOptions
-    };
-
-    const {
-        summary, name, type
-    } = reportData;
-
-    if (name) {
-        Util.logInfo(EC.cyan(name));
-    }
-
-    const metrics = Util.getMetrics(csOptions.metrics, type);
-
-    const rows = metrics.map((k) => {
-        return {
-            ... summary[k],
-            name: Util.capitalizeFirstLetter(k)
-        };
-    });
-
-    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'
-    }, ... metrics.map((m) => {
-        return {
-            id: m,
-            name: Util.capitalizeFirstLetter(m),
-            align: 'right'
-        };
-    }), {
-        id: 'uncoveredLines',
-        name: 'Uncovered Lines'
-    }];
-
-    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) => {
-    const rawOptions = {
-        outputDir: 'raw',
-        ... reportOptions
-    };
-
-    const cacheDir = options.cacheDir;
-    const rawDir = path.resolve(options.outputDir, rawOptions.outputDir);
-    // console.log(rawDir, cacheDir);
-    if (fs.existsSync(rawDir)) {
-        Util.logError(`Failed to save raw report because the dir already exists: ${Util.relativePath(rawDir)}`);
-        return;
-    }
-
-    const rawParent = path.dirname(rawDir);
-    if (!fs.existsSync(rawParent)) {
-        fs.mkdirSync(rawParent, {
-            recursive: true
-        });
+// maybe v8 or to istanbul reports
+const generateV8ListReports = async (v8list, coverageData, fileSources, options) => {
+    let istanbulReportPath;
+    // v8 to istanbul reports
+    if (options.reportGroup.has('istanbul')) {
+        const istanbulCoverageResults = await saveIstanbulReports(coverageData, fileSources, options);
+        istanbulReportPath = istanbulCoverageResults.reportPath;
     }
 
-    // just rename the cache folder name
-    fs.renameSync(cacheDir, rawDir);
-
+    // v8 reports and v8 coverage results
+    // could be no v8 or v8-json, but requires v8 coverage results
+    const v8CoverageResults = await saveV8Report(v8list, options, istanbulReportPath);
+    return v8CoverageResults;
 };
 
-
-// ========================================================================================================
-
 const getCoverageResults = async (dataList, sourceCache, options) => {
     // get first and check v8list or istanbul data
     const firstData = dataList[0];
@@ -575,25 +200,13 @@ const generateCoverageReports = async (dataList, sourceCache, options) => {
     // [ 'type', 'reportPath', 'name', 'watermarks', 'summary', 'files' ]
     // console.log(Object.keys(coverageResults));
 
-    const buildInBothReports = {
-        'codecov': handleCodecovReport,
-        'codacy': handleCodacyReport,
-        'console-details': handleConsoleDetailsReport,
-        'console-summary': handleConsoleSummaryReport,
-        'markdown-details': handleMarkdownDetailsReport,
-        'markdown-summary': handleMarkdownSummaryReport,
-        'raw': handleRawReport
-    };
-
-    const bothGroup = options.reportGroup.both;
-    if (bothGroup) {
-        const bothReports = Object.keys(bothGroup);
-        for (const reportName of bothReports) {
-            const reportOptions = bothGroup[reportName];
-            const buildInHandler = buildInBothReports[reportName];
+    if (options.reportGroup.has('both')) {
+        const bothGroup = options.reportGroup.get('both');
+        for (const [reportName, reportOptions] of bothGroup) {
+            const builtInHandler = bothBuiltInReports[reportName];
             const t1 = Date.now();
-            if (buildInHandler) {
-                await buildInHandler(coverageResults, reportOptions, options);
+            if (builtInHandler) {
+                await builtInHandler(coverageResults, reportOptions, options);
             } else {
                 await Util.runCustomReporter(reportName, coverageResults, reportOptions, options);
             }

package/lib/index.d.ts

@@ -129,6 +129,9 @@ declare namespace MCR {
             maxCols?: number;
             skipPercent?: number;
             metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
+            filter?: string | {
+                [pattern: string]: boolean;
+            } | ((file: CoverageFile) => boolean);
         }] |
         ['markdown-summary'] | ['markdown-summary', {
             color: 'unicode' | 'html' | 'tex' | string;
@@ -141,8 +144,12 @@ declare namespace MCR {
         ['markdown-details'] | ['markdown-details', {
             baseUrl?: string;
             color: 'unicode' | 'html' | 'tex' | string;
+            maxCols?: number;
             skipPercent?: number;
             metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
+            filter?: string | {
+                [pattern: string]: boolean;
+            } | ((file: CoverageFile) => boolean);
             /**
              * defaults to `coverage-details.md`
              */
@@ -190,14 +197,23 @@ declare namespace MCR {
         start: number;
         end: number;
         count: number;
+        /** ignored by special comment which starts with `v8 ignore` */
         ignored?: boolean;
+        /** 
+         * branch only, for example: 
+         * there is only `if` branch but no `else` branch, then `none` will be true, it shows `else path uncovered`
+         */
         none?: boolean;
+        /**  function only, function name */
+        name?: boolean;
     }
 
     export interface IgnoredRange {
         start: number;
         end: number;
+        /** ignore type: `next` or `range` */
         type: string;
+        /** n lines for `next` type */
         n?: number;
     }
 
@@ -246,6 +262,7 @@ declare namespace MCR {
     export type CoverageResults = {
         type: "v8" | "istanbul";
         reportPath: string;
+        version: string;
         name: string;
         watermarks: Watermarks;
         summary: CoverageSummary;
@@ -315,7 +332,11 @@ declare namespace MCR {
          * 
          * {object} Replace key with value.
          * */
-        sourcePath?: ((filePath: string, info: any) => string) | {
+        sourcePath?: ((filePath: string, info: {
+            /** the related dist file of current source file */
+            distFile?: string;
+            [key: string]: any;
+        }) => string) | {
             [key: string]: string;
         };