monocart-coverage-reports 2.6.3 → 2.6.4

package/README.md

@@ -33,6 +33,7 @@
     - [Using `v8-to-istanbul`](#using-v8-to-istanbul)
     - [How Monocart Works](#how-monocart-works)
 * [Debug for Coverage and Sourcemap](#debug-for-coverage-and-sourcemap)
+* [Common issues](#common-issues)
 * [Integration](#integration)
     - [Playwright](#playwright)
     - [Jest](#jest)
@@ -282,10 +283,11 @@ Arguments:
 
 Options:
   -V, --version                output the version number
-  -c, --config <path>          custom config path
-  -o, --outputDir <dir>        output dir for reports
-  -r, --reports <name[,name]>  coverage reports to use
+  -c, --config <path>          custom config file path
+  --logging <logging>          off, error, info, debug
   -n, --name <name>            report name for title
+  -r, --reports <name[,name]>  coverage reports to use
+  -o, --outputDir <dir>        output dir for reports
   -i, --inputDir <dir>         input dir for merging raw files
   --entryFilter <pattern>      entry url filter
   --sourceFilter <pattern>     source path filter
@@ -293,24 +295,20 @@ Options:
   --inline                     inline html for v8 report
   --assetsPath <path>          assets path if not inline
   --lcov                       generate lcov.info file
-  --logging <logging>          off, error, info, debug
   -h, --help                   display help for command
 ```
 
-- Loading default configuration file
-    - `.mcrrc`
-    - `mcr.config.json`
-    - `mcr.config.mjs`
-    - `mcr.config.cjs`
+- Loading config file by priority:
+    - custom config file with `-c` or `--config`
     - `mcr.config.js`
-    - `mcr.config.ts`
-
-- Or loading custom configuration file with `-c` or `--config`
-```sh
-mcr node ./test.js -c path-to/my-custom-config.js
-```
+    - `mcr.config.cjs`
+    - `mcr.config.mjs`
+    - `mcr.config.json` - json format
+    - `.mcrrc.js`
+    - `.mcrrc` - json format
+    - `mcr.config.ts` - it requires `NODE_OPTIONS="--loader ts-node/esm"`
 
-- Work with `ts-node`, see [mcr-ts-node](https://github.com/cenfun/mcr-ts-node)
+- Working with `ts-node`, see [mcr-ts-node](https://github.com/cenfun/mcr-ts-node)
 
 ## Compare Reports
 | | Istanbul | V8 | V8 to Istanbul |
@@ -707,6 +705,28 @@ When `logging` is `debug`, the raw report data will be preserved in `[outputDir]
 
 ![](./assets/debug-sourcemap.png)
 
+## Common issues
+- `Unparsable source`
+
+It happens during the parsing of the source code into AST, if the source code is not in the standard ECMAScript. For example `ts`, `jsx` and so on. There is a option to fix it, which is to manually compile the source code for these files.
+```js
+import * as fs from "fs";
+import * as path from "path";
+import { fileURLToPath } from "url";
+import * as TsNode from 'ts-node';
+const coverageOptions = {
+    onEntry: async (entry) => {
+        const filePath = fileURLToPath(entry.url)
+        const originalSource = fs.readFileSync(filePath).toString("utf-8");
+        const fileName = path.basename(filePath);
+        const tn = TsNode.create({});
+        const source = tn.compile(originalSource, fileName);
+        entry.fake = false;
+        entry.source = source;
+    }
+}
+```
+
 ## Integration
 
 ### [Playwright](https://github.com/microsoft/playwright)

package/lib/cli.js

@@ -3,7 +3,7 @@
 const fs = require('fs');
 const path = require('path');
 const EC = require('eight-colors');
-const { fileURLToPath, pathToFileURL } = require('url');
+const { fileURLToPath } = require('url');
 
 const {
     foregroundChild,
@@ -12,86 +12,10 @@ const {
 
 const MCR = require('./index.js');
 const Util = require('./utils/util.js');
-const defaultOptions = require('./default/options.js');
 const { resolveSourceMap } = require('./converter/collect-source-maps.js');
 
 const version = require('../package.json').version;
 
-const resolveConfigPath = (customConfigPath) => {
-
-    const configList = [
-        '.mcrrc',
-        'mcr.config.json',
-        'mcr.config.mjs',
-        'mcr.config.cjs',
-        'mcr.config.js',
-        'mcr.config.ts'
-    ];
-
-    if (customConfigPath) {
-        configList.push(customConfigPath);
-    }
-
-    const existsList = configList.filter((p) => fs.existsSync(p));
-    if (!existsList.length) {
-        return;
-    }
-
-    // last one
-    const configPath = existsList.pop();
-    Util.logInfo(`Config: ${EC.cyan(configPath)}`);
-
-    return configPath;
-};
-
-const resolveConfigOptions = async (configPath) => {
-
-    // json format
-    const ext = path.extname(configPath);
-    if (ext === '.json' || configPath.slice(-2) === 'rc') {
-        return JSON.parse(Util.readFileSync(configPath));
-    }
-
-    let configOptions;
-    let err;
-    try {
-        configOptions = await import(pathToFileURL(configPath));
-    } catch (ee) {
-        err = ee;
-    }
-
-    if (err || !configOptions) {
-        Util.logError(`ERROR: failed to import "${configPath}": ${err && err.message} `);
-        return;
-    }
-
-    configOptions = configOptions.default || configOptions;
-
-    return configOptions;
-};
-
-const initOptions = async (cliOptions) => {
-
-    const configPath = resolveConfigPath(cliOptions.config);
-    if (configPath) {
-        const configOptions = await resolveConfigOptions(configPath);
-        if (configOptions) {
-            cliOptions = {
-                ... configOptions,
-                ... cliOptions
-            };
-        }
-    }
-
-    // report options
-    const options = {
-        ... defaultOptions,
-        ... cliOptions
-    };
-
-    return options;
-};
-
 const resolveEntrySource = (entry, sourceMapCache = {}) => {
     let source;
     const filePath = fileURLToPath(entry.url);
@@ -100,7 +24,7 @@ const resolveEntrySource = (entry, sourceMapCache = {}) => {
         source = fs.readFileSync(filePath).toString('utf8');
     }
 
-    // not for typescript
+    // not for typescript, but it could be jsx even it is `.js`
     if (source && !['.ts', '.tsx'].includes(extname)) {
         entry.source = source;
         return;
@@ -111,7 +35,6 @@ const resolveEntrySource = (entry, sourceMapCache = {}) => {
 
     // for fake source file (can not parse to AST)
     if (lineLengths) {
-        // get runtime code with ts-node
         let fakeSource = '';
         sourcemapData.lineLengths.forEach((length) => {
             fakeSource += `${''.padEnd(length, '*')}\n`;
@@ -188,25 +111,25 @@ const addCoverageData = async (coverageReport, nodeV8CoverageDir) => {
 
 const executeCommand = async (command, cliOptions) => {
 
-    const options = await initOptions(cliOptions);
-
     Util.logInfo(`Execute: ${EC.cyan(command)}`);
+
     // console.log(options);
+    const coverageReport = MCR(cliOptions);
+    await coverageReport.loadConfig(cliOptions.config);
+    coverageReport.cleanCache();
 
-    const nodeV8CoverageDir = path.resolve(options.outputDir, '.v8-coverage');
-    process.env.NODE_V8_COVERAGE = nodeV8CoverageDir;
+    const coverageOptions = coverageReport.options;
 
+    // dir for node v8 coverage
+    const nodeV8CoverageDir = Util.relativePath(path.resolve(coverageOptions.outputDir, '.v8-coverage'));
+    process.env.NODE_V8_COVERAGE = nodeV8CoverageDir;
     // clean v8 cache before running
     Util.rmSync(nodeV8CoverageDir);
-
-    // console.log('nodeV8CoverageDir', nodeV8CoverageDir);
-
-    const coverageReport = MCR(options);
-    coverageReport.cleanCache();
+    // Util.logInfo(`V8 coverage dir: ${EC.cyan(nodeV8CoverageDir)}`);
 
     // =========================================
     // onStart hook
-    const onStart = options.onStart;
+    const onStart = coverageOptions.onStart;
     if (typeof onStart === 'function') {
         await onStart(coverageReport);
     }
@@ -214,17 +137,19 @@ const executeCommand = async (command, cliOptions) => {
 
     const subprocess = foregroundChild(command, {
         shell: true
-    }, async () => {
+    }, async (code, signal) => {
+
+        // generate coverage even it is failed. code != 0
 
         if (!fs.existsSync(nodeV8CoverageDir)) {
-            EC.logRed(`Not found coverage data: ${Util.relativePath(nodeV8CoverageDir)}`);
+            EC.logRed(`Not found V8 coverage dir: ${Util.relativePath(nodeV8CoverageDir)}`);
             return 1;
         }
 
         // =========================================
         // onReady hook before adding coverage data.
         // Sometimes, the child process has not yet finished writing the coverage data, and it needs to wait here.
-        const onReady = options.onReady;
+        const onReady = coverageOptions.onReady;
         if (typeof onReady === 'function') {
             await onReady(coverageReport, nodeV8CoverageDir, subprocess);
         }
@@ -243,16 +168,23 @@ const executeCommand = async (command, cliOptions) => {
 
 };
 
+process.on('uncaughtException', function(err) {
+    Util.logError(`ERROR: ${err.message || err}`);
+});
+
 program
     .name('mcr')
     .description('CLI to generate coverage reports')
     .version(version)
     .argument('<command>', 'command to execute')
     .allowUnknownOption()
-    .option('-c, --config <path>', 'custom config path')
-    .option('-o, --outputDir <dir>', 'output dir for reports')
-    .option('-r, --reports <name[,name]>', 'coverage reports to use')
+    .option('-c, --config <path>', 'custom config file path')
+    .option('--logging <logging>', 'off, error, info, debug')
+
     .option('-n, --name <name>', 'report name for title')
+    .option('-r, --reports <name[,name]>', 'coverage reports to use')
+
+    .option('-o, --outputDir <dir>', 'output dir for reports')
     .option('-i, --inputDir <dir>', 'input dir for merging raw files')
 
     .option('--entryFilter <pattern>', 'entry url filter')
@@ -264,8 +196,6 @@ program
 
     .option('--lcov', 'generate lcov.info file')
 
-    .option('--logging <logging>', 'off, error, info, debug')
-
     .action((_command, cliOptions) => {
         const command = program.args.join(' ');
         executeCommand(command, cliOptions);

package/lib/converter/ast.js

@@ -188,7 +188,9 @@ const getJsAstInfo = (item, coverageList) => {
         }
 
         // runtime code should be parsed successful
-        Util.logInfo(`failed to parse source file: ${item.sourcePath} ${err.message}`);
+        Util.logInfo(`Unparsable source: ${item.sourcePath} ${err.message}`);
+
+        // it could be jsx even it is `.js`
 
         // https://github.com/acornjs/acorn/tree/master/acorn-loose
         // It is recommended to always try a parse with the regular acorn parser first,

package/lib/default/options.js

@@ -3,11 +3,8 @@ module.exports = {
     // {string} logging levels: off, error, info, debug
     logging: 'info',
 
-    // {string} output dir
-    outputDir: './coverage-reports',
-
-    // {string|string[]} input raw dir(s)
-    inputDir: null,
+    // {string} Report name. Defaults to "Coverage Report".
+    name: 'Coverage Report',
 
     // {string} v8 or html for istanbul by default
     // {array} multiple reports with options
@@ -21,17 +18,11 @@ module.exports = {
     // ],
     reports: '',
 
-    // {string} Report name. Defaults to "Coverage Report".
-    name: 'Coverage Report',
-
-    // (V8 only) {string} Output [sub dir/]filename. Defaults to "index.html"
-    outputFile: 'index.html',
-
-    // (V8 only) {boolean} Inline all scripts to the single HTML file. Defaults to false.
-    inline: false,
+    // {string} output dir
+    outputDir: './coverage-reports',
 
-    // (V8 only) {string} Assets path if not inline. Defaults to "./assets"
-    assetsPath: './assets',
+    // {string|string[]} input raw dir(s)
+    inputDir: null,
 
     // (V8 only) {function} A filter function to execute for each element in the V8 list.
     // entryFilter: (entry) => {
@@ -46,6 +37,24 @@ module.exports = {
     // sourceFilter: (sourcePath) => sourcePath.search(/src\/.+/) !== -1,
     sourceFilter: null,
 
+    // {function} Source path handler.
+    // sourcePath: (filePath) => `wwwroot/${filePath}`,
+    sourcePath: null,
+
+    // (V8 only) {string} Output [sub dir/]filename. Defaults to "index.html"
+    outputFile: 'index.html',
+
+    // (V8 only) {boolean} Inline all scripts to the single HTML file. Defaults to false.
+    inline: false,
+
+    // (V8 only) {string} Assets path if not inline. Defaults to "./assets"
+    assetsPath: './assets',
+
+    // (Istanbul only) defaultSummarizer, sourceFinder
+
+    // {boolean} Generate lcov.info file, same as lcovonly report. Defaults to false.
+    lcov: false,
+
     // options for adding empty coverage for all files
     // all: {
     //     dir: ['src'],
@@ -56,15 +65,6 @@ module.exports = {
     // (V8 only) {boolean} Enable/Disable ignoring uncovered codes with the special comments: v8 ignore next/next N/start/stop
     v8Ignore: true,
 
-    // (Istanbul only) defaultSummarizer, sourceFinder
-
-    // {boolean} Generate lcov.info file, same as lcovonly report. Defaults to false.
-    lcov: false,
-
-    // {function} Source path handler.
-    // sourcePath: (filePath) => `wwwroot/${filePath}`,
-    sourcePath: null,
-
     // {string|function} Specify the report path, especially when there are multiple reports. Defaults to outputDir/index.html.
     reportPath: null,
 
@@ -78,6 +78,10 @@ module.exports = {
     // {boolean} Indicates whether to clean previous cache in output dir before generating report. Defaults to false.
     cleanCache: false,
 
+    // {function} onEntry hook
+    // onEntry: async (entry) => {}
+    onEntry: null,
+
     // {function} onEnd hook
     // onEnd: async (reportData) => {}
     onEnd: null

package/lib/generate.js

@@ -288,12 +288,15 @@ const handleConsoleDetailsReport = (reportData, reportOptions, options) => {
     } = reportData;
 
     if (name) {
-        EC.logCyan(name);
+        Util.logInfo(EC.cyan(name));
     }
 
     const metrics = Util.getMetrics(cdOptions.metrics, type);
     const rows = getDetailsRows(files, metrics, cdOptions);
     const summaryRow = getRowData('Summary', summary, metrics);
+    if (summaryRow.nameStatus) {
+        summaryRow.name = Util.getColorStrByStatus(summaryRow.name, summaryRow.nameStatus);
+    }
     // no rows if skipped all by skipPercent
     if (rows.length) {
         rows.push({
@@ -339,7 +342,7 @@ const handleConsoleSummaryReport = (reportData, reportOptions, options) => {
     } = reportData;
 
     if (name) {
-        EC.logCyan(name);
+        Util.logInfo(EC.cyan(name));
     }
 
     const metrics = Util.getMetrics(csOptions.metrics, type);

package/lib/index.d.ts

@@ -185,10 +185,10 @@ declare namespace MCR {
         js?: boolean;
         /** V8 only */
         data?: {
-            bytes: CoverageRange[];
-            statements: CoverageRange[];
-            branches: CoverageRange[];
-            functions: CoverageRange[];
+            bytes?: CoverageRange[];
+            statements?: CoverageRange[];
+            branches?: CoverageRange[];
+            functions?: CoverageRange[];
             ignores?: IgnoredRange[];
             /** codecov json format */
             lines: {
@@ -211,11 +211,8 @@ declare namespace MCR {
         /** {string} logging levels: off, error, info, debug */
         logging?: string;
 
-        /** {string} output dir */
-        outputDir?: string;
-
-        /** {string|string[]} input raw dir(s) */
-        inputDir?: string | string[];
+        /** {string} Report name. Defaults to "Coverage Report". */
+        name?: string;
 
         /** 
          * 
@@ -224,25 +221,21 @@ declare namespace MCR {
          * {array} ['v8'], ['v8', ['console-details', { skipPercent: 80 }]]
          * 
          * By default, `v8` for V8 data, `html` for Istanbul data
-        */
-        reports?: string | ReportDescription[];
+         */
+        reports?: string | string[] | ReportDescription[];
 
-        /** {string} Report name. Defaults to "Coverage Report". */
-        name?: string;
+        /** {string} output dir */
+        outputDir?: 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;
+        /** {string|string[]} input raw dir(s) */
+        inputDir?: string | 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);
@@ -252,11 +245,33 @@ declare namespace MCR {
          * {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);
 
+        /** 
+         * {function} Source path handler. 
+         * 
+         * {object} Replace key with value.
+         * */
+        sourcePath?: ((filePath: string) => string) | {
+            [key: string]: 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;
+
+        /** (Istanbul only) defaultSummarizer, sourceFinder  */
+
+        /** {boolean} Generate lcov.info file, same as lcovonly report. Defaults to false.  */
+        lcov?: boolean;
+
         /**
          * options for adding empty coverage for all files
          */
@@ -278,20 +293,6 @@ declare namespace MCR {
         /** (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);
 
@@ -299,11 +300,15 @@ declare namespace MCR {
         * {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. */
+        /** 
+         * {boolean} Indicates whether to clean previous reports in output dir before generating new reports. Defaults to true. 
+         * 
+         * If true, the API `clean()` will execute automatically.
+         * */
         clean?: boolean;
 
         /**
-         * {boolean} Indicates whether to clean previous cache in output dir before generating report. Defaults to false. 
+         * {boolean} Indicates whether to clean previous cache in output dir on start. Defaults to false. 
          * 
          * If true, the API `cleanCache()` will execute automatically.
         */
@@ -319,10 +324,10 @@ declare namespace MCR {
 
     export interface McrCliOptions extends CoverageReportOptions {
 
-        /** (cli only) {function} onStart hook */
+        /** (CLI only) {function} onStart hook */
         onStart?: (coverageReport: CoverageReport) => Promise<void>;
 
-        /** (cli only) {function} onReady hook before adding coverage data.
+        /** (CLI only) {function} onReady hook before adding coverage data.
          * 
          * Sometimes, the child process has not yet finished writing the coverage data, and it needs to wait here.
         */
@@ -332,9 +337,14 @@ declare namespace MCR {
 
     export class CoverageReport {
 
+        /**
+         * @param options coverage report options
+         */
         constructor(options?: CoverageReportOptions);
 
-        /** add coverage data: {array} V8 format, {object} Istanbul format */
+        /** add coverage data
+         * 
+         * @param coverageData {array} V8 format, {object} Istanbul format */
         add: (coverageData: any[] | any) => Promise<AddedResults>;
 
         /** generate report */
@@ -345,6 +355,27 @@ declare namespace MCR {
 
         /** clean previous cache, return `false` if no cache */
         cleanCache: () => boolean;
+
+        /** clean previous reports except cache dir and v8 coverage dir */
+        clean: () => void;
+
+        /** get entry filter handler, it can be used to filter the coverage data list before adding it. */
+        getEntryFilter: () => ((entry: V8CoverageEntry) => boolean);
+
+        /** load config file. 
+         * 
+         * @param configFile custom config file path
+         * 
+         * Supports loading default config file if no custom config specified: 
+            'mcr.config.js',
+            'mcr.config.cjs',
+            'mcr.config.mjs',
+            'mcr.config.json',
+            '.mcrrc.js',
+            '.mcrrc',
+            'mcr.config.ts'
+         */
+        loadConfig: (configFile?: string) => Promise<void>;
     }
 
     export interface CoverageSnapshot {