monocart-coverage-reports 2.0.6 → 2.0.8

package/lib/converter/find-in-ranges.js

@@ -0,0 +1,39 @@
+const Util = require('../utils/util.js');
+
+const quickFindRange = (position, ranges) => {
+    let start = 0;
+    let end = ranges.length - 1;
+    while (end - start > 1) {
+        const i = Math.floor((start + end) * 0.5);
+        const item = ranges[i];
+        if (position < item.startOffset) {
+            end = i;
+            continue;
+        }
+        if (position > item.endOffset) {
+            start = i;
+            continue;
+        }
+        return ranges[i];
+    }
+    // last two items, less is start
+    const endItem = ranges[end];
+    if (position < endItem.startOffset) {
+        return ranges[start];
+    }
+    return ranges[end];
+};
+
+
+const findInRanges = (start, end, ranges) => {
+    if (!Util.isList(ranges)) {
+        return;
+    }
+    const range = quickFindRange(start, ranges);
+    if (start >= range.startOffset && end <= range.endOffset) {
+        return range;
+    }
+};
+
+
+module.exports = findInRanges;

package/lib/converter/ignore.js

@@ -0,0 +1,130 @@
+const Util = require('../utils/util.js');
+
+const getNextN = (content, currentLine, item, locator) => {
+
+    // v8 ignore next N
+    if (content) {
+        const n = parseInt(content);
+        if (n && n > 0) {
+            return n;
+        }
+        return 1;
+    }
+
+    // block comment not end of line, same line
+    if (item.block) {
+        // has code between comment and line end
+        const text = locator.getSlice(item.end, currentLine.end).trim();
+        if (text) {
+            return 0;
+        }
+    }
+
+    // v8 ignore next
+    return 1;
+};
+
+const addNextIgnore = (list, content, item, locator) => {
+
+    const { lineParser } = locator;
+
+    // findLine 0-base
+    const currentLine = lineParser.findLine(item.end);
+    const n = getNextN(content, currentLine, item, locator);
+
+    // console.log('current line', currentLine.line, 'lines', lines);
+
+    // getLine 1-base
+    const line = currentLine.line + 1;
+    const endLine = locator.getLine(line + n);
+    const endOffset = endLine ? endLine.end : locator.source.length;
+
+    const nextItem = {
+        type: 'next',
+        n,
+        startOffset: item.end,
+        endOffset
+    };
+
+    list.push(nextItem);
+};
+
+const getIgnoredRanges = (locator, options) => {
+    if (!options.v8Ignore) {
+        return;
+    }
+
+    const { lineParser } = locator;
+
+    const comments = lineParser.comments;
+    if (!Util.isList(comments)) {
+        return;
+    }
+
+    const list = [];
+    let ignoreStart = null;
+
+    comments.forEach((item) => {
+        const {
+            block, start, end, text
+        } = item;
+        let content = block ? text.slice(2, -2) : text.slice(2);
+        content = content.trim();
+
+        const v8IgnoreKey = 'v8 ignore';
+        if (!content.startsWith(v8IgnoreKey)) {
+            return;
+        }
+
+        content = content.slice(v8IgnoreKey.length).trim();
+
+        if (ignoreStart) {
+            // v8 ignore stop
+            if (content === 'stop') {
+                ignoreStart.endOffset = start;
+                ignoreStart = null;
+            }
+            return;
+        }
+
+        // v8 ignore start
+        if (content === 'start') {
+            // add first for sort by start
+            ignoreStart = {
+                type: 'start',
+                startOffset: end,
+                endOffset: end
+            };
+            list.push(ignoreStart);
+            return;
+        }
+
+        // v8 ignore next N
+        const nextKey = 'next';
+        if (content.startsWith(nextKey)) {
+            content = content.slice(nextKey.length).trim();
+            addNextIgnore(list, content, item, locator);
+        }
+
+    });
+
+    // ignore not stop
+    if (ignoreStart) {
+        ignoreStart.endOffset = locator.source.length;
+        ignoreStart = null;
+    }
+
+    if (!list.length) {
+        return;
+    }
+
+    // console.log('=============================================');
+    // console.log(list);
+
+    return list;
+};
+
+
+module.exports = {
+    getIgnoredRanges
+};

package/lib/default/options.js

