monocart-coverage-reports 2.8.6 → 2.9.0

package/README.md

@@ -35,6 +35,7 @@
 * [Common issues](#common-issues)
     - [Unexpected coverage](#unexpected-coverage)
     - [Unparsable source](#unparsable-source)
+    - [JavaScript heap out of memory](#javascript-heap-out-of-memory)
 * [Debug for Coverage and Sourcemap](#debug-for-coverage-and-sourcemap)
 * [Integration with Any Testing Framework](#integration-with-any-testing-framework)
 * [Integration Examples](#integration-examples)
@@ -138,19 +139,27 @@ For more information, see [Command Line](#command-line)
 
 > Other build-in reports (both V8 and Istanbul data):
 
-- `codecov`
-    - coverage data for [Codecov](https://docs.codecov.com/docs/codecov-custom-coverage-format), see [example](https://app.codecov.io/github/cenfun/monocart-coverage-reports) 
+- `codecov` Save coverage data to a json file with [Codecov](https://docs.codecov.com/docs/codecov-custom-coverage-format) format (defaults to `codecov.json`), see [example](https://app.codecov.io/github/cenfun/monocart-coverage-reports).
 
-- `console-summary` shows coverage summary in the console
+- `codacy` Save coverage data to a json file with [Codacy API](https://api.codacy.com/swagger#tocscoveragereport) format (defaults to `codacy.json`).
+
+- `console-summary` shows coverage summary in the console.
 
 ![](./assets/console-summary.png)
 
-- `console-details` Show file coverage and uncovered lines in the console. Like `text`, but for V8. For Github actions, we can enforce color with env: `FORCE_COLOR: true`.
+- `console-details` Show coverage details in the console. Like `text`, but for V8. For Github actions, we can enforce color with env: `FORCE_COLOR: true`.
 
 ![](./assets/console-details.png)
 
-- `raw` only keep all original data, which can be used for other reports input with `inputDir`
-    - see [Merge Coverage Reports](#merge-coverage-reports)
+- `markdown-summary` Save coverage summary to a markdown file (defaults to `coverage-summary.md`). For Github actions, we can show the markdown content to [a job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary)
+```sh
+cat path-to/coverage-summary.md >> $GITHUB_STEP_SUMMARY
+```
+![](./assets/markdown-summary.png)
+
+- `markdown-details` Save coverage details to a markdown file (defaults to `coverage-details.md`).
+
+- `raw` only keep all original data, which can be used for other reports input with `inputDir`. see [Merge Coverage Reports](#merge-coverage-reports)
 
 - Custom Reporter
     ```js
@@ -881,6 +890,15 @@ const coverageOptions = {
 }
 ```
 
+### JavaScript heap out of memory
+When there are a lot of raw v8 coverage files to process, it may cause OOM. We can try the following Node.js options:
+```sh
+- run: npm run test:coverage
+    env:
+        NODE_OPTIONS: --max-old-space-size=8192
+```
+
+
 ## Debug for Coverage and Sourcemap
 > Sometimes, the coverage is not what we expect. The next step is to figure out why, and we can easily find out the answer step by step through debugging.
 - Start debugging for v8 report with option `logging: 'debug'`
@@ -900,6 +918,11 @@ When `logging` is `debug`, the raw report data will be preserved in `[outputDir]
 
 ![](./assets/debug-sourcemap.png)
 
+- Show time logs with env `MCR_LOG_TIME`
+```js
+process.env.MCR_LOG_TIME = true
+```
+
 ## Integration with Any Testing Framework
 - API
     - Collecting coverage data when any stage of the test is completed, and adding the coverage data to the coverage reporter. `await mcr.add(coverageData)`

package/README.zh-Hans.md

@@ -35,6 +35,7 @@
 * [常见问题](#common-issues)
     - [Unexpected coverage](#unexpected-coverage)
     - [Unparsable source](#unparsable-source)
+    - [JavaScript heap out of memory](#javascript-heap-out-of-memory)
 * [如何调试覆盖率数据和查看sourcemap](#debug-for-coverage-and-sourcemap)
 * [如何跟其他框架集成](#integration-with-any-testing-framework)
 * [集成的例子](#integration-examples)
@@ -138,8 +139,9 @@ mcr node my-app.js -r v8,console-details
 
 > 其他内置报告 (V8和Istanbul格式数据都支持):
 
-- `codecov`
-    - 专属支持[Codecov](https://docs.codecov.com/docs/codecov-custom-coverage-format)的报告, see [example](https://app.codecov.io/github/cenfun/monocart-coverage-reports) 
+- `codecov` 保存覆盖率数据到 [Codecov](https://docs.codecov.com/docs/codecov-custom-coverage-format) 专属的json文件 (默认是`codecov.json`), 见[例子](https://app.codecov.io/github/cenfun/monocart-coverage-reports) 
+
+- `codacy` 保存覆盖率数据到 [Codacy](https://api.codacy.com/swagger#tocscoveragereport) 专属的json文件 (默认是`codacy.json`)
 
 - `console-summary` 在控制台显示覆盖率概要
 
@@ -149,8 +151,15 @@ mcr node my-app.js -r v8,console-details
 
 ![](./assets/console-details.png)
 
-- `raw` 只是保存原始覆盖率数据, 用于使用`inputDir`参数来导入多个原始数据进行合并报告
-    - 参见 [合并覆盖率报告](#merge-coverage-reports)
+- `markdown-summary` 保存概要信息到markdown文件 (默认是`coverage-summary.md`)。 如果是Github actions, 可以把markdown的内容添加到[a job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary)
+```sh
+cat path-to/coverage-summary.md >> $GITHUB_STEP_SUMMARY
+```
+![](./assets/markdown-summary.png)
+
+- `markdown-details` 保存覆盖率详情到markdown文件 (默认是 `coverage-details.md`)
+
+- `raw` 只是保存原始覆盖率数据, 用于使用`inputDir`参数来导入多个原始数据进行合并报告。参见 [合并覆盖率报告](#merge-coverage-reports)
 
 - 自定义报告
     ```js
@@ -884,6 +893,15 @@ const coverageOptions = {
 }
 ```
 
+### JavaScript heap out of memory
+内存溢出问题可能出现在有太多的原生V8覆盖率文件要处理. 我们可以使用Node.js的一个选项来增加内存使用:
+```sh
+- run: npm run test:coverage
+    env:
+        NODE_OPTIONS: --max-old-space-size=8192
+```
+
+
 ## Debug for Coverage and Sourcemap
 > 当你觉得覆盖率存在问题的时候，`MCR`支持自行调试来核验覆盖率的准确性
 - 首先打开调试设置`logging: 'debug'`
@@ -903,6 +921,11 @@ const coverageOptions = {
 
 ![](./assets/debug-sourcemap.png)
 
+- 使用环境变量`MCR_LOG_TIME`显示时间日志
+```js
+process.env.MCR_LOG_TIME = true
+```
+
 ## Integration with Any Testing Framework
 通用集成方案
 - 通过API接口在程序集成

package/lib/converter/converter.js

@@ -115,24 +115,30 @@ const handleLinesCoverage = (bytes, locator, ignoredRanges) => {
     // init lines
     let blankCount = 0;
     let commentCount = 0;
+    const dataExtras = {};
     // line 1 based
     const lineMap = new Map();
     locator.lines.forEach((lineItem) => {
+        // line 1-base
+        const line = lineItem.line + 1;
+
         // exclude blank and comment
         if (lineItem.blank) {
             blankCount += 1;
+            dataExtras[line] = 'b';
             return;
         }
         if (lineItem.comment) {
             commentCount += 1;
+            dataExtras[line] = 'c';
             return;
         }
         const ignored = Util.findInRanges(lineItem.start, lineItem.end, ignoredRanges);
         if (ignored) {
+            dataExtras[line] = 'i';
             return;
         }
-        // line 1-base
-        const line = lineItem.line + 1;
+
         lineItem.coveredCount = 1;
         lineItem.uncoveredEntire = null;
         lineItem.uncoveredPieces = [];
@@ -147,8 +153,7 @@ const handleLinesCoverage = (bytes, locator, ignoredRanges) => {
         blank: blankCount,
         comment: commentCount
     };
-    // data lines for codecov
-    // https://docs.codecov.com/docs/codecov-custom-coverage-format
+    // data lines
     const dataLines = {};
 
     // no ignore items
@@ -165,6 +170,7 @@ const handleLinesCoverage = (bytes, locator, ignoredRanges) => {
 
     return {
         dataLines,
+        dataExtras,
         summaryLines
     };
 };
@@ -263,9 +269,12 @@ const collectFileCoverage = (v8Data, state, options) => {
     // ==========================================
     // lines
     // after bytes with ignored, before calculateV8Lines
-    const { dataLines, summaryLines } = handleLinesCoverage(data.bytes, locator, ignoredRanges);
+    const {
+        dataLines, dataExtras, summaryLines
+    } = handleLinesCoverage(data.bytes, locator, ignoredRanges);
 
     data.lines = dataLines;
+    data.extras = dataExtras;
 
     // console.log('statements', state.sourcePath, statements.length);
 

package/lib/default/options.js

@@ -27,6 +27,9 @@ module.exports = {
     // {string} base dir for normalizing the relative source path, defaults to cwd
     baseDir: null,
 
+    // {string} coverage data dir, alternative to method `addFromDir()`, defaults to null
+    dataDir: null,
+
     // (V8 only) {function} A filter function to execute for each element in the V8 list.
     // entryFilter: (entry) => {
     //     if (entry.url.indexOf('googleapis.com') !== -1) {