update options

cenfun · Dec 6, 2023 · c9bb4a7 · c9bb4a7
1 parent 7f3e4e2
commit c9bb4a7
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -17,8 +17,8 @@
 ```js
 const CoverageReport = require('monocart-coverage-reports');
 const options = {
-    outputFile: "coverage-reports/2023-11-24/index.html",
-    name: "My Coverage Report 2023-11-24"
+    outputDir: './coverage-reports',
+    reports: "v8"
 }
 const coverageReport = new CoverageReport(options);
 await coverageReport.add(coverageData1);

diff --git a/lib/converter/converter.js b/lib/converter/converter.js
@@ -393,7 +393,8 @@ const unpackSourceMap = async (item, state, options) => {
 
     // keep original urls
     const fileUrls = {};
-    initSourceMapSourcePath(sourceMap, fileUrls, options.sourcePath);
+    const sourcePathHandler = options.sourcePath;
+    initSourceMapSourcePath(sourceMap, fileUrls, sourcePathHandler);
 
     // decode mappings for each original file
     const time_start_decode = Date.now();

diff --git a/lib/default/options.js b/lib/default/options.js
@@ -37,18 +37,14 @@ const defaultOptions = {
     // },
     entryFilter: null,
 
-    // (Function) A filter function to execute for each element in the sources which unpacked from the source map. (Sourcemap only)
+    // (Function) A filter function to execute for each element in the sources which unpacked from the source map. (V8 only)
     // sourceFilter: (sourcePath) => sourcePath.search(/src\/.+/) !== -1,
     sourceFilter: null,
 
-    // (Function) source path handler. (Istanbul only)
+    // (Function) source path handler.
     // sourcePath: (filePath) => `wwwroot/${filePath}`,
     sourcePath: null,
 
-    // (Function) source finder for Istanbul HTML report. (Istanbul only)
-    // sourceFinder: (filePath) => `src/${filePath}`,
-    sourceFinder: null,
-
     // (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: [50, 80]

diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -1,10 +1,6 @@
-export type IstanbulReportConfig = {
-    name: string,
-    options: any
-}
 
 // https://playwright.dev/docs/api/class-coverage
-export type CoverageEntry = {
+export type V8CoverageEntry = {
     url: string,
     // css
     text?: string,
@@ -48,17 +44,14 @@ export type CoverageReportOptions = {
     reports?: string | ReportDescription[],
 
     // (Function) A filter function to execute for each element in the V8 list. (V8 only)
-    entryFilter?: (entry: CoverageEntry) => boolean,
+    entryFilter?: (entry: V8CoverageEntry) => boolean,
 
-    // (Function) A filter function to execute for each element in the sources which unpacked from the source map. (Sourcemap only)
+    // (Function) A filter function to execute for each element in the sources which unpacked from the source map. (V8 only)
     sourceFilter?: (sourcePath: string) => boolean,
 
-    // (Function) source path handler. (Istanbul only)
+    // (Function) source path handler.
     sourcePath?: (filePath: string) => string,
 
-    // (Function) source finder for Istanbul HTML report. (Istanbul only)
-    sourceFinder?: (filePath: string) => string,
-
     // (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] | {

diff --git a/lib/istanbul/istanbul.js b/lib/istanbul/istanbul.js
@@ -43,20 +43,19 @@ const saveIstanbulReports = (coverageData, fileSources, options) => {
         branches: [50, 80],
         lines: [50, 80]
     };
-    const istanbulOptions = {
-        watermarks: Util.resolveWatermarks(defaultWatermarks, options.watermarks),
-        defaultSummarizer: options.defaultSummarizer
-    };
+    const watermarks = Util.resolveWatermarks(defaultWatermarks, options.watermarks);
 
     // https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-lib-report
+
+    // defaultSummarizer and sourceFinder can be passed from options
     const contextOptions = {
+        coverageMap,
+        watermarks,
+        dir: options.outputDir,
         // The summarizer to default to (may be overridden by some reports)
         // values can be nested/flat/pkg. Defaults to 'pkg'
-        defaultSummarizer: 'nested',
+        defaultSummarizer: options.defaultSummarizer || 'nested',
 
-        ... istanbulOptions,
-
-        dir: options.outputDir,
         sourceFinder: (filePath) => {
 
             // console.log(`find file source: ${filePath}`);
@@ -82,8 +81,7 @@ const saveIstanbulReports = (coverageData, fileSources, options) => {
             // console.log('Not found source file:', filePath);
 
             return `Not found source file: ${filePath}`;
-        },
-        coverageMap
+        }
     };
 
     // create a context for report generation
@@ -132,8 +130,9 @@ const initIstanbulData = (istanbulData, options) => {
     }
 
     const fileSources = options.fileSources || {};
+    const sourcePathHandler = options.sourcePath;
 
-    const coverageData = initIstanbulSourcePath(istanbulData, fileSources, options.sourcePath);
+    const coverageData = initIstanbulSourcePath(istanbulData, fileSources, sourcePathHandler);
 
     return {
         fileSources,