@@ -43,6 +43,9 @@ module.exports = {
     // sourceFilter: (sourcePath) => sourcePath.search(/src\/.+/) !== -1,
     sourceFilter: null,
 
+    // [V8 only](Boolean) Enable/Disable ignoring uncovered codes with the special comments: /* v8 ignore next/next N/start/stop */
+    v8Ignore: true,
+
     // [Istanbul only] defaultSummarizer, sourceFinder
 
     // (Boolean) Generate lcov.info file, same as lcovonly report. Defaults to false.

package/lib/generate.js

@@ -127,60 +127,6 @@ const getReportGroup = (reports, lcov, dataType) => {
 
 // ========================================================================================================
 
-
-const generateCoverageReports = async (dataList, options) => {
-
-    // get first and check v8list or istanbul data
-    const firstData = dataList[0];
-    const dataType = firstData.type;
-    // console.log('data type', dataType);
-
-    // init reports
-    options.reportGroup = getReportGroup(options.reports, options.lcov, dataType);
-    // console.log('reportGroup', options.reportGroup);
-
-    // v8list
-    if (dataType === 'v8') {
-        // merge v8list first
-        const v8list = await mergeV8Coverage(dataList, options);
-        // console.log('after merge', v8list.map((it) => it.url));
-
-        const { coverageData, fileSources } = await convertV8List(v8list, options);
-        return generateV8ListReports(v8list, coverageData, fileSources, options);
-
-    }
-
-    // istanbul data
-    const istanbulData = mergeIstanbulCoverage(dataList, options);
-    const { coverageData, fileSources } = initIstanbulData(istanbulData, options);
-    return saveIstanbulReports(coverageData, fileSources, options);
-
-};
-
-// ========================================================================================================
-
-
-const getCoverageDataList = async (cacheDir) => {
-    const files = fs.readdirSync(cacheDir).filter((f) => f.startsWith('coverage-'));
-    if (!files.length) {
-        return;
-    }
-
-    const dataList = [];
-    for (const item of files) {
-        const content = await Util.readFile(path.resolve(cacheDir, item));
-        if (content) {
-            dataList.push(JSON.parse(content));
-        }
-    }
-
-    if (dataList.length) {
-        return dataList;
-    }
-};
-
-// ========================================================================================================
-
 const capitalizeFirstLetter = (string) => {
     return string.charAt(0).toUpperCase() + string.slice(1);
 };
@@ -216,6 +162,8 @@ const showConsoleSummary = (coverageResults, options) => {
         return;
     }
 
+    const { metrics } = consoleOptions;
+
     const {
         summary, name, type
     } = coverageResults;
@@ -223,12 +171,19 @@ const showConsoleSummary = (coverageResults, options) => {
         EC.logCyan(name);
     }
 
-    const indicators = {
+    const allMetrics = {
         v8: ['bytes', 'functions', 'branches', 'lines'],
         istanbul: ['statements', 'functions', 'branches', 'lines']
     };
 
-    const list = indicators[type] || indicators.v8;
+    let list = allMetrics[type];
+    if (Util.isList(metrics)) {
+        const newList = list.filter((k) => metrics.includes(k));
+        if (newList.length) {
+            list = newList;
+        }
+    }
+
     const rows = list.map((k) => {
         return {
             ... summary[k],
@@ -261,23 +216,76 @@ const showConsoleSummary = (coverageResults, options) => {
         formatter: nFormatter
     }];
 
-    if (type === 'istanbul') {
-        columns.splice(4, 0, {
-            id: 'skipped',
-            name: 'Skipped',
-            align: 'right',
-            formatter: nFormatter
-        });
-    }
-
     CG({
         columns,
         rows
     });
 };
 
+
+// ========================================================================================================
+
+const getCoverageResults = async (dataList, options) => {
+    // get first and check v8list or istanbul data
+    const firstData = dataList[0];
+    const dataType = firstData.type;
+    // console.log('data type', dataType);
+
+    // init reports
+    options.reportGroup = getReportGroup(options.reports, options.lcov, dataType);
+    // console.log('reportGroup', options.reportGroup);
+
+    // v8list
+    if (dataType === 'v8') {
+        // merge v8list first
+        const v8list = await mergeV8Coverage(dataList, options);
+        // console.log('after merge', v8list.map((it) => it.url));
+
+        const { coverageData, fileSources } = await convertV8List(v8list, options);
+        return generateV8ListReports(v8list, coverageData, fileSources, options);
+
+    }
+
+    // istanbul data
+    const istanbulData = mergeIstanbulCoverage(dataList, options);
+    const { coverageData, fileSources } = initIstanbulData(istanbulData, options);
+    return saveIstanbulReports(coverageData, fileSources, options);
+};
+
+const generateCoverageReports = async (dataList, options) => {
+    const coverageResults = await getCoverageResults(dataList, options);
+
+    // [ 'type', 'reportPath', 'name', 'watermarks', 'summary', 'files' ]
+    // console.log(Object.keys(coverageResults));
+
+    showConsoleSummary(coverageResults, options);
+
+    return coverageResults;
+};
+
+// ========================================================================================================
+
+
+const getCoverageDataList = async (cacheDir) => {
+    const files = fs.readdirSync(cacheDir).filter((f) => f.startsWith('coverage-'));
+    if (!files.length) {
+        return;
+    }
+
+    const dataList = [];
+    for (const item of files) {
+        const content = await Util.readFile(path.resolve(cacheDir, item));
+        if (content) {
+            dataList.push(JSON.parse(content));
+        }
+    }
+
+    if (dataList.length) {
+        return dataList;
+    }
+};
+
 module.exports = {
     getCoverageDataList,
-    generateCoverageReports,
-    showConsoleSummary
+    generateCoverageReports
 };

package/lib/index.d.ts

@@ -23,12 +23,15 @@ export type ReportDescription =
     ['v8'] | ["v8", {
         outputFile?: string,
         inline?: boolean,
-        assetsPath?: string
+        assetsPath?: string,
+        metrics?: Array<"bytes" | "functions" | "branches" | "lines">
     }] |
     ['v8-json'] | ["v8-json", {
         outputFile?: string
     }] |
-    ['console-summary'] |
+    ['console-summary'] | ['console-summary', {
+        metrics?: Array<"bytes" | "functions" | "branches" | "lines" | "statements">
+    }] |
     ['clover'] | ['clover', {
         file?: string
     }] |
@@ -120,6 +123,9 @@ export type CoverageReportOptions = {
     // [V8 only](Function) A filter function to execute for each element in the sources which unpacked from the source map.
     sourceFilter?: (sourcePath: string) => boolean,
 
+    // [V8 only](Boolean) Enable/Disable ignoring uncovered codes with the special comments: /* v8 ignore next/next N/start/stop */
+    v8Ignore?: boolean,
+
     // [Istanbul only] defaultSummarizer, sourceFinder
 
     // (Boolean) Generate lcov.info file, same as lcovonly report. Defaults to false.

package/lib/index.js

@@ -4,9 +4,7 @@ const defaultOptions = require('./default/options.js');
 const Util = require('./utils/util.js');
 
 const { initV8ListAndSourcemap } = require('./v8/v8.js');
-const {
-    getCoverageDataList, generateCoverageReports, showConsoleSummary
-} = require('./generate.js');
+const { getCoverageDataList, generateCoverageReports } = require('./generate.js');
 
 class CoverageReport {
 
@@ -109,8 +107,6 @@ class CoverageReport {
             Util.rmSync(cacheDir);
         }
 
-        showConsoleSummary(coverageResults, this.options);
-
         const onEnd = this.options.onEnd;
         if (typeof onEnd === 'function') {
             await onEnd(coverageResults);

package/lib/istanbul/istanbul-summary.js

@@ -44,8 +44,7 @@ class IstanbulSummary extends ReportBase {
         // add uncovered
         Object.keys(this.summary).forEach((id) => {
             const item = this.summary[id];
-            // NOTE: skipped
-            item.uncovered = item.total - item.covered - item.skipped;
+            item.uncovered = item.total - item.covered;
         });
 
         // console.log(this.summary);

package/lib/istanbul/istanbul.js

@@ -103,7 +103,7 @@ const saveIstanbulReports = (coverageData, fileSources, options) => {
         return Util.relativePath(htmlPath);
     });
 
-    const report = {
+    const coverageResults = {
         type: 'istanbul',
         reportPath,
         name: options.name,
@@ -112,7 +112,7 @@ const saveIstanbulReports = (coverageData, fileSources, options) => {
         ... coverageReport.getReport()
     };
 
-    return report;
+    return coverageResults;
 };
 
 const mergeIstanbulCoverage = (dataList, options) => {