monocart-coverage-reports 1.0.4 → 1.0.6

package/README.md

@@ -23,8 +23,8 @@ const options = {
 const coverageReport = new CoverageReport(options);
 await coverageReport.add(coverageData1);
 await coverageReport.add(coverageData2);
-const report = await coverageReport.generate();
-console.log(report.summary);
+const coverageResults = await coverageReport.generate();
+console.log(coverageResults.summary);
 ```
 - [example v8](https://github.com/cenfun/monocart-coverage-reports/blob/main/tests/test-v8.js)
 - [example istanbul](https://github.com/cenfun/monocart-coverage-reports/blob/main/tests/test-istanbul.js)
@@ -92,8 +92,8 @@ await coverageReport.add(coverageData2);
 const CoverageReport = require('monocart-coverage-reports');
 const options = require('path-to/same-options.js');
 const coverageReport = new CoverageReport(options);
-const report = await coverageReport.generate();
-console.log(report.summary);
+const coverageResults = await coverageReport.generate();
+console.log(coverageResults.summary);
 ```
 
 ## Compare Reports

package/lib/converter/collect-source-maps.js

@@ -23,12 +23,12 @@ const loadSourceMap = async (url = '') => {
 
     if (url.startsWith('file://')) {
         const p = fileURLToPath(url);
-        const json = Util.readJSONSync(p);
-        if (!json) {
+        const content = Util.readFileSync(p);
+        if (!content) {
             Util.logDebug(EC.red(`failed to load sourcemap ${p}`));
             return;
         }
-        return json;
+        return JSON.parse(content);
     }
 
     const [err, res] = await request({

package/lib/index.d.ts

@@ -11,6 +11,14 @@ export type V8CoverageEntry = {
     functions?: any[]
 }
 
+export type Watermarks = [number, number] | {
+    statements?: [number, number],
+    functions?: [number, number],
+    branches?: [number, number],
+    lines?: [number, number],
+    bytes?: [number, number]
+}
+
 export type ReportDescription =
     ['v8'] |
     ['clover'] | ['clover', {
@@ -110,14 +118,17 @@ export type CoverageReportOptions = {
 
     // (Array) watermarks for low/medium/high. Defaults to [50, 80]
     // (Object) Istanbul: { statements:[50,80], functions:[50,80], branches:[50,80], lines:[50,80] }, V8: { bytes:[50,80] }.
-    watermarks?: [number, number] | {
-        statements?: [number, number],
-        functions?: [number, number],
-        branches?: [number, number],
-        lines?: [number, number],
-        bytes?: [number, number]
-    }
-};
+    watermarks?: Watermarks
+}
+
+export type CoverageResults = {
+    type: "v8" | "istanbul",
+    reportPath: string,
+    name: string,
+    watermarks: Watermarks,
+    summary: any,
+    files: any
+}
 
 export class CoverageReport {
     constructor(options?: CoverageReportOptions);
@@ -126,7 +137,7 @@ export class CoverageReport {
     add: (coverageData: any[] | any) => Promise<any>;
 
     // generate report
-    generate: () => Promise<any>;
+    generate: () => Promise<CoverageResults>;
 
     // check if cache exists
     hasCache: () => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-coverage-reports",
-    "version": "1.0.4",
+    "version": "1.0.6",
     "description": "Monocart coverage reports",
     "main": "lib/index.js",
     "exports": {