monocart-coverage-reports 2.5.9 → 2.6.1

package/lib/index.d.ts

@@ -1,324 +1,360 @@
-declare namespace MCR {
-
-    export interface V8CoverageEntry {
-        url: string;
-        /** css only */
-        text?: string;
-        /** css only */
-        ranges?: any[];
-        /** js only */
-        scriptId?: string;
-        /** js only */
-        source?: string;
-        /** js only */
-        functions?: any[];
-    }
-
-    export type Watermarks = [number, number] | {
-        /** V8 only */
-        bytes?: [number, number];
-        statements?: [number, number];
-        branches?: [number, number];
-        functions?: [number, number];
-        lines?: [number, number];
-    }
-
-    export type ReportDescription =
-        ['v8'] | ["v8", {
-            outputFile?: string;
-            inline?: boolean;
-            assetsPath?: string;
-            metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
-        }] |
-        ['v8-json'] | ["v8-json", {
-            outputFile?: string;
-        }] |
-        ['codecov'] | ["codecov", {
-            outputFile?: string;
-        }] |
-        ['console-details'] | ['console-details', {
-            maxCols?: number;
-            skipPercent?: number;
-            metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
-        }] |
-        ['clover'] | ['clover', {
-            file?: string;
-        }] |
-        ['cobertura'] | ['cobertura', {
-            file?: string;
-            timestamp?: string;
-            projectRoot?: string;
-        }] |
-        ['html'] | ['html', {
-            subdir?: string;
-            verbose?: boolean;
-            linkMapper?: any;
-            skipEmpty?: boolean;
-        }] |
-        ['html-spa'] | ['html-spa', {
-            subdir?: string;
-            verbose?: boolean;
-            linkMapper?: any;
-            skipEmpty?: boolean;
-            metricsToShow?: Array<"statements" | "branches" | "functions" | "lines">;
-        }] |
-        ['json'] | ['json', {
-            file?: string;
-        }] |
-        ['json-summary'] | ['json-summary', {
-            file?: string;
-        }] |
-        ['lcov'] | ['lcov', {
-            file?: string;
-            projectRoot?: string;
-        }] |
-        ['lcovonly'] | ['lcovonly', {
-            file?: string;
-            projectRoot?: string;
-        }] |
-        ['none'] |
-        ['teamcity'] | ['teamcity', {
-            file?: string;
-            blockName?: string;
-        }] |
-        ['text'] | ['text', {
-            file?: string;
-            maxCols?: number;
-            skipEmpty?: boolean;
-            skipFull?: boolean;
-        }] |
-        ['text-lcov'] | ['text-lcov', {
-            projectRoot?: string;
-        }] |
-        ['text-summary'] | ['text-summary', {
-            file?: string;
-        }] |
-        ['console-summary'] | ['console-summary', {
-            metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
-        }] |
-        ['raw'] | ['raw', {
-            outputDir?: string;
-        }] |
-        [string] | [string, {
-            type?: "v8" | "istanbul" | "both";
-            [key: string]: any;
-        }];
-
-    export type AddedResults = {
-        id: string;
-        path: string;
-        type: "v8" | "istanbul";
-        data: any;
-    } | undefined;
-
-
-    export interface MetricsSummary {
-        covered: number;
-        uncovered?: number;
-        total: number;
-        pct: number | "";
-        status: "low" | "medium" | "high" | "unknown";
-        /** V8 lines only */
-        blank?: number;
-        /** V8 lines only */
-        comment?: number;
-    }
-
-    export interface CoverageSummary {
-        /** V8 only */
-        bytes?: MetricsSummary;
-        statements?: MetricsSummary;
-        branches: MetricsSummary;
-        functions: MetricsSummary;
-        lines: MetricsSummary;
-    }
-
-    /** V8 only */
-    export interface CoverageRange {
-        start: number;
-        end: number;
-        count: number;
-        ignored?: boolean;
-        none?: boolean;
-    }
-
-    export interface IgnoredRange {
-        start: number;
-        end: number;
-        type: string;
-        n?: number;
-    }
-
-    export interface CoverageFile {
-        sourcePath: string;
-        summary: CoverageSummary;
-        /** V8 only */
-        url?: string;
-        /** V8 only */
-        id?: string;
-        /** V8 only */
-        type?: string;
-        /** V8 only */
-        source?: string;
-        /** V8 only */
-        distFile?: string;
-        /** V8 only */
-        js?: boolean;
-        /** V8 only */
-        data?: {
-            bytes: CoverageRange[];
-            statements: CoverageRange[];
-            branches: CoverageRange[];
-            functions: CoverageRange[];
-            ignores?: IgnoredRange[];
-            /** codecov json format */
-            lines: {
-                [key: string]: number | string
-            };
-        }
-    }
-
-    export type CoverageResults = {
-        type: "v8" | "istanbul";
-        reportPath: string;
-        name: string;
-        watermarks: Watermarks;
-        summary: CoverageSummary;
-        files: CoverageFile[];
-    } | undefined;
-
-    export interface CoverageReportOptions {
-
-        /** {string} logging levels: off, error, info, debug */
-        logging?: string;
-
-        /** {string} output dir */
-        outputDir?: string;
-
-        /** {string|string[]} input raw dir(s) */
-        inputDir?: string | string[];
-
-        /** 
-         * 
-         * {string} 'v8', 'v8,console-details'
-         * 
-         * {array} ['v8'], ['v8', ['console-details', { skipPercent: 80 }]]
-         * 
-         * By default, `v8` for V8 data, `html` for Istanbul data
-        */
-        reports?: string | ReportDescription[];
-
-        /** {string} Report name. Defaults to "Coverage Report". */
-        name?: string;
-
-        /** (V8 only) {string} Output [sub dir/]filename. Defaults to "index.html" */
-        outputFile?: string;
-        /** (V8 only) {boolean} Inline all scripts to the single HTML file. Defaults to false. */
-        inline?: boolean;
-        /** (V8 only) {string} Assets path if not inline. Defaults to "./assets" */
-        assetsPath?: string;
-
-        /** (V8 only) 
-         * 
-         * {string} `minimatch` pattern for entry url; {object} multiple patterns;
-         * 
-         * {function} A filter function for each entry file in the V8 list.
-         * */
-        entryFilter?: string | {
-            [pattern: string]: boolean;
-        } | ((entry: V8CoverageEntry) => boolean);
-
-        /** (V8 only) 
-         * 
-         * {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 | {
-            [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;
-
-        /** (Istanbul only) defaultSummarizer, sourceFinder  */
-
-        /** {boolean} Generate lcov.info file, same as lcovonly report. Defaults to false.  */
-        lcov?: boolean;
-
-        /** 
-         * {function} Source path handler. 
-         * 
-         * {object} Replace key with value.
-         * */
-        sourcePath?: ((filePath: string) => string) | {
-            [key: string]: string;
-        };
-
-        /** {string|function} Specify the report path, especially when there are multiple reports. Defaults to outputDir/index.html. */
-        reportPath?: string | (() => string);
-
-        /** {array} watermarks for low/medium/high. Defaults to [50, 80]
-        * {object} { bytes:[50,80], statements:[50,80], branches:[50,80], functions:[50,80], lines:[50,80] } */
-        watermarks?: Watermarks;
-
-        /** {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>;
-    }
-
-    export class CoverageReport {
-
-        constructor(options?: CoverageReportOptions);
-
-        /** add coverage data: {array} V8 format, {object} Istanbul format */
-        add: (coverageData: any[] | any) => Promise<AddedResults>;
-
-        /** generate report */
-        generate: () => Promise<CoverageResults>;
-
-        /** check if cache exists */
-        hasCache: () => boolean;
-
-        /** clean previous cache, return `false` if no cache */
-        cleanCache: () => boolean;
-    }
-
-    export interface McrCliOptions extends CoverageReportOptions {
-        /** {function} onStart hook */
-        onStart?: (coverageReport: CoverageReport) => Promise<void>;
-    }
-
-}
-
-/** create coverage report */
-declare function MCR(options?: MCR.CoverageReportOptions): MCR.CoverageReport;
-
-export = MCR;
+declare namespace MCR {
+
+    export interface V8CoverageEntry {
+        url: string;
+        /** css only */
+        text?: string;
+        /** css only */
+        ranges?: any[];
+        /** js only */
+        scriptId?: string;
+        /** js only */
+        source?: string;
+        /** js only */
+        functions?: any[];
+    }
+
+    export type Watermarks = [number, number] | {
+        /** V8 only */
+        bytes?: [number, number];
+        statements: [number, number];
+        branches?: [number, number];
+        functions?: [number, number];
+        lines?: [number, number];
+    }
+
+    export type ReportDescription =
+        ['v8'] | ["v8", {
+            outputFile?: string;
+            inline?: boolean;
+            assetsPath?: string;
+            metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
+        }] |
+        ['v8-json'] | ["v8-json", {
+            outputFile?: string;
+        }] |
+        ['clover'] | ['clover', {
+            file?: string;
+        }] |
+        ['cobertura'] | ['cobertura', {
+            file?: string;
+            timestamp?: string;
+            projectRoot?: string;
+        }] |
+        ['html'] | ['html', {
+            subdir?: string;
+            verbose?: boolean;
+            linkMapper?: any;
+            skipEmpty?: boolean;
+        }] |
+        ['html-spa'] | ['html-spa', {
+            subdir?: string;
+            verbose?: boolean;
+            linkMapper?: any;
+            skipEmpty?: boolean;
+            metricsToShow?: Array<"statements" | "branches" | "functions" | "lines">;
+        }] |
+        ['json'] | ['json', {
+            file?: string;
+        }] |
+        ['json-summary'] | ['json-summary', {
+            file?: string;
+        }] |
+        ['lcov'] | ['lcov', {
+            file?: string;
+            projectRoot?: string;
+        }] |
+        ['lcovonly'] | ['lcovonly', {
+            file?: string;
+            projectRoot?: string;
+        }] |
+        ['none'] |
+        ['teamcity'] | ['teamcity', {
+            file?: string;
+            blockName?: string;
+        }] |
+        ['text'] | ['text', {
+            file?: string;
+            maxCols?: number;
+            skipEmpty?: boolean;
+            skipFull?: boolean;
+        }] |
+        ['text-lcov'] | ['text-lcov', {
+            projectRoot?: string;
+        }] |
+        ['text-summary'] | ['text-summary', {
+            file?: string;
+        }] |
+        ['codecov'] | ["codecov", {
+            outputFile?: string;
+        }] |
+        ['console-summary'] | ['console-summary', {
+            metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
+        }] |
+        ['console-details'] | ['console-details', {
+            maxCols?: number;
+            skipPercent?: number;
+            metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
+        }] |
+        ['raw'] | ['raw', {
+            outputDir?: string;
+        }] |
+        [string] | [string, {
+            type?: "v8" | "istanbul" | "both";
+            [key: string]: any;
+        }];
+
+    export type AddedResults = {
+        id: string;
+        path: string;
+        type: "v8" | "istanbul";
+        data: any;
+    } | undefined;
+
+
+    export interface MetricsSummary {
+        covered: number;
+        uncovered?: number;
+        total: number;
+        pct: number | "";
+        status: "low" | "medium" | "high" | "unknown";
+        /** V8 lines only */
+        blank?: number;
+        /** V8 lines only */
+        comment?: number;
+    }
+
+    export interface CoverageSummary {
+        /** V8 only */
+        bytes?: MetricsSummary;
+        statements: MetricsSummary;
+        branches: MetricsSummary;
+        functions: MetricsSummary;
+        lines: MetricsSummary;
+    }
+
+    /** V8 only */
+    export interface CoverageRange {
+        start: number;
+        end: number;
+        count: number;
+        ignored?: boolean;
+        none?: boolean;
+    }
+
+    export interface IgnoredRange {
+        start: number;
+        end: number;
+        type: string;
+        n?: number;
+    }
+
+    export interface CoverageFile {
+        sourcePath: string;
+        summary: CoverageSummary;
+        /** V8 only */
+        url?: string;
+        /** V8 only */
+        id?: string;
+        /** V8 only */
+        type?: string;
+        /** V8 only */
+        source?: string;
+        /** V8 only */
+        distFile?: string;
+        /** V8 only */
+        js?: boolean;
+        /** V8 only */
+        data?: {
+            bytes: CoverageRange[];
+            statements: CoverageRange[];
+            branches: CoverageRange[];
+            functions: CoverageRange[];
+            ignores?: IgnoredRange[];
+            /** codecov json format */
+            lines: {
+                [key: string]: number | string
+            };
+        }
+    }
+
+    export type CoverageResults = {
+        type: "v8" | "istanbul";
+        reportPath: string;
+        name: string;
+        watermarks: Watermarks;
+        summary: CoverageSummary;
+        files: CoverageFile[];
+    } | undefined;
+
+    export interface CoverageReportOptions {
+
+        /** {string} logging levels: off, error, info, debug */
+        logging?: string;
+
+        /** {string} output dir */
+        outputDir?: string;
+
+        /** {string|string[]} input raw dir(s) */
+        inputDir?: string | string[];
+
+        /** 
+         * 
+         * {string} 'v8', 'v8,console-details'
+         * 
+         * {array} ['v8'], ['v8', ['console-details', { skipPercent: 80 }]]
+         * 
+         * By default, `v8` for V8 data, `html` for Istanbul data
+        */
+        reports?: string | ReportDescription[];
+
+        /** {string} Report name. Defaults to "Coverage Report". */
+        name?: string;
+
+        /** (V8 only) {string} Output [sub dir/]filename. Defaults to "index.html" */
+        outputFile?: string;
+        /** (V8 only) {boolean} Inline all scripts to the single HTML file. Defaults to false. */
+        inline?: boolean;
+        /** (V8 only) {string} Assets path if not inline. Defaults to "./assets" */
+        assetsPath?: string;
+
+        /** (V8 only) 
+         * 
+         * {string} `minimatch` pattern for entry url; {object} multiple patterns;
+         * 
+         * {function} A filter function for each entry file in the V8 list.
+         * */
+        entryFilter?: string | {
+            [pattern: string]: boolean;
+        } | ((entry: V8CoverageEntry) => boolean);
+
+        /** (V8 only) 
+         * 
+         * {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 | {
+            [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;
+
+        /** (Istanbul only) defaultSummarizer, sourceFinder  */
+
+        /** {boolean} Generate lcov.info file, same as lcovonly report. Defaults to false.  */
+        lcov?: boolean;
+
+        /** 
+         * {function} Source path handler. 
+         * 
+         * {object} Replace key with value.
+         * */
+        sourcePath?: ((filePath: string) => string) | {
+            [key: string]: string;
+        };
+
+        /** {string|function} Specify the report path, especially when there are multiple reports. Defaults to outputDir/index.html. */
+        reportPath?: string | (() => string);
+
+        /** {array} watermarks for low/medium/high. Defaults to [50, 80]
+        * {object} { bytes:[50,80], statements:[50,80], branches:[50,80], functions:[50,80], lines:[50,80] } */
+        watermarks?: Watermarks;
+
+        /** {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?: (coverageResults: CoverageResults) => Promise<void>;
+    }
+
+    export interface McrCliOptions extends CoverageReportOptions {
+        /** {function} onStart hook */
+        onStart?: (coverageReport: CoverageReport) => Promise<void>;
+    }
+
+    export class CoverageReport {
+
+        constructor(options?: CoverageReportOptions);
+
+        /** add coverage data: {array} V8 format, {object} Istanbul format */
+        add: (coverageData: any[] | any) => Promise<AddedResults>;
+
+        /** generate report */
+        generate: () => Promise<CoverageResults>;
+
+        /** check if cache exists */
+        hasCache: () => boolean;
+
+        /** clean previous cache, return `false` if no cache */
+        cleanCache: () => boolean;
+    }
+
+    export interface CoverageSnapshot {
+        type: "v8" | "istanbul";
+        summary: {
+            bytes?: string;
+            statements: string;
+            branches: string;
+            functions: string;
+            lines: string;
+        },
+        files: {
+            [sourcePath: string]: {
+                bytes?: string;
+                statements: string;
+                branches: string;
+                functions: string;
+                lines: string;
+                uncoveredLines: string;
+            }
+        }
+    }
+
+    /** get snapshot from coverage report data */
+    export function getSnapshot(coverageResults: CoverageResults): CoverageSnapshot;
+
+    /** diff two snapshots  */
+    export function diffSnapshot(oldData: CoverageSnapshot, newData: CoverageSnapshot, diffOptions: {
+        skipEqual?: boolean;
+        showSummary?: boolean;
+        maxCols?: number;
+        metrics?: Array<"bytes" | "statements" | "branches" | "functions" | "lines">;
+    }): {
+        change: boolean;
+        results: any[];
+        message: string;
+    };
+
+}
+
+/** create coverage report */
+declare function MCR(options?: MCR.CoverageReportOptions): MCR.CoverageReport;
+
+export = MCR;