monocart-coverage-reports 2.8.1 → 2.8.3

package/README.md

@@ -21,7 +21,7 @@
     - [Collecting V8 Coverage Data from Node.js](#collecting-v8-coverage-data-from-nodejs)
     - [Collecting V8 Coverage Data with `CDPClient` API](#collecting-v8-coverage-data-with-cdpclient-api)
     - [V8 Coverage Data API](#v8-coverage-data-api)
-* [Using `entryFilter` and `sourceFilter` to filter the results for V8 report](#using-entryfilter-and-sourcefilter-to-filter-the-results-for-v8-report)
+* [Filtering Results](#filtering-results)
 * [Resolve `sourcePath` for the Source Files](#resolve-sourcepath-for-the-source-files)
 * [Adding Empty Coverage for Untested Files](#adding-empty-coverage-for-untested-files)
 * [onEnd Hook](#onend-hook)
@@ -53,6 +53,7 @@
     - [ts-node](#ts-node)
     - [AVA](#ava)
     - [Codecov](#codecov)
+    - [Codacy](#codacy)
     - [Coveralls](#coveralls)
     - [Sonar Cloud](#sonar-cloud)
 * [Contributing](#contributing)
@@ -467,7 +468,8 @@ export interface ScriptCoverage {
 export type V8CoverageData = ScriptCoverage[];
 ```
 
-## Using `entryFilter` and `sourceFilter` to filter the results for V8 report
+## Filtering Results
+### Using `entryFilter` and `sourceFilter` to filter the results for V8 report
 When V8 coverage data collected, it actually contains the data of all entry files, for example:
 
 - *dist/main.js*
@@ -517,19 +519,33 @@ const coverageOptions = {
     }
 };
 ```
-In fact, the `minimatch` patterns will be transformed to a function like:
+As CLI args (JSON-like string. Added in: v2.8):
+```sh
+mcr --sourceFilter "{'**/node_modules/**':false,'**/**':true}"
+```
+Note, those patterns will be transformed to a function, and the order of the patterns will impact the results:
 ```js
 const coverageOptions = {
-    // '**/node_modules/**': false,
-    // '**/vendor.js': false,
-    // '**/src/**': true
     entryFilter: (entry) => {
         if (minimatch(entry.url, '**/node_modules/**')) { return false; }
         if (minimatch(entry.url, '**/vendor.js')) { return false; }
         if (minimatch(entry.url, '**/src/**')) { return true; }
         return false; // else unmatched
     }
-    // Note, the order of the patterns will impact the results
+};
+```
+
+### Using `filter` instead of `entryFilter` and `sourceFilter`
+If you don't want to define both `entryFilter` and `sourceFilter`, you can use `filter` instead. (Added in: v2.8)
+```js
+const coverageOptions = {
+    // combined patterns
+    filter: {
+        '**/node_modules/**': false,
+        '**/vendor.js': false,
+        '**/src/**': true
+        '**/**': true
+    }
 };
 ```
 
@@ -826,6 +842,7 @@ await new CoverageReport(coverageOptions).generate();
     }
 }
 ```
+see example: [merge-code-coverage](https://github.com/cenfun/merge-code-coverage)
 
 ## Common issues
 ### Unexpected coverage
@@ -897,6 +914,7 @@ When `logging` is `debug`, the raw report data will be preserved in `[outputDir]
 - [playwright-coverage](https://github.com/cenfun/playwright-coverage) - Example for Playwright coverage reports
 - [playwright-bdd-coverage](https://github.com/cenfun/playwright-bdd-coverage) - Example for Playwright BDD coverage reports
 - [monocart-reporter](https://github.com/cenfun/monocart-reporter) - Playwright custom reporter, supports generating [Code coverage report](https://github.com/cenfun/monocart-reporter?#code-coverage-report)
+- [merge-code-coverage](https://github.com/cenfun/merge-code-coverage) - Example for merging code coverage (unit + e2e shard)
 - Coverage for component testing with `monocart-reporter`:
     - [playwright-ct-vue](https://github.com/cenfun/playwright-ct-vue)
     - [playwright-ct-react](https://github.com/cenfun/playwright-ct-react)
@@ -969,13 +987,32 @@ const coverageOptions = {
     ]
 };
 ```
-- Github actions example:
+- Github actions:
 ```yml
 - name: Codecov
     uses: codecov/codecov-action@v3
     with:
         files: ./coverage-reports/codecov.json
 ```
+
+### [Codacy](https://www.codacy.com/)
+[![Codacy](https://app.codacy.com/project/badge/Coverage/715016ea8e90479db875b777db8bad55)](https://app.codacy.com/gh/cenfun/monocart-coverage-reports/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
+- Using `lcov` report:
+```js
+const coverageOptions = {
+    outputDir: "./coverage-reports",
+    lcov: true
+};
+```
+- Github actions:
+```yml
+- name: Codacy Coverage Reporter
+    uses: codacy/codacy-coverage-reporter-action@v1
+    with:
+        project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+        coverage-reports: ./docs/mcr/lcov.info
+```
+
 ### [Coveralls](https://coveralls.io/)
 [![Coverage Status](https://coveralls.io/repos/github/cenfun/monocart-coverage-reports/badge.svg?branch=main)](https://coveralls.io/github/cenfun/monocart-coverage-reports?branch=main)
 - Using `lcov` report:
@@ -985,13 +1022,14 @@ const coverageOptions = {
     lcov: true
 };
 ```
-- Github actions example:
+- Github actions:
 ```yml
 - name: Coveralls
     uses: coverallsapp/github-action@v2
     with:
         files: ./coverage-reports/lcov.info
 ```
+
 ### [Sonar Cloud](https://sonarcloud.io/)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=monocart-coverage-reports&metric=coverage)](https://sonarcloud.io/summary/new_code?id=monocart-coverage-reports)
 - Using `lcov` report. Github actions example:
@@ -1013,8 +1051,9 @@ const coverageOptions = {
 ```
 
 ## Contributing
+- Node.js 20+
+- VSCode (extensions: eslint/stylelint/vue)
 ```sh
-# Node.js 20+
 npm install starfall-cli -g
 npm install
 

package/README.zh-Hans.md

@@ -21,7 +21,7 @@
     - [从Node.js](#collecting-v8-coverage-data-from-nodejs)
     - [使用`CDPClient`API](#collecting-v8-coverage-data-with-cdpclient-api)
     - [参考V8覆盖率的API](#v8-coverage-data-api)
-* [使用 `entryFilter` 和 `sourceFilter` 来过滤V8覆盖率数据](#using-entryfilter-and-sourcefilter-to-filter-the-results-for-v8-report)
+* [过滤V8覆盖率数据](#filtering-results)
 * [使用 `sourcePath` 修改源文件路径](#resolve-sourcepath-for-the-source-files)
 * [为未测试的文件添加空的覆盖率报告](#adding-empty-coverage-for-untested-files)
 * [onEnd回调函数](#onend-hook)
@@ -53,6 +53,7 @@
     - [ts-node](#ts-node)
     - [AVA](#ava)
     - [Codecov](#codecov)
+    - [Codacy](#codacy)
     - [Coveralls](#coveralls)
     - [Sonar Cloud](#sonar-cloud)
 * [Contributing](#contributing)
@@ -471,6 +472,7 @@ export interface ScriptCoverage {
 export type V8CoverageData = ScriptCoverage[];
 ```
 
+## Filtering Results
 ## Using `entryFilter` and `sourceFilter` to filter the results for V8 report
 当收集到V8的覆盖数据时，它实际上包含了所有的入口文件的覆盖率数据, 比如有以下3个文件:
 
@@ -521,19 +523,33 @@ const coverageOptions = {
     }
 };
 ```
-这些`minimatch`匹配的运行逻辑，大概相当于:
+作为CLI参数（JSON字符串，Added in: v2.8）:
+```sh
+mcr --sourceFilter "{'**/node_modules/**':false,'**/**':true}"
+```
+注意，这些匹配实际上会转换成一个过滤函数（如下），所以如果一个匹配成功则会直接返回，后面的将不再继续匹配。请注意先后顺序，如果存在包含关系的，可以调整上下顺序，最后如果都未匹配，则默认返回false
 ```js
 const coverageOptions = {
-    // '**/node_modules/**': false,
-    // '**/vendor.js': false,
-    // '**/src/**': true
     entryFilter: (entry) => {
         if (minimatch(entry.url, '**/node_modules/**')) { return false; }
         if (minimatch(entry.url, '**/vendor.js')) { return false; }
         if (minimatch(entry.url, '**/src/**')) { return true; }
         return false; // else unmatched
     }
-    // 注意，前面的如果已经匹配到会直接返回，后面的不会继续匹配，所以如果存在包含关系的，需要注意每个匹配的上下顺序，最后如果都未匹配，则默认返回false
+};
+```
+
+### Using `filter` instead of `entryFilter` and `sourceFilter`
+如果你不想定义两个过滤器，可以使用 `filter` 选项代替，可以将多个匹配合并在一起. (Added in: v2.8)
+```js
+const coverageOptions = {
+    // combined patterns
+    filter: {
+        '**/node_modules/**': false,
+        '**/vendor.js': false,
+        '**/src/**': true
+        '**/**': true
+    }
 };
 ```
 
@@ -828,6 +844,7 @@ await new CoverageReport(coverageOptions).generate();
     }
 }
 ```
+参见例子： [merge-code-coverage](https://github.com/cenfun/merge-code-coverage)
 
 ## Common issues
 > 常见问题
@@ -901,6 +918,7 @@ const coverageOptions = {
 - [playwright-coverage](https://github.com/cenfun/playwright-coverage) - Example for Playwright coverage reports
 - [playwright-bdd-coverage](https://github.com/cenfun/playwright-bdd-coverage) - Example for Playwright BDD coverage reports
 - [monocart-reporter](https://github.com/cenfun/monocart-reporter) - Playwright custom reporter, supports generating [Code coverage report](https://github.com/cenfun/monocart-reporter?#code-coverage-report)
+- [merge-code-coverage](https://github.com/cenfun/merge-code-coverage) - Example for merging code coverage (unit + e2e shard)
 - Coverage for component testing with `monocart-reporter`:
     - [playwright-ct-vue](https://github.com/cenfun/playwright-ct-vue)
     - [playwright-ct-react](https://github.com/cenfun/playwright-ct-react)
@@ -980,6 +998,25 @@ const coverageOptions = {
     with:
         files: ./coverage-reports/codecov.json
 ```
+
+### [Codacy](https://www.codacy.com/)
+[![Codacy](https://app.codacy.com/project/badge/Coverage/715016ea8e90479db875b777db8bad55)](https://app.codacy.com/gh/cenfun/monocart-coverage-reports/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
+- Using `lcov` report:
+```js
+const coverageOptions = {
+    outputDir: "./coverage-reports",
+    lcov: true
+};
+```
+- Github actions:
+```yml
+- name: Codacy Coverage Reporter
+    uses: codacy/codacy-coverage-reporter-action@v1
+    with:
+        project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+        coverage-reports: ./docs/mcr/lcov.info
+```
+
 ### [Coveralls](https://coveralls.io/)
 [![Coverage Status](https://coveralls.io/repos/github/cenfun/monocart-coverage-reports/badge.svg?branch=main)](https://coveralls.io/github/cenfun/monocart-coverage-reports?branch=main)
 - Using `lcov` report:
@@ -996,6 +1033,7 @@ const coverageOptions = {
     with:
         files: ./coverage-reports/lcov.info
 ```
+
 ### [Sonar Cloud](https://sonarcloud.io/)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=monocart-coverage-reports&metric=coverage)](https://sonarcloud.io/summary/new_code?id=monocart-coverage-reports)
 - Using `lcov` report. Github actions example:
@@ -1017,8 +1055,9 @@ const coverageOptions = {
 ```
 
 ## Contributing
+- Node.js 20+
+- VSCode (extensions: eslint/stylelint/vue)
 ```sh
-# Node.js 20+
 npm install starfall-cli -g
 npm install
 

package/lib/cli.js

@@ -6,7 +6,7 @@ const EC = require('eight-colors');
 const {
     foregroundChild,
     program
-} = require('./packages/monocart-coverage-vendor.js');
+} = require('./packages/monocart-coverage-cli.js');
 
 const MCR = require('./index.js');
 const Util = require('./utils/util.js');