monocart-coverage-reports 2.5.8 → 2.6.0

package/lib/index.js

@@ -1,173 +1,183 @@
-const fs = require('fs');
-const path = require('path');
-const defaultOptions = require('./default/options.js');
-const Util = require('./utils/util.js');
-
-const { initV8ListAndSourcemap } = require('./v8/v8.js');
-const { getInputData, generateCoverageReports } = require('./generate.js');
-
-class CoverageReport {
-
-    constructor(options = {}) {
-        this.cacheDirName = '.cache';
-        this.options = {
-            ... defaultOptions,
-            ... options
-        };
-    }
-
-    initOptions() {
-
-        if (this.fixedOptions) {
-            return;
-        }
-
-        // init logging for clean after generated
-        this.logging = Util.initLoggingLevel(this.options.logging);
-
-        // init outputDir
-        const outputDir = `${this.options.outputDir || defaultOptions.outputDir}`;
-        this.options.outputDir = outputDir;
-
-        // cache dir, it is useful if runs in multiple processes.
-        // cache coverage- data and source- files
-        // it will be removed after generated if logging it not debug.
-        const cacheDir = path.resolve(outputDir, this.cacheDirName);
-        this.options.cacheDir = cacheDir;
-
-        this.fixedOptions = true;
-    }
-
-    // add coverage data: {array} V8 format, {object} Istanbul format
-    async add(data) {
-
-        const time_start = Date.now();
-
-        this.initOptions();
-
-        if (!Util.checkCoverageData(data)) {
-            Util.logError(`${this.options.name}: The added coverage data must be Array(V8) or Object(Istanbul)`);
-            return;
-        }
-
-        const dataId = Util.uid();
-        const dataName = `coverage-${dataId}.json`;
-        const dataPath = path.resolve(this.options.cacheDir, dataName);
-
-        const results = {
-            id: dataId,
-            path: dataPath
-        };
-
-        if (Array.isArray(data)) {
-            results.type = 'v8';
-            results.data = await initV8ListAndSourcemap(data, this.options);
-        } else {
-            results.type = 'istanbul';
-            results.data = data;
-        }
-
-        // save data to cache dir
-        const dataContent = JSON.stringify(results);
-        await Util.writeFile(dataPath, dataContent);
-
-        Util.logTime(`added coverage data: ${results.type}`, time_start);
-
-        return results;
-    }
-
-    // generate report
-    async generate() {
-
-        const time_start = Date.now();
-
-        this.initOptions();
-
-        const {
-            all, inputDir, cacheDir
-        } = this.options;
-
-        const inputDirs = Util.toList(inputDir, ',');
-        if (this.hasCache()) {
-            inputDirs.push(cacheDir);
-        }
-
-        const inputList = inputDirs.filter((dir) => {
-            const hasDir = fs.existsSync(dir);
-            if (!hasDir) {
-                // could be empty
-                Util.logInfo(`Not found coverage data dir: ${Util.relativePath(dir)}`);
-            }
-            return hasDir;
-        });
-
-        const { dataList, sourceCache } = await getInputData(inputList, all, cacheDir, (emptyData) => {
-            return this.add(emptyData);
-        });
-
-        if (!dataList.length) {
-            const dirs = inputList.map((dir) => Util.relativePath(dir));
-            Util.logError(`Not found coverage data in dir(s): ${dirs.join(', ')}`);
-            return;
-        }
-
-        // empty output dir except cache dir before generate reports
-        const outputDir = this.options.outputDir;
-
-        if (fs.existsSync(outputDir)) {
-            // 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
-            });
-        }
-
-        const coverageResults = await generateCoverageReports(dataList, sourceCache, this.options);
-
-        if (this.logging !== 'debug') {
-            Util.rmSync(cacheDir);
-        }
-
-        Util.logTime(`generated coverage reports: ${coverageResults.reportPath}`, time_start);
-
-        const onEnd = this.options.onEnd;
-        if (typeof onEnd === 'function') {
-            await onEnd(coverageResults);
-        }
-
-        return coverageResults;
-    }
-
-    // check if cache dir exists
-    hasCache() {
-        this.initOptions();
-        return fs.existsSync(this.options.cacheDir);
-    }
-
-    // cache clean
-    cleanCache() {
-        // clean previous artifacts
-        if (this.hasCache()) {
-            Util.rmSync(this.options.cacheDir);
-            return true;
-        }
-        return false;
-    }
-
-}
-
-/** create coverage report */
-const MCR = function(options) {
-    return new CoverageReport(options);
-};
-MCR.CoverageReport = CoverageReport;
-
-module.exports = MCR;
+const fs = require('fs');
+const path = require('path');
+const defaultOptions = require('./default/options.js');
+const Util = require('./utils/util.js');
+
+const { initV8ListAndSourcemap } = require('./v8/v8.js');
+const { getInputData, generateCoverageReports } = require('./generate.js');
+const { getSnapshot, diffSnapshot } = require('./utils/snapshot.js');
+
+class CoverageReport {
+
+    constructor(options = {}) {
+        this.cacheDirName = '.cache';
+        this.options = {
+            ... defaultOptions,
+            ... options
+        };
+
+        this.initOptions();
+        // If true, the API `cleanCache()` will execute automatically.
+        if (this.options.cleanCache) {
+            this.cleanCache();
+        }
+
+    }
+
+    initOptions() {
+
+        if (this.fixedOptions) {
+            return;
+        }
+
+        // init logging for clean after generated
+        this.logging = Util.initLoggingLevel(this.options.logging);
+
+        // init outputDir
+        const outputDir = `${this.options.outputDir || defaultOptions.outputDir}`;
+        this.options.outputDir = outputDir;
+
+        // cache dir, it is useful if runs in multiple processes.
+        // cache coverage- data and source- files
+        // it will be removed after generated if logging it not debug.
+        const cacheDir = path.resolve(outputDir, this.cacheDirName);
+        this.options.cacheDir = cacheDir;
+
+        this.fixedOptions = true;
+    }
+
+    // add coverage data: {array} V8 format, {object} Istanbul format
+    async add(data) {
+
+        const time_start = Date.now();
+
+        this.initOptions();
+
+        if (!Util.checkCoverageData(data)) {
+            Util.logError(`${this.options.name}: The added coverage data must be Array(V8) or Object(Istanbul)`);
+            return;
+        }
+
+        const dataId = Util.uid();
+        const dataName = `coverage-${dataId}.json`;
+        const dataPath = path.resolve(this.options.cacheDir, dataName);
+
+        const results = {
+            id: dataId,
+            path: dataPath
+        };
+
+        if (Array.isArray(data)) {
+            results.type = 'v8';
+            results.data = await initV8ListAndSourcemap(data, this.options);
+        } else {
+            results.type = 'istanbul';
+            results.data = data;
+        }
+
+        // save data to cache dir
+        const dataContent = JSON.stringify(results);
+        await Util.writeFile(dataPath, dataContent);
+
+        Util.logTime(`added coverage data: ${results.type}`, time_start);
+
+        return results;
+    }
+
+    // generate report
+    async generate() {
+
+        const time_start = Date.now();
+
+        this.initOptions();
+
+        const {
+            all, inputDir, cacheDir
+        } = this.options;
+
+        const inputDirs = Util.toList(inputDir, ',');
+        if (this.hasCache()) {
+            inputDirs.push(cacheDir);
+        }
+
+        const inputList = inputDirs.filter((dir) => {
+            const hasDir = fs.existsSync(dir);
+            if (!hasDir) {
+                // could be empty
+                Util.logInfo(`Not found coverage data dir: ${Util.relativePath(dir)}`);
+            }
+            return hasDir;
+        });
+
+        const { dataList, sourceCache } = await getInputData(inputList, all, cacheDir, (emptyData) => {
+            return this.add(emptyData);
+        });
+
+        if (!dataList.length) {
+            const dirs = inputList.map((dir) => Util.relativePath(dir));
+            Util.logError(`Not found coverage data in dir(s): ${dirs.join(', ')}`);
+            return;
+        }
+
+        // empty output dir except cache dir before generate reports
+        const outputDir = this.options.outputDir;
+
+        if (fs.existsSync(outputDir)) {
+            // 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
+            });
+        }
+
+        const coverageResults = await generateCoverageReports(dataList, sourceCache, this.options);
+
+        if (this.logging !== 'debug') {
+            Util.rmSync(cacheDir);
+        }
+
+        Util.logTime(`generated coverage reports: ${coverageResults.reportPath}`, time_start);
+
+        const onEnd = this.options.onEnd;
+        if (typeof onEnd === 'function') {
+            await onEnd.call(this, coverageResults);
+        }
+
+        return coverageResults;
+    }
+
+    // check if cache dir exists
+    hasCache() {
+        this.initOptions();
+        return fs.existsSync(this.options.cacheDir);
+    }
+
+    // cache clean
+    cleanCache() {
+        // clean previous artifacts
+        if (this.hasCache()) {
+            Util.rmSync(this.options.cacheDir);
+            return true;
+        }
+        return false;
+    }
+
+}
+
+/** create coverage report */
+const MCR = function(options) {
+    return new CoverageReport(options);
+};
+MCR.CoverageReport = CoverageReport;
+MCR.getSnapshot = getSnapshot;
+MCR.diffSnapshot = diffSnapshot;
+
+module.exports = MCR;

