c8 7.5.0 → 7.7.2

package/CHANGELOG.md

@@ -2,6 +2,34 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [7.7.2](https://www.github.com/bcoe/c8/compare/v7.7.1...v7.7.2) (2021-05-02)
+
+
+### Bug Fixes
+
+* address bugs with source remapping on Windows ([#301](https://www.github.com/bcoe/c8/issues/301)) ([c817902](https://www.github.com/bcoe/c8/commit/c81790262f843c01b3d14390fde81dbdbcf2226f))
+
+### [7.7.1](https://www.github.com/bcoe/c8/compare/v7.7.0...v7.7.1) (2021-04-07)
+
+
+### Bug Fixes
+
+* **types:** add excludeAfterRemap and allowExternal  ([#297](https://www.github.com/bcoe/c8/issues/297)) ([e32a53f](https://www.github.com/bcoe/c8/commit/e32a53ff050b5faf740da4e9c3fb08e70e29d60d))
+
+## [7.7.0](https://www.github.com/bcoe/c8/compare/v7.6.0...v7.7.0) (2021-03-30)
+
+
+### Features
+
+* introduce --exclude-after-remap flag ([#293](https://www.github.com/bcoe/c8/issues/293)) ([53c4234](https://www.github.com/bcoe/c8/commit/53c42347e0ed4eb29e37b84d40768eed89bf9eb0)), closes [#224](https://www.github.com/bcoe/c8/issues/224)
+
+## [7.6.0](https://www.github.com/bcoe/c8/compare/v7.5.0...v7.6.0) (2021-02-17)
+
+
+### Features
+
+* add --skip-full ([#287](https://www.github.com/bcoe/c8/issues/287)) ([8b01b63](https://www.github.com/bcoe/c8/commit/8b01b63740d7af75fe83d0164c0f18021592e1a6))
+
 ## [7.5.0](https://www.github.com/bcoe/c8/compare/v7.4.0...v7.5.0) (2021-02-01)
 
 

package/index.d.ts

@@ -2,8 +2,9 @@ export type Watermark = [number, number];
 
 export declare class Report {
     constructor(opts: {
-        exclude?: any[],
-        include?: any[],
+        exclude?: string | string[],
+        excludeAfterRemap?: boolean,
+        include?: string | string[],
         reporter: string[],
         reportsDirectory?: string,
         tempDirectory?: string,
@@ -18,7 +19,7 @@ export declare class Report {
         resolve?: string,
         all?: boolean,
         src?: Array<string>,
-        allowExternal: boolean
+        allowExternal?: boolean
     })
     run(): Promise<void>;
 }

package/lib/commands/report.js

@@ -13,6 +13,7 @@ exports.outputReport = async function (argv) {
   const report = Report({
     include: argv.include,
     exclude: argv.exclude,
+    excludeAfterRemap: argv.excludeAfterRemap,
     reporter: Array.isArray(argv.reporter) ? argv.reporter : [argv.reporter],
     reportsDirectory: argv['reports-dir'],
     tempDirectory: argv.tempDirectory,
@@ -22,7 +23,8 @@ exports.outputReport = async function (argv) {
     wrapperLength: argv.wrapperLength,
     all: argv.all,
     allowExternal: argv.allowExternal,
-    src: argv.src
+    src: argv.src,
+    skipFull: argv.skipFull
   })
   await report.run()
   if (argv.checkCoverage) await checkCoverages(argv, report)

package/lib/parse-args.js

@@ -26,6 +26,12 @@ function buildYargs (withCommands = false) {
       default: defaultExclude,
       describe: 'a list of specific files and directories that should be excluded from coverage (glob patterns are supported)'
     })
+    .option('exclude-after-remap', {
+      alias: 'a',
+      type: 'boolean',
+      default: false,
+      describe: 'apply exclude logic to files after they are remapped by a source-map'
+    })
     .option('include', {
       alias: 'n',
       default: [],
@@ -101,6 +107,11 @@ function buildYargs (withCommands = false) {
       describe: 'supplying --src will override cwd as the default location where --all looks for src files. --src can be ' +
         'supplied multiple times and each directory will be included. This allows for workspaces spanning multiple projects'
     })
+    .options('skip-full', {
+      default: false,
+      type: 'boolean',
+      describe: 'do not show files with 100% statement, branch, and function coverage'
+    })
     .pkgConf('c8')
     .config(config)
     .demandCommand(1)

package/lib/report.js

@@ -1,10 +1,10 @@
 const Exclude = require('test-exclude')
-const furi = require('furi')
 const libCoverage = require('istanbul-lib-coverage')
 const libReport = require('istanbul-lib-report')
 const reports = require('istanbul-reports')
 const { readdirSync, readFileSync, statSync } = require('fs')
 const { isAbsolute, resolve, extname } = require('path')
+const { pathToFileURL, fileURLToPath } = require('url')
 const getSourceMapFromFile = require('./source-map-from-file')
 // TODO: switch back to @c88/v8-coverage once patch is landed.
 const v8toIstanbul = require('v8-to-istanbul')
@@ -15,6 +15,7 @@ const debuglog = util.debuglog('c8')
 class Report {
   constructor ({
     exclude,
+    excludeAfterRemap,
     include,
     reporter,
     reportsDirectory,
@@ -25,7 +26,8 @@ class Report {
     resolve: resolvePaths,
     all,
     src,
-    allowExternal = false
+    allowExternal = false,
+    skipFull
   }) {
     this.reporter = reporter
     this.reportsDirectory = reportsDirectory
@@ -37,11 +39,13 @@ class Report {
       include: include,
       relativePath: !allowExternal
     })
+    this.excludeAfterRemap = excludeAfterRemap
     this.omitRelative = omitRelative
     this.sourceMapCache = {}
     this.wrapperLength = wrapperLength
     this.all = all
     this.src = this._getSrc(src)
+    this.skipFull = skipFull
   }
 
   _getSrc (src) {
@@ -61,13 +65,13 @@ class Report {
       coverageMap: await this.getCoverageMapFromAllCoverageFiles()
     })
 
-    this.reporter.forEach(function (_reporter) {
+    for (const _reporter of this.reporter) {
       reports.create(_reporter, {
         skipEmpty: false,
-        skipFull: false,
+        skipFull: this.skipFull,
         maxCols: 100
       }).execute(context)
-    })
+    }
   }
 
   async getCoverageMapFromAllCoverageFiles () {
@@ -86,7 +90,11 @@ class Report {
       try {
         const sources = this._getSourceMap(v8ScriptCov)
         const path = resolve(this.resolve, v8ScriptCov.url)
-        const converter = v8toIstanbul(path, this.wrapperLength, sources)
+        const converter = v8toIstanbul(path, this.wrapperLength, sources, (path) => {
+          if (this.excludeAfterRemap) {
+            return !this.exclude.shouldInstrument(path)
+          }
+        })
         await converter.load()
 
         if (resultCountPerPath.has(path)) {
@@ -131,8 +139,8 @@ class Report {
    */
   _getSourceMap (v8ScriptCov) {
     const sources = {}
-    if (this.sourceMapCache[`file://${v8ScriptCov.url}`]) {
-      const sourceMapAndLineLengths = this.sourceMapCache[`file://${v8ScriptCov.url}`]
+    const sourceMapAndLineLengths = this.sourceMapCache[pathToFileURL(v8ScriptCov.url).href]
+    if (sourceMapAndLineLengths) {
       // See: https://github.com/nodejs/node/pull/34305
       if (!sourceMapAndLineLengths.data) return
       sources.sourceMap = {
@@ -165,7 +173,7 @@ class Report {
     for (const v8ProcessCov of this._loadReports()) {
       if (this._isCoverageObject(v8ProcessCov)) {
         if (v8ProcessCov['source-map-cache']) {
-          Object.assign(this.sourceMapCache, v8ProcessCov['source-map-cache'])
+          Object.assign(this.sourceMapCache, this._normalizeSourceMapCache(v8ProcessCov['source-map-cache']))
         }
         v8ProcessCovs.push(this._normalizeProcessCov(v8ProcessCov, fileIndex))
       }
@@ -186,7 +194,7 @@ class Report {
               const stat = statSync(fullPath)
               const sourceMap = getSourceMapFromFile(fullPath)
               if (sourceMap) {
-                this.sourceMapCache[`file://${fullPath}`] = { data: sourceMap }
+                this.sourceMapCache[pathToFileURL(fullPath)] = { data: sourceMap }
               }
               emptyReports.push({
                 scriptId: 0,
@@ -267,20 +275,38 @@ class Report {
       }
       if (/^file:\/\//.test(v8ScriptCov.url)) {
         try {
-          v8ScriptCov.url = furi.toSysPath(v8ScriptCov.url)
+          v8ScriptCov.url = fileURLToPath(v8ScriptCov.url)
           fileIndex.add(v8ScriptCov.url)
         } catch (err) {
           debuglog(`${err.stack}`)
           continue
         }
       }
-      if (this.exclude.shouldInstrument(v8ScriptCov.url) &&
-        (!this.omitRelative || isAbsolute(v8ScriptCov.url))) {
-        result.push(v8ScriptCov)
+      if ((!this.omitRelative || isAbsolute(v8ScriptCov.url))) {
+        if (this.excludeAfterRemap || this.exclude.shouldInstrument(v8ScriptCov.url)) {
+          result.push(v8ScriptCov)
+        }
       }
     }
     return { result }
   }
+
+  /**
+   * Normalizes a V8 source map cache.
+   *
+   * This function normalizes file URLs to a system-independent format.
+   *
+   * @param v8SourceMapCache V8 source map cache to normalize.
+   * @return {v8SourceMapCache} Normalized V8 source map cache.
+   * @private
+   */
+  _normalizeSourceMapCache (v8SourceMapCache) {
+    const cache = {}
+    for (const fileURL of Object.keys(v8SourceMapCache)) {
+      cache[pathToFileURL(fileURLToPath(fileURL)).href] = v8SourceMapCache[fileURL]
+    }
+    return cache
+  }
 }
 
 module.exports = function (opts) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c8",
-  "version": "7.5.0",
+  "version": "7.7.2",
   "description": "output coverage reports using Node.js' built in coverage",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -37,15 +37,14 @@
     "@istanbuljs/schema": "^0.1.2",
     "find-up": "^5.0.0",
     "foreground-child": "^2.0.0",
-    "furi": "^2.0.0",
     "istanbul-lib-coverage": "^3.0.0",
     "istanbul-lib-report": "^3.0.0",
     "istanbul-reports": "^3.0.2",
     "rimraf": "^3.0.0",
     "test-exclude": "^6.0.0",
     "v8-to-istanbul": "^7.1.0",
-    "yargs": "^16.0.0",
-    "yargs-parser": "^20.0.0"
+    "yargs": "^16.2.0",
+    "yargs-parser": "^20.2.7"
   },
   "devDependencies": {
     "chai": "^4.2.0",