Implement --all functionality

Implements an `--all` flag for a src directory to consider
for coverage. If supplied, c8 will glob the directory respecting the
`--include` and `--exclude` parameters for src files. All source files
will be included in the final report. If a file is not found in the
v8 coverage output, it will be initialized with an empty v8 record and
reported as 0 lines/branches/functions covered.

Note: This uses the empty v8 approach instead of the empty report approach

Fix html report

--all should be boolean

Update snapshot

fix async function

WIP - changing --all a bit to create a fake v8 coverage entry and additional args changes

WIP - read source maps for faked entries

WIP

WIP

Moved approach to empty v8 blocks

Author: j03m

.gitignore

@@ -3,3 +3,4 @@ node_modules
 .nyc_output
 coverage
 tmp
+.idea

lib/commands/report.js

@@ -19,7 +19,8 @@ exports.outputReport = async function (argv) {
     watermarks: argv.watermarks,
     resolve: argv.resolve,
     omitRelative: argv.omitRelative,
-    wrapperLength: argv.wrapperLength
+    wrapperLength: argv.wrapperLength,
+    all: argv.all
   })
   await report.run()
   if (argv.checkCoverage) checkCoverages(argv, report)

lib/parse-args.js

@@ -83,6 +83,12 @@ function buildYargs (withCommands = false) {
       type: 'boolean',
       describe: 'should temp files be deleted before script execution'
     })
+    .options('all', {
+      default: false,
+      type: 'boolean',
+      describe: 'supplying --all will cause c8 to consider all src files in the current working directory ' +
+        'when the determining coverage. Respects include/exclude.'
+    })
     .pkgConf('c8')
     .config(config)
     .demandCommand(1)

lib/report.js

@@ -3,8 +3,8 @@ const furi = require('furi')
 const libCoverage = require('istanbul-lib-coverage')
 const libReport = require('istanbul-lib-report')
 const reports = require('istanbul-reports')
-const { readdirSync, readFileSync } = require('fs')
-const { isAbsolute, resolve } = require('path')
+const { readdirSync, readFileSync, statSync } = require('fs')
+const { isAbsolute, resolve, join, relative, extname, dirname } = require('path')
 // TODO: switch back to @c88/v8-coverage once patch is landed.
 const { mergeProcessCovs } = require('@bcoe/v8-coverage')
 const v8toIstanbul = require('v8-to-istanbul')
