c8 7.3.4 → 7.5.0

package/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 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.5.0](https://www.github.com/bcoe/c8/compare/v7.4.0...v7.5.0) (2021-02-01)
+
+
+### Features
+
+* **all:** handle base64 inline source maps ([#283](https://www.github.com/bcoe/c8/issues/283)) ([3f12dd4](https://www.github.com/bcoe/c8/commit/3f12dd4cd4b903b396c60c9c6d76cdf990ec6cbe))
+
+## [7.4.0](https://www.github.com/bcoe/c8/compare/v7.3.5...v7.4.0) (2020-12-31)
+
+
+### Features
+
+* support ignore start/stop comment ([#273](https://www.github.com/bcoe/c8/issues/273)) ([90949fa](https://www.github.com/bcoe/c8/commit/90949fa2deac7fccb9fc4b83ecca70f4de025ae9)), closes [#271](https://www.github.com/bcoe/c8/issues/271)
+* use debuglog rather than console.warn ([#279](https://www.github.com/bcoe/c8/issues/279)) ([7c04a4d](https://www.github.com/bcoe/c8/commit/7c04a4dc47ee9496d89fcae9062da24a6f642f39))
+
+### [7.3.5](https://www.github.com/bcoe/c8/compare/v7.3.4...v7.3.5) (2020-10-25)
+
+
+### Bug Fixes
+
+* **v8-to-istanbul:** fixes shebang handling/ignore behavior ([#267](https://www.github.com/bcoe/c8/issues/267)) ([21cd41f](https://www.github.com/bcoe/c8/commit/21cd41f5ed2b7b3ef81bbad2ae57b531934915cc))
+
 ### [7.3.4](https://www.github.com/bcoe/c8/compare/v7.3.3...v7.3.4) (2020-10-15)
 
 

package/README.md

@@ -64,7 +64,7 @@ To ignore lines, blocks, and functions, use the special comment:
 
 `/* c8 ignore next */`.
 
-### Ignoring the next element
+### Ignoring the next line
 
 ```js
 const myVariable = 99
@@ -72,7 +72,7 @@ const myVariable = 99
 if (process.platform === 'win32') console.info('hello world')
 ```
 
-### Ignoring the next N elements
+### Ignoring the next N lines
 
 ```js
 const myVariable = 99
@@ -82,6 +82,16 @@ if (process.platform === 'win32') {
 }
 ```
 
+### Ignoring all lines until told
+
+```js
+/* c8 ignore start */
+function dontMindMe() {
+  // ...
+}
+/* c8 ignore stop */
+```
+
 ### Ignoring a block on the current line
 
 ```js

package/lib/parse-args.js

@@ -126,7 +126,7 @@ function buildYargs (withCommands = false) {
 }
 
 function hideInstrumenterArgs (yargv) {
-  var argv = process.argv.slice(1)
+  let argv = process.argv.slice(1)
   argv = argv.slice(argv.indexOf(yargv._[0]))
   if (argv[0][0] === '-') {
     argv.unshift(process.execPath)

package/lib/report.js

@@ -9,6 +9,8 @@ const getSourceMapFromFile = require('./source-map-from-file')
 // TODO: switch back to @c88/v8-coverage once patch is landed.
 const v8toIstanbul = require('v8-to-istanbul')
 const isCjsEsmBridgeCov = require('./is-cjs-esm-bridge')
+const util = require('util')
+const debuglog = util.debuglog('c8')
 
 class Report {
   constructor ({
@@ -53,7 +55,7 @@ class Report {
   }
 
   async run () {
-    var context = libReport.createContext({
+    const context = libReport.createContext({
       dir: this.reportsDirectory,
       watermarks: this.watermarks,
       coverageMap: await this.getCoverageMapFromAllCoverageFiles()
@@ -103,7 +105,7 @@ class Report {
           map.merge(converter.toIstanbul())
         }
       } catch (err) {
-        console.warn(`file: ${v8ScriptCov.url} error: ${err.stack}`)
+        debuglog(`file: ${v8ScriptCov.url} error: ${err.stack}`)
       }
     }
 
@@ -183,8 +185,8 @@ class Report {
             if (ext === '.js' || ext === '.ts' || ext === '.mjs') {
               const stat = statSync(fullPath)
               const sourceMap = getSourceMapFromFile(fullPath)
-              if (sourceMap !== undefined) {
-                this.sourceMapCache[`file://${fullPath}`] = { data: JSON.parse(readFileSync(sourceMap).toString()) }
+              if (sourceMap) {
+                this.sourceMapCache[`file://${fullPath}`] = { data: sourceMap }
               }
               emptyReports.push({
                 scriptId: 0,
@@ -225,18 +227,18 @@ class Report {
    * @private
    */
   _loadReports () {
-    const files = readdirSync(this.tempDirectory)
-
-    return files.map((f) => {
+    const reports = []
+    for (const file of readdirSync(this.tempDirectory)) {
       try {
-        return JSON.parse(readFileSync(
-          resolve(this.tempDirectory, f),
+        reports.push(JSON.parse(readFileSync(
+          resolve(this.tempDirectory, file),
           'utf8'
-        ))
+        )))
       } catch (err) {
-        console.warn(`${err.stack}`)
+        debuglog(`${err.stack}`)
       }
-    })
+    }
+    return reports
   }
 
   /**
@@ -268,7 +270,7 @@ class Report {
           v8ScriptCov.url = furi.toSysPath(v8ScriptCov.url)
           fileIndex.add(v8ScriptCov.url)
         } catch (err) {
-          console.warn(err)
+          debuglog(`${err.stack}`)
           continue
         }
       }

package/lib/source-map-from-file.js

@@ -1,5 +1,34 @@
-const { isAbsolute, join, dirname } = require('path')
+/*
+* Copyright Node.js contributors. All rights reserved.
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to
+* deal in the Software without restriction, including without limitation the
+* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+* sell copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in
+* all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+* IN THE SOFTWARE.
+*/
+// TODO(bcoe): this logic is ported from Node.js' internal source map
+// helpers:
+// https://github.com/nodejs/node/blob/master/lib/internal/source_map/source_map_cache.js
+// we should to upstream and downstream fixes.
+
 const { readFileSync } = require('fs')
+const { fileURLToPath, pathToFileURL } = require('url')
+const util = require('util')
+const debuglog = util.debuglog('c8')
+
 /**
  * Extract the sourcemap url from a source file
  * reference: https://sourcemaps.info/spec.html
@@ -7,18 +36,64 @@ const { readFileSync } = require('fs')
  * @returns {String} full path to source map file
  * @private
  */
-function getSourceMapFromFile (file) {
-  const fileBody = readFileSync(file).toString()
-  const sourceMapLineRE = /\/\/[#@] ?sourceMappingURL=([^\s'"]+)\s*$/mg
+function getSourceMapFromFile (filename) {
+  const fileBody = readFileSync(filename).toString()
+  const sourceMapLineRE = /\/[*/]#\s+sourceMappingURL=(?<sourceMappingURL>[^\s]+)/
   const results = fileBody.match(sourceMapLineRE)
   if (results !== null) {
-    const sourceMap = results[results.length - 1].split('=')[1]
-    if (isAbsolute(sourceMap)) {
-      return sourceMap.trim()
-    } else {
-      const base = dirname(file)
-      return join(base, sourceMap).trim()
+    const sourceMappingURL = results.groups.sourceMappingURL
+    const sourceMap = dataFromUrl(pathToFileURL(filename), sourceMappingURL)
+    return sourceMap
+  } else {
+    return null
+  }
+}
+
+function dataFromUrl (sourceURL, sourceMappingURL) {
+  try {
+    const url = new URL(sourceMappingURL)
+    switch (url.protocol) {
+      case 'data:':
+        return sourceMapFromDataUrl(url.pathname)
+      default:
+        return null
+    }
+  } catch (err) {
+    debuglog(err)
+    // If no scheme is present, we assume we are dealing with a file path.
+    const mapURL = new URL(sourceMappingURL, sourceURL).href
+    return sourceMapFromFile(mapURL)
+  }
+}
+
+function sourceMapFromFile (mapURL) {
+  try {
+    const content = readFileSync(fileURLToPath(mapURL), 'utf8')
+    return JSON.parse(content)
+  } catch (err) {
+    debuglog(err)
+    return null
+  }
+}
+
+// data:[<mediatype>][;base64],<data> see:
+// https://tools.ietf.org/html/rfc2397#section-2
+function sourceMapFromDataUrl (url) {
+  const { 0: format, 1: data } = url.split(',')
+  const splitFormat = format.split(';')
+  const contentType = splitFormat[0]
+  const base64 = splitFormat[splitFormat.length - 1] === 'base64'
+  if (contentType === 'application/json') {
+    const decodedData = base64 ? Buffer.from(data, 'base64').toString('utf8') : data
+    try {
+      return JSON.parse(decodedData)
+    } catch (err) {
+      debuglog(err)
+      return null
     }
+  } else {
+    debuglog(`unexpected content-type ${contentType}`)
+    return null
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c8",
-  "version": "7.3.4",
+  "version": "7.5.0",
   "description": "output coverage reports using Node.js' built in coverage",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -43,7 +43,7 @@
     "istanbul-reports": "^3.0.2",
     "rimraf": "^3.0.0",
     "test-exclude": "^6.0.0",
-    "v8-to-istanbul": "^6.0.1",
+    "v8-to-istanbul": "^7.1.0",
     "yargs": "^16.0.0",
     "yargs-parser": "^20.0.0"
   },
@@ -51,7 +51,7 @@
     "chai": "^4.2.0",
     "chai-jest-snapshot": "^2.0.0",
     "mocha": "^8.1.3",
-    "standard": "^14.1.0",
+    "standard": "^16.0.3",
     "ts-node": "^9.0.0",
     "typescript": "^4.0.0"
   },