package/lib/index.mjs

@@ -1,3 +1,5 @@
-import MCR from './index.js';
-export default MCR;
-export const CoverageReport = MCR.CoverageReport;
+import MCR from './index.js';
+export default MCR;
+export const CoverageReport = MCR.CoverageReport;
+export const getSnapshot = MCR.getSnapshot;
+export const diffSnapshot = MCR.diffSnapshot;

package/lib/istanbul/istanbul-summary.js

@@ -1,63 +1,70 @@
-const istanbulLibReport = require('istanbul-lib-report');
-
-const ReportBase = istanbulLibReport.ReportBase;
-class IstanbulSummary extends ReportBase {
-
-    onStart(root, context) {
-        this.context = context;
-        this.summary = {};
-        this.files = [];
-    }
-
-    addStatus(data) {
-        Object.keys(data).forEach((k) => {
-            const item = data[k];
-            // low, medium, high, unknown
-            item.status = this.context.classForPercent(k, item.pct);
-        });
-    }
-
-    onSummary(node) {
-        if (!node.isRoot()) {
-            return;
-        }
-        this.summary = node.getCoverageSummary().data;
-        this.addStatus(this.summary);
-    }
-
-    onDetail(node) {
-        const fileSummary = node.getCoverageSummary().data;
-        this.addStatus(fileSummary);
-        const sourcePath = node.getQualifiedName();
-        this.files.push({
-            sourcePath,
-            summary: fileSummary
-        });
-    }
-
-    onEnd() {
-        // console.log('onEnd');
-    }
-
-    getReport() {
-
-        // remove branchesTrue
-        delete this.summary.branchesTrue;
-
-        // add uncovered
-        Object.keys(this.summary).forEach((id) => {
-            const item = this.summary[id];
-            item.uncovered = item.total - item.covered;
-        });
-
-        // console.log(this.summary);
-
-        return {
-            summary: this.summary,
-            files: this.files
-        };
-    }
-}
-
-
-module.exports = IstanbulSummary;
+const istanbulLibReport = require('istanbul-lib-report');
+
+const ReportBase = istanbulLibReport.ReportBase;
+class IstanbulSummary extends ReportBase {
+
+    onStart(root, context) {
+        this.context = context;
+        this.summary = {};
+        this.files = [];
+    }
+
+    addStatus(data) {
+        Object.keys(data).forEach((k) => {
+            const item = data[k];
+            // low, medium, high, unknown
+            item.status = this.context.classForPercent(k, item.pct);
+        });
+    }
+
+    onSummary(node) {
+        if (!node.isRoot()) {
+            return;
+        }
+        this.summary = node.getCoverageSummary().data;
+        this.addStatus(this.summary);
+    }
+
+    onDetail(node) {
+        const fileSummary = node.getCoverageSummary().data;
+        this.addStatus(fileSummary);
+        const sourcePath = node.getQualifiedName();
+
+        const fileCoverage = node.getFileCoverage();
+        const lines = fileCoverage.getLineCoverage();
+
+        this.files.push({
+            sourcePath,
+            summary: fileSummary,
+            data: {
+                lines
+            }
+        });
+    }
+
+    onEnd() {
+        // console.log('onEnd');
+    }
+
+    getReport() {
+
+        // remove branchesTrue
+        delete this.summary.branchesTrue;
+
+        // add uncovered
+        Object.keys(this.summary).forEach((id) => {
+            const item = this.summary[id];
+            item.uncovered = item.total - item.covered;
+        });
+
+        // console.log(this.summary);
+
+        return {
+            summary: this.summary,
+            files: this.files
+        };
+    }
+}
+
+
+module.exports = IstanbulSummary;