@@ -20,7 +20,8 @@ class Report {
     watermarks,
     omitRelative,
     wrapperLength,
-    resolve: resolvePaths
+    resolve: resolvePaths,
+    all
   }) {
     this.reporter = reporter
     this.reportsDirectory = reportsDirectory
@@ -34,6 +35,8 @@ class Report {
     this.omitRelative = omitRelative
     this.sourceMapCache = {}
     this.wrapperLength = wrapperLength
+    this.all = all
+    this.src = process.cwd()
   }
 
   async run () {
@@ -57,8 +60,8 @@ class Report {
     // use-case.
     if (this._allCoverageFiles) return this._allCoverageFiles
 
+    const map = libCoverage.createCoverageMap()
     const v8ProcessCov = this._getMergedProcessCov()
-    const map = libCoverage.createCoverageMap({})
     const resultCountPerPath = new Map()
     const possibleCjsEsmBridges = new Map()
 
@@ -95,11 +98,14 @@ class Report {
         map.merge(converter.toIstanbul())
       }
     }
-
     this._allCoverageFiles = map
     return this._allCoverageFiles
   }
 
+  relativeToSrc (file) {
+    return join(this.src, relative(this.src, file))
+  }
+
   /**
    * Returns source-map and fake source file, if cached during Node.js'
    * execution. This is used to support tools like ts-node, which transpile
@@ -128,6 +134,29 @@ class Report {
     return sources
   }
 
+  /**
+   * //TODO: use https://www.npmjs.com/package/convert-source-map
+   * // no need to roll this ourselves this is already in the dep tree
+   * https://sourcemaps.info/spec.html
+   * @param {String} compilation target file
+   * @returns {String} full path to source map file
+   * @private
+   */
+  _getSourceMapFromFile (file) {
+    const fileBody = readFileSync(file).toString()
+    const sourceMapLineRE = /\/\/[#@] ?sourceMappingURL=([^\s'"]+)\s*$/mg
+    const results = fileBody.match(sourceMapLineRE)
+    if (results !== null) {
+      const sourceMap = results[results.length - 1].split('=')[1]
+      if (isAbsolute(sourceMap)) {
+        return sourceMap
+      } else {
+        const base = dirname(file)
+        return join(base, sourceMap)
+      }
+    }
+  }
+
   /**
    * Returns the merged V8 process coverage.
    *
@@ -139,14 +168,50 @@ class Report {
    */
   _getMergedProcessCov () {
     const v8ProcessCovs = []
+    const fileIndex = new Map() // Map<string, bool>
     for (const v8ProcessCov of this._loadReports()) {
       if (this._isCoverageObject(v8ProcessCov)) {
         if (v8ProcessCov['source-map-cache']) {
           Object.assign(this.sourceMapCache, v8ProcessCov['source-map-cache'])
         }
-        v8ProcessCovs.push(this._normalizeProcessCov(v8ProcessCov))
+        v8ProcessCovs.push(this._normalizeProcessCov(v8ProcessCov, fileIndex))
       }
     }
+
+    if (this.all) {
+      const emptyReports = []
+      v8ProcessCovs.unshift({
+        result: emptyReports
+      })
+      const workingDir = process.cwd()
+      this.exclude.globSync(workingDir).forEach((f) => {
+        const fullPath = resolve(workingDir, f)
+        if (!fileIndex.has(fullPath)) {
+          const ext = extname(f)
+          if (ext === '.js' || ext === '.ts' || ext === '.mjs') {
+            const stat = statSync(f)
+            const sourceMap = this._getSourceMapFromFile(f)
+            if (sourceMap !== undefined) {
+              this.sourceMapCache[`file://${fullPath}`] = { data: JSON.parse(readFileSync(sourceMap).toString()) }
+            }
+            emptyReports.push({
+              scriptId: 0,
+              url: resolve(f),
+              functions: [{
+                functionName: '(empty-report)',
+                ranges: [{
+                  startOffset: 0,
+                  endOffset: stat.size,
+                  count: 0
+                }],
+                isBlockCoverage: true
+              }]
+            })
+          }
+        }
+      })
+    }
+
     return mergeProcessCovs(v8ProcessCovs)
   }
 
@@ -196,12 +261,13 @@ class Report {
    * @return {v8ProcessCov} Normalized V8 process coverage.
    * @private
    */
-  _normalizeProcessCov (v8ProcessCov) {
+  _normalizeProcessCov (v8ProcessCov, fileIndex) {
     const result = []
     for (const v8ScriptCov of v8ProcessCov.result) {
       if (/^file:\/\//.test(v8ScriptCov.url)) {
         try {
           v8ScriptCov.url = furi.toSysPath(v8ScriptCov.url)
+          fileIndex.set(v8ScriptCov.url, true)
         } catch (err) {
           console.warn(err)
           continue

package-lock.json

@@ -41,7 +41,7 @@
     "istanbul-reports": "^2.2.6",
     "rimraf": "^3.0.0",
     "test-exclude": "^5.2.3",
-    "v8-to-istanbul": "^3.2.6",
+    "v8-to-istanbul": "git+https://github.com/istanbuljs/v8-to-istanbul.git#empty-report",
     "yargs": "^14.0.0",
     "yargs-parser": "^15.0.0"
   },

package.json

@@ -0,0 +1,5 @@
+export default function Unloaded(){
+  return 'Never loaded :('
+}
+
+console.log("This file shouldn't have been evaluated")