find files to include using globby

Author: bahmutov

examples/all-files/package.json

@@ -4,7 +4,9 @@
   "scripts": {
     "start": "../../node_modules/.bin/parcel serve index.html",
     "cy:open": "../../node_modules/.bin/cypress open",
-    "dev": "../../node_modules/.bin/start-test 1234 cy:open"
+    "cy:run": "../../node_modules/.bin/cypress run",
+    "dev": "../../node_modules/.bin/start-test 1234 cy:open",
+    "e2e": "../../node_modules/.bin/start-test 1234 cy:run"
   },
   "nyc": {
     "all": true,

task-utils.js

@@ -7,6 +7,7 @@ const { readFileSync, writeFileSync, existsSync } = require('fs')
 const { isAbsolute, resolve, join } = require('path')
 const debug = require('debug')('code-coverage')
 const chalk = require('chalk')
+const globby = require('globby')
 
 function combineNycOptions({
   pkgNycOptions,
@@ -264,12 +265,51 @@ function tryFindingLocalFiles(nycFilename) {
   }
 }
 
+/**
+ * If the website or unit tests did not load ALL files we need to
+ * include, then we should include the missing files ourselves
+ * before generating the report.
+ *
+ * @see https://github.com/cypress-io/code-coverage/issues/207
+ */
+function includeAllFiles(nycOptions) {
+  debug('include all files options: %o', {
+    all: nycOptions.all,
+    include: nycOptions.include,
+    exclude: nycOptions.exclude
+  })
+
+  let patterns = []
+  if (Array.isArray(nycOptions.include)) {
+    patterns = patterns.concat(nycOptions.include)
+  } else if (typeof nycOptions.include === 'string') {
+    patterns.push(nycOptions.include)
+  }
+
+  if (Array.isArray(nycOptions.exclude)) {
+    const negated = nycOptions.exclude.map(s => '!' + s)
+    patterns = patterns.concat(negated)
+  } else if (typeof nycOptions.exclude === 'string') {
+    patterns.push('!' + nycOptions.exclude)
+  }
+  // always exclude node_modules
+  // https://github.com/istanbuljs/nyc#including-files-within-node_modules
+  patterns.push('!**/node_modules/**')
+
+  debug('searching files to include using patterns %o', patterns)
+
+  const allFiles = globby.sync(patterns)
+  debug('found these files %o', allFiles)
+  // TODO check if any of the files to include are missing from NYC output JSON file
+}
+
 module.exports = {
   showNycInfo,
   resolveRelativePaths,
   checkAllPathsNotFound,
   tryFindingLocalFiles,
   readNycOptions,
   combineNycOptions,
-  defaultNycOptions
+  defaultNycOptions,
+  includeAllFiles
 }

task.js

@@ -8,7 +8,8 @@ const {
   resolveRelativePaths,
   checkAllPathsNotFound,
   tryFindingLocalFiles,
-  readNycOptions
+  readNycOptions,
+  includeAllFiles
 } = require('./task-utils')
 const { fixSourcePaths } = require('./support-utils')
 const NYC = require('nyc')
@@ -165,6 +166,11 @@ const tasks = {
     // seems nyc API really is using camel cased version
     nycReportOptions.reportDir = nycReportOptions['report-dir']
 
+    if (nycReportOptions.all) {
+      debug('nyc needs to report on all included files')
+      includeAllFiles(nycReportOptions)
+    }
+
     debug('calling NYC reporter with options %o', nycReportOptions)
     debug('current working directory is %s', process.cwd())
     const nyc = new NYC(nycReportOptions)