monocart-coverage-reports 2.5.7 → 2.5.9

package/lib/index.d.ts

@@ -220,19 +220,41 @@ declare namespace MCR {
 
         /** (V8 only) 
          * 
-         * {string} `minimatch` pattern for entry url; multiple patterns: "{pattern1,pattern2}";
+         * {string} `minimatch` pattern for entry url; {object} multiple patterns;
          * 
          * {function} A filter function for each entry file in the V8 list.
          * */
-        entryFilter?: string | ((entry: V8CoverageEntry) => boolean);
+        entryFilter?: string | {
+            [pattern: string]: boolean;
+        } | ((entry: V8CoverageEntry) => boolean);
 
         /** (V8 only) 
          * 
-         * {string} `minimatch` pattern for source path; multiple patterns: "{pattern1,pattern2}";
+         * {string} `minimatch` pattern for source path; {object} multiple patterns;
          * 
          * {function} A filter function for each source path when the source is unpacked from the source map. 
          * */
-        sourceFilter?: string | ((sourcePath: string) => boolean);
+        sourceFilter?: string | {
+            [pattern: string]: boolean;
+        } | ((sourcePath: string) => boolean);
+
+        /**
+         * options for adding empty coverage for all files
+         */
+        all?: string | string[] | {
+            /** the dir(s) of all files */
+            dir: string | string[];
+            /** the coverage data type, v8 or istanbul */
+            type?: "v8" | "istanbul";
+            /** 
+             * the file filter, return the file type, if true, defaults to css if ".css" otherwise is js 
+             * 
+             * {string} `minimatch` pattern for file path; {object} multiple patterns; {function} A filter function for file path;
+            */
+            filter?: string | {
+                [pattern: string]: "js" | "css" | boolean;
+            } | ((filePath: string) => "js" | "css" | boolean)
+        };
 
         /** (V8 only) {boolean} Enable/Disable ignoring uncovered codes with the special comments: v8 ignore next/next N/start/stop */
         v8Ignore?: boolean;
@@ -258,9 +280,16 @@ declare namespace MCR {
         * {object} { bytes:[50,80], statements:[50,80], branches:[50,80], functions:[50,80], lines:[50,80] } */
         watermarks?: Watermarks;
 
-        /** {boolean} clean previous files in output dir before generating report. Defaults to true. */
+        /** {boolean} Indicates whether to clean previous files in output dir before generating report. Defaults to true. */
         clean?: boolean;
 
+        /**
+         * {boolean} Indicates whether to clean previous cache in output dir before generating report. Defaults to false. 
+         * 
+         * If true, the API `cleanCache()` will execute automatically.
+        */
+        cleanCache?: boolean;
+
         /** {function} onEnd hook */
         onEnd?: (reportData: CoverageResults) => Promise<void>;
     }

package/lib/index.js

@@ -14,6 +14,13 @@ class CoverageReport {
             ... defaultOptions,
             ... options
         };
+
+        this.initOptions();
+        // If true, the API `cleanCache()` will execute automatically.
+        if (this.options.cleanCache) {
+            this.cleanCache();
+        }
+
     }
 
     initOptions() {
@@ -83,7 +90,10 @@ class CoverageReport {
 
         this.initOptions();
 
-        const { inputDir, cacheDir } = this.options;
+        const {
+            all, inputDir, cacheDir
+        } = this.options;
+
         const inputDirs = Util.toList(inputDir, ',');
         if (this.hasCache()) {
             inputDirs.push(cacheDir);
@@ -92,16 +102,16 @@ class CoverageReport {
         const inputList = inputDirs.filter((dir) => {
             const hasDir = fs.existsSync(dir);
             if (!hasDir) {
-                Util.logError(`Not found coverage data dir: ${Util.relativePath(dir)}`);
+                // could be empty
+                Util.logInfo(`Not found coverage data dir: ${Util.relativePath(dir)}`);
             }
             return hasDir;
         });
 
-        if (!inputList.length) {
-            return;
-        }
+        const { dataList, sourceCache } = await getInputData(inputList, all, cacheDir, (emptyData) => {
+            return this.add(emptyData);
+        });
 
-        const { dataList, sourceCache } = await getInputData(inputList);
         if (!dataList.length) {
             const dirs = inputList.map((dir) => Util.relativePath(dir));
             Util.logError(`Not found coverage data in dir(s): ${dirs.join(', ')}`);