monocart-coverage-reports 2.10.8 → 2.10.9-beta.0

package/README.md

@@ -609,26 +609,17 @@ const coverageOptions = {
 ```
 
 ## Adding Empty Coverage for Untested Files
-By default the untested files will not be included in the coverage report, we can add empty coverage data for all files with option `all`, the untested files will show 0% coverage.
+By default the untested files will not be included in the coverage report, we can add empty coverage for untested files with option `all`, the untested files will show 0% coverage.
 ```js
 const coverageOptions = {
-    all: {
-        dir: ['./src'],
-        filter: (filePath) => {
-            return true;
-        }
-    }
+    all: './src',
+
+    // or multiple dirs
+    all: ['./src', './lib'],
 };
 ```
-The filter also supports [`minimatch`](https://github.com/isaacs/minimatch) pattern:
+The untested files will apply to the `sourceFilter`. And it also supports additional `filter` (return the file type for js or css coverage):
 ```js
-const coverageOptions = {
-    all: {
-        dir: ['./src'],
-        filter: '**/*.js'
-    }
-};
-// or multiple patterns
 const coverageOptions = {
     all: {
         dir: ['./src'],
@@ -636,7 +627,6 @@ const coverageOptions = {
             // exclude files
             '**/ignored-*.js': false,
             '**/*.html': false,
-            '**/*.ts': false,
             // empty css coverage
             '**/*.scss': "css",
             '**/*': true
@@ -644,6 +634,32 @@ const coverageOptions = {
     }
 };
 ```
+We can also compile these untested files, such as .ts, .jsx, or .vue, etc., so that they can be analyzed by the default AST parser, thus get more coverage metric data.
+```js
+const path = require("path");
+const swc = require("@swc/core");
+const coverageOptions = {
+    all: {
+        dir: ['./src'],
+        transformer: async (entry) => {
+            const { code, map } = await swc.transform(entry.source, {
+                filename: path.basename(entry.url),
+                sourceMaps: true,
+                isModule: true,
+                jsc: {
+                    parser: {
+                        syntax: "typescript",
+                        jsx: true
+                    },
+                    transform: {}
+                }
+            });
+            entry.source = code;
+            entry.sourceMap = JSON.parse(map);
+        }
+    }
+};
+```
 
 ## onEnd Hook
 For example, checking thresholds:

package/README.zh-Hans.md

@@ -615,23 +615,14 @@ const coverageOptions = {
 默认，未测试的文件是不会包含到覆盖率报告的，需要使用`all`选项来为这些文件添加一个空的覆盖率，也就是0%
 ```js
 const coverageOptions = {
-    all: {
-        dir: ['./src'],
-        filter: (filePath) => {
-            return true;
-        }
-    }
+    all: './src',
+
+    // 支持多个目录
+    all: ['./src', './lib'],
 };
 ```
-`filter`过滤也支持[`minimatch`](https://github.com/isaacs/minimatch)匹配:
+未测试的文件也适用于`sourceFilter`过滤器. 而且也可以指定自己的`filter`过滤器 (可以返回文件类型来支持js或css的覆盖率格式):
 ```js
-const coverageOptions = {
-    all: {
-        dir: ['./src'],
-        filter: '**/*.js'
-    }
-};
-// 多个匹配
 const coverageOptions = {
     all: {
         dir: ['./src'],
@@ -639,7 +630,6 @@ const coverageOptions = {
             // exclude files
             '**/ignored-*.js': false,
             '**/*.html': false,
-            '**/*.ts': false,
             // empty css coverage
             '**/*.scss': "css",
             '**/*': true
@@ -647,6 +637,32 @@ const coverageOptions = {
     }
 };
 ```
+我们可能需要编译.ts, .jsx, .vue等等这样的文件, 这样才能被默认的AST解析器解析，以得到更多的覆盖率指标的数据
+```js
+const path = require("path");
+const swc = require("@swc/core");
+const coverageOptions = {
+    all: {
+        dir: ['./src'],
+        transformer: async (entry) => {
+            const { code, map } = await swc.transform(entry.source, {
+                filename: path.basename(entry.url),
+                sourceMaps: true,
+                isModule: true,
+                jsc: {
+                    parser: {
+                        syntax: "typescript",
+                        jsx: true
+                    },
+                    transform: {}
+                }
+            });
+            entry.source = code;
+            entry.sourceMap = JSON.parse(map);
+        }
+    }
+};
+```
 
 ## onEnd Hook
 结束回调可以用来自定义业务需求，比如检测覆盖率是否达标，对比每个指标的thresholds，如果低于要求的值则可以抛出一个错误退出

package/lib/converter/untested.js

@@ -146,8 +146,8 @@ const saveUntestedFileSource = async (entryFile, options) => {
 
 const getUntestedCoverageData = async (entryList, options, coverageType) => {
 
-    // save all empty coverage
-    const dataId = Util.uid();
+    // save all empty coverage, 20 - 5(empty)
+    const dataId = Util.uid(15, 'empty');
     const results = {
         id: dataId
     };
@@ -166,15 +166,14 @@ const getUntestedCoverageData = async (entryList, options, coverageType) => {
     for (const entry of entryList) {
 
         // for raw report: source file
+        // id, url, source, sourceMap
         await saveUntestedFileSource(entry, options);
 
-        const { type, url } = entry;
-
         if (coverageType === 'istanbul') {
 
             // ===============================================
             const item = {
-                path: fileURLToPath(url),
+                path: fileURLToPath(entry.url),
                 statementMap: {},
                 fnMap: {},
                 branchMap: {},
@@ -189,20 +188,7 @@ const getUntestedCoverageData = async (entryList, options, coverageType) => {
         } else {
 
             // ===============================================
-            if (type === 'js') {
-                // empty js
-                entry.functions = entry.functions || [{
-                    functionName: '',
-                    ranges: [{
-                        startOffset: 0,
-                        endOffset: entry.source.length,
-                        count: 0
-                    }]
-                }];
-            } else {
-                // empty css
-                entry.ranges = entry.ranges || [];
-            }
+            Util.setEmptyV8Coverage(entry);
 
             const item = {
                 ... entry

package/lib/utils/util.js

@@ -272,6 +272,27 @@ const Util = {
         return handler;
     },
 
+    setEmptyV8Coverage: (entry) => {
+        if (entry.type === 'css') {
+            // empty css
+            if (!entry.ranges) {
+                entry.ranges = [];
+            }
+        } else {
+            // empty js
+            if (!entry.functions) {
+                entry.functions = [{
+                    functionName: '',
+                    ranges: [{
+                        startOffset: 0,
+                        endOffset: entry.source ? entry.source.length : 0,
+                        count: 0
+                    }]
+                }];
+            }
+        }
+    },
+
     saveSourceCacheFile: async (sourceData, options, fileCache) => {
         const { cacheName, cachePath } = Util.getCacheFileInfo('source', sourceData.id, options.cacheDir);
 

package/lib/v8/v8.js

@@ -109,11 +109,11 @@ const initV8ListAndSourcemap = async (mcr, v8list) => {
             distFile: entry.distFile
         };
 
-        // coverage
-        if (data.type === 'js') {
-            data.functions = entry.functions;
-        } else {
+        // coverage info
+        if (data.type === 'css') {
             data.ranges = entry.ranges;
+        } else {
+            data.functions = entry.functions;
         }
 
         // resolve source path
@@ -213,10 +213,10 @@ const mergeV8Coverage = async (dataList, sourceCache, options) => {
     for (const id of mergeIds) {
         const itemList = mergeMap[id];
         const item = itemMap[id];
-        if (item.type === 'js') {
-            item.functions = await mergeJsFunctions(itemList);
-        } else {
+        if (item.type === 'css') {
             item.ranges = await mergeCssRanges(itemList);
+        } else {
+            item.functions = await mergeJsFunctions(itemList);
         }
     }
 
@@ -236,16 +236,21 @@ const mergeV8Coverage = async (dataList, sourceCache, options) => {
     const mergedList = emptyList.concat(Object.values(itemMap));
 
     // try to load coverage and source by id
-    for (const item of mergedList) {
-        const { id } = item;
-        const json = sourceCache.get(id);
+    for (const entry of mergedList) {
+        const json = sourceCache.get(entry.id);
         if (json) {
-            item.source = json.source;
-            item.sourceMap = json.sourceMap;
+            entry.source = json.source;
+            entry.sourceMap = json.sourceMap;
         } else {
-            Util.logError(`Not found source data: ${Util.relativePath(item.sourcePath)}`);
-            item.source = '';
+            Util.logError(`Not found source data: ${Util.relativePath(entry.sourcePath)}`);
+            entry.source = '';
+        }
+
+        // add empty coverage after source init
+        if (entry.empty) {
+            Util.setEmptyV8Coverage(entry);
         }
+
     }
 
     return mergedList;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-coverage-reports",
-    "version": "2.10.8",
+    "version": "2.10.9-beta.0",
     "description": "A code coverage tool to generate native V8 reports or Istanbul reports.",
     "main": "./lib/index.js",
     "bin": {
@@ -58,7 +58,8 @@
         "dev": "npx sf d app",
         "open": "node ./scripts/open.js",
         "eol": "git rm -rf --cached . && git reset --hard HEAD",
-        "patch": "npm run build && npm run test && npx sf publish patch -r"
+        "patch": "npm version patch && npm run build && npm run test && npm publish",
+        "beta": "npm version prerelease --preid=beta && npm run build && npm run test && npm publish --tag beta"
     },
     "workspaces": [
         "test"