monocart-coverage-reports 2.10.5 → 2.10.7

package/README.md

@@ -967,6 +967,8 @@ process.env.MCR_LOG_TIME = true
 - Coverage for Next.js, both server side and client side:
     - [nextjs-with-playwright](https://github.com/cenfun/nextjs-with-playwright)
     - [nextjs-with-playwright-istanbul](https://github.com/cenfun/nextjs-with-playwright-istanbul)
+- Coverage for Remix:
+    - [remix-with-playwright](https://github.com/cenfun/remix-with-playwright)
 - see [Collecting V8 Coverage Data with Playwright](#collecting-v8-coverage-data-with-playwright)
 
 ### [c8](https://github.com/bcoe/c8)

package/README.zh-Hans.md

@@ -971,6 +971,8 @@ process.env.MCR_LOG_TIME = true
 - Coverage for Next.js, both server side and client side:
     - [nextjs-with-playwright](https://github.com/cenfun/nextjs-with-playwright)
     - [nextjs-with-playwright-istanbul](https://github.com/cenfun/nextjs-with-playwright-istanbul)
+- Coverage for Remix:
+    - [remix-with-playwright](https://github.com/cenfun/remix-with-playwright)
 - see [Collecting V8 Coverage Data with Playwright](#collecting-v8-coverage-data-with-playwright)
 
 ### [c8](https://github.com/bcoe/c8)

package/lib/converter/converter.js

@@ -21,7 +21,6 @@ const {
 const { getSourceType, initSourceMapSourcesPath } = require('../utils/source-path.js');
 
 const { decode } = require('@jridgewell/sourcemap-codec');
-const { minimatch } = require('../packages/monocart-coverage-vendor.js');
 
 const InfoBranch = require('./info-branch.js');
 const InfoFunction = require('./info-function.js');
@@ -956,50 +955,10 @@ const getOriginalDecodedMappings = (originalDecodedMap, sourceIndex, locator) =>
 
 // ========================================================================================================
 
-const getSourceFilter = (options) => {
-    let input = options.sourceFilter || options.filter;
-
-    // for function handler
-    if (typeof input === 'function') {
-        return input;
-    }
-
-    // for single minimatch pattern
-    if (input && typeof input === 'string') {
-        // string to multiple patterns "{...}"
-        // mcr npx mocha --sourceFilter {'**/node_modules/**':false,'**/src/*.js':true}
-        // mcr npx mocha --sourceFilter "{'**/node_modules/**': false, '**/src/*.js': true}"
-        const obj = Util.strToObj(input);
-        if (obj) {
-            input = obj;
-        } else {
-            return (sourcePath) => {
-                return minimatch(sourcePath, input);
-            };
-        }
-    }
-
-    // for patterns
-    if (input && typeof input === 'object') {
-        const patterns = Object.keys(input);
-        return (sourcePath) => {
-            for (const pattern of patterns) {
-                if (minimatch(sourcePath, pattern)) {
-                    return input[pattern];
-                }
-            }
-            // false if not matched
-        };
-    }
-
-    // default
-    return () => true;
-};
-
 const initOriginalList = (state, originalDecodedMap, options) => {
 
     // source filter
-    const sourceFilter = getSourceFilter(options);
+    const sourceFilter = Util.getSourceFilter(options);
 
     // create original content mappings
     const originalStateMap = new Map();

package/lib/converter/untested.js

@@ -5,7 +5,7 @@ const Util = require('../utils/util.js');
 const { pathToFileURL, fileURLToPath } = require('url');
 
 // const EC = require('eight-colors');
-const { minimatch, convertSourceMap } = require('../packages/monocart-coverage-vendor.js');
+const { minimatch } = require('../packages/monocart-coverage-vendor.js');
 
 // ========================================================================================================
 
@@ -109,63 +109,15 @@ const resolveFileType = (fileType, filePath) => {
     return 'js';
 };
 
-const saveUntestedFileSource = async (entryFile, options) => {
-    const {
-        id,
-        url,
-        source,
-        sourceMap
-    } = entryFile;
-    // console.log('-', entry.sourcePath);
-
-    const { cachePath } = Util.getCacheFileInfo('source', id, options.cacheDir);
-    if (fs.existsSync(cachePath)) {
-        return;
-    }
-
-    // save source and sourceMap to separated json file
-    const sourceData = {
-        id,
-        url,
-        source,
-        sourceMap
-    };
-
-    // remove comments if not debug
-    if (!Util.isDebug()) {
-        sourceData.source = convertSourceMap.removeComments(source);
-    }
-
-    // console.log('save untested file', id, url);
+const getUntestedCoverageData = (emptyList, options, coverageType) => {
 
-    await Util.saveSourceCacheFile(sourceData, options);
-
-};
-
-const getUntestedCoverageData = async (emptyList, options, coverageType) => {
-
-    // save all empty coverage
-    const dataId = Util.uid();
-    const results = {
-        id: dataId
-    };
-
-    if (coverageType === 'istanbul') {
-        results.type = 'istanbul';
-        results.data = {};
-    } else {
-        results.type = 'v8';
-        results.data = [];
-    }
+    // NOTE: do not save untested file to raw report
 
     const emptyCoverageList = [];
 
     // save all empty source and sourcemap
     for (const entryFile of emptyList) {
 
-        // for raw report: source file
-        await saveUntestedFileSource(entryFile, options);
-
         const { type, url } = entryFile;
 
         if (coverageType === 'istanbul') {
@@ -181,7 +133,6 @@ const getUntestedCoverageData = async (emptyList, options, coverageType) => {
                 b: {}
             };
             // object
-            results.data[item.path] = item;
             emptyCoverageList.push(item);
 
         } else {
@@ -202,14 +153,6 @@ const getUntestedCoverageData = async (emptyList, options, coverageType) => {
                 entryFile.ranges = entryFile.ranges || [];
             }
 
-            const item = {
-                ... entryFile
-            };
-            delete item.source;
-            delete item.sourceMap;
-
-            // array
-            results.data.push(item);
             // will be parsed to AST and converted to V8 coverage
             emptyCoverageList.push(entryFile);
 
@@ -217,10 +160,6 @@ const getUntestedCoverageData = async (emptyList, options, coverageType) => {
 
     }
 
-    // for raw report: coverage file
-    const { cachePath } = Util.getCacheFileInfo('coverage', dataId, options.cacheDir);
-    await Util.writeFile(cachePath, JSON.stringify(results));
-
     return emptyCoverageList;
 };
 
@@ -265,22 +204,33 @@ const getUntestedList = (testedMap, options, coverageType = 'v8') => {
     const {
         dirList, fileFilter, fileTransformer
     } = allOptions;
+
+    const sourceFilter = Util.getSourceFilter(options);
+
     const fileList = [];
     dirList.forEach((dir) => {
         Util.forEachFile(dir, [], (fileName, fileDir) => {
             const filePath = path.resolve(fileDir, fileName);
             // return file extname for file type
             const fileType = fileFilter(filePath);
-            if (fileType) {
-                const sourcePath = Util.relativePath(filePath);
-                if (!testedMap.has(sourcePath)) {
-                    fileList.push({
-                        filePath,
-                        fileType,
-                        sourcePath
-                    });
-                }
+            if (!fileType) {
+                return;
+            }
+
+            const sourcePath = Util.relativePath(filePath);
+            if (testedMap.has(sourcePath)) {
+                return;
             }
+
+            if (!sourceFilter(sourcePath)) {
+                return;
+            }
+
+            fileList.push({
+                filePath,
+                fileType,
+                sourcePath
+            });
         });
     });
     // console.log('fileList', fileList);

package/lib/index.d.ts

@@ -361,8 +361,8 @@ declare namespace MCR {
             dir: string | string[];
 
             /** 
-             * the file filter, return the file type, if true, defaults to css if ".css" otherwise is js 
-             * 
+             * the file filter is triggered before `sourceFilter`, no need to use it in normal case
+             * the filter could return the file type, if true, defaults to css if ".css" otherwise is js 
              * {string} `minimatch` pattern for file path; {object} multiple patterns; {function} A filter function for file path;
             */
             filter?: string | {

package/lib/index.js

@@ -6,7 +6,7 @@ const EC = require('eight-colors');
 const defaultOptions = require('./default/options.js');
 const Util = require('./utils/util.js');
 
-const { initV8ListAndSourcemap, getEntryFilter } = require('./v8/v8.js');
+const { initV8ListAndSourcemap } = require('./v8/v8.js');
 const {
     getInputData, readFromDir, generateCoverageReports
 } = require('./generate.js');
@@ -225,7 +225,7 @@ class CoverageReport {
 
     // get entry filter handler
     getEntryFilter() {
-        return getEntryFilter(this.options);
+        return Util.getEntryFilter(this.options);
     }
 
     // load config file

package/lib/utils/util.js

@@ -12,7 +12,9 @@ const request = require('./request.js');
 const version = require('../../package.json').version;
 const markdownGrid = require('./markdown.js');
 
-const { findUpSync, supportsColor } = require('../packages/monocart-coverage-vendor.js');
+const {
+    findUpSync, supportsColor, minimatch
+} = require('../packages/monocart-coverage-vendor.js');
 
 // https://github.com/chalk/supports-color
 // disabled color if Terminal stdout does not support color
@@ -161,6 +163,115 @@ const Util = {
         };
     },
 
+    // eslint-disable-next-line complexity
+    getEntryFilter: (options) => {
+        // for entry.url
+
+        if (options.entryFilterHandler) {
+            return options.entryFilterHandler;
+        }
+
+        let input = options.entryFilter || options.filter;
+
+        // for function handler
+        if (typeof input === 'function') {
+            options.entryFilterHandler = input;
+            return input;
+        }
+
+        // for single minimatch pattern
+        if (input && typeof input === 'string') {
+            // string to multiple patterns "{...}"
+            // mcr npx mocha --entryFilter {'**/node_modules/**':false,'**/src/*.js':true}
+            // mcr npx mocha --entryFilter "{'**/node_modules/**': false, '**/src/*.js': true}"
+            const obj = Util.strToObj(input);
+            if (obj) {
+                input = obj;
+            } else {
+                const handler = (entry) => {
+                    return minimatch(entry.url, input);
+                };
+                options.entryFilterHandler = handler;
+                return handler;
+            }
+        }
+
+        // for patterns
+        if (input && typeof input === 'object') {
+            const patterns = Object.keys(input);
+            const handler = (entry) => {
+                const url = entry.url;
+                for (const pattern of patterns) {
+                    if (minimatch(url, pattern)) {
+                        return input[pattern];
+                    }
+                }
+                // false if not matched
+            };
+            options.entryFilterHandler = handler;
+            return handler;
+        }
+
+        // default
+        const handler = () => true;
+        options.entryFilterHandler = handler;
+        return handler;
+    },
+
+    // eslint-disable-next-line complexity
+    getSourceFilter: (options) => {
+        // for sourcePath
+
+        if (options.sourceFilterHandler) {
+            return options.sourceFilterHandler;
+        }
+
+        let input = options.sourceFilter || options.filter;
+
+        // for function handler
+        if (typeof input === 'function') {
+            options.sourceFilterHandler = input;
+            return input;
+        }
+
+        // for single minimatch pattern
+        if (input && typeof input === 'string') {
+        // string to multiple patterns "{...}"
+        // mcr npx mocha --sourceFilter {'**/node_modules/**':false,'**/src/*.js':true}
+        // mcr npx mocha --sourceFilter "{'**/node_modules/**': false, '**/src/*.js': true}"
+            const obj = Util.strToObj(input);
+            if (obj) {
+                input = obj;
+            } else {
+                const handler = (sourcePath) => {
+                    return minimatch(sourcePath, input);
+                };
+                options.sourceFilterHandler = handler;
+                return handler;
+            }
+        }
+
+        // for patterns
+        if (input && typeof input === 'object') {
+            const patterns = Object.keys(input);
+            const handler = (sourcePath) => {
+                for (const pattern of patterns) {
+                    if (minimatch(sourcePath, pattern)) {
+                        return input[pattern];
+                    }
+                }
+            // false if not matched
+            };
+            options.sourceFilterHandler = handler;
+            return handler;
+        }
+
+        // default
+        const handler = () => true;
+        options.sourceFilterHandler = handler;
+        return handler;
+    },
+
     saveSourceCacheFile: async (sourceData, options, fileCache) => {
         const { cacheName, cachePath } = Util.getCacheFileInfo('source', sourceData.id, options.cacheDir);
 

package/lib/v8/v8.js

@@ -7,7 +7,6 @@ const {
     resolveAnonymousUrl, normalizeSourcePath, getSourcePathReplacer
 } = require('../utils/source-path.js');
 const { collectSourceMaps } = require('../converter/collect-source-maps.js');
-const { minimatch } = require('../packages/monocart-coverage-vendor.js');
 
 const { v8Report } = require('../reports/v8.js');
 const { v8JsonReport } = require('../reports/v8-json.js');
@@ -27,53 +26,12 @@ const getWrapperSource = (offset, source) => {
     return startStr + source;
 };
 
-const getEntryFilter = (options) => {
-    let input = options.entryFilter || options.filter;
-
-    // for function handler
-    if (typeof input === 'function') {
-        return input;
-    }
-
-    // for single minimatch pattern
-    if (input && typeof input === 'string') {
-        // string to multiple patterns "{...}"
-        // mcr npx mocha --entryFilter {'**/node_modules/**':false,'**/src/*.js':true}
-        // mcr npx mocha --entryFilter "{'**/node_modules/**': false, '**/src/*.js': true}"
-        const obj = Util.strToObj(input);
-        if (obj) {
-            input = obj;
-        } else {
-            return (entry) => {
-                return minimatch(entry.url, input);
-            };
-        }
-    }
-
-    // for patterns
-    if (input && typeof input === 'object') {
-        const patterns = Object.keys(input);
-        return (entry) => {
-            const url = entry.url;
-            for (const pattern of patterns) {
-                if (minimatch(url, pattern)) {
-                    return input[pattern];
-                }
-            }
-            // false if not matched
-        };
-    }
-
-    // default
-    return () => true;
-};
-
 const initV8ListAndSourcemap = async (mcr, v8list) => {
 
     const { options, fileCache } = mcr;
 
     // entry filter
-    const entryFilter = getEntryFilter(options);
+    const entryFilter = Util.getEntryFilter(options);
 
     const lengthBefore = v8list.length;
     v8list = v8list.filter(entryFilter);
@@ -367,6 +325,5 @@ const saveV8Report = async (v8list, options, istanbulReportPath) => {
 module.exports = {
     initV8ListAndSourcemap,
     mergeV8Coverage,
-    saveV8Report,
-    getEntryFilter
+    saveV8Report
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-coverage-reports",
-    "version": "2.10.5",
+    "version": "2.10.7",
     "description": "A code coverage tool to generate native V8 reports or Istanbul reports.",
     "main": "./lib/index.js",
     "bin": {