feat: move log messages to DEBUG=cypress-istanbul, close #9

Author: bahmutov

README.md

@@ -65,9 +65,14 @@ Now the code coverage from spec files will be combined with end-to-end coverage.
 
 ## Examples
 
+- [cypress-example-todomvc-redux](https://github.com/cypress-io/cypress-example-todomvc-redux)
 - Read ["Code Coverage by Parcel Bundler"](https://glebbahmutov.com/blog/code-coverage-by-parcel/) blog post
 - Read ["Combined End-to-end and Unit Test Coverage"](https://glebbahmutov.com/blog/combined-end-to-end-and-unit-test-coverage/)
 
+## Debugging
+
+Run tests with `DEBUG=cypress-istanbul` environment variable to see log messages
+
 ## License
 
 This project is licensed under the terms of the [MIT license](/LICENSE.md).

package-lock.json

@@ -36,7 +36,8 @@
     "*.js"
   ],
   "dependencies": {
-    "@cypress/browserify-preprocessor": "2.1.0"
+    "@cypress/browserify-preprocessor": "2.1.0",
+    "debug": "4.1.1"
   },
   "devDependencies": {
     "@babel/core": "7.4.4",

package.json

@@ -2,6 +2,7 @@ const istanbul = require('istanbul-lib-coverage')
 const { join } = require('path')
 const { existsSync, mkdirSync, readFileSync, writeFileSync } = require('fs')
 const execa = require('execa')
+const debug = require('debug')('cypress-istanbul')
 
 // these are standard folder and file names used by NYC tools
 const outputFolder = '.nyc_output'
@@ -11,7 +12,7 @@ const nycFilename = join(coverageFolder, 'out.json')
 function saveCoverage (coverage) {
   if (!existsSync(coverageFolder)) {
     mkdirSync(coverageFolder)
-    console.log('created folder %s for output coverage', coverageFolder)
+    debug('created folder %s for output coverage', coverageFolder)
   }
 
   writeFileSync(nycFilename, JSON.stringify(coverage, null, 2))
@@ -29,7 +30,7 @@ module.exports = {
    */
   resetCoverage ({ isInteractive }) {
     if (isInteractive) {
-      console.log('reset code coverage in interactive mode')
+      debug('reset code coverage in interactive mode')
       const coverageMap = istanbul.createCoverageMap({})
       saveCoverage(coverageMap)
     }
@@ -54,7 +55,7 @@ module.exports = {
     const coverageMap = istanbul.createCoverageMap(previous)
     coverageMap.merge(coverage)
     saveCoverage(coverageMap)
-    console.log('wrote coverage file %s', nycFilename)
+    debug('wrote coverage file %s', nycFilename)
 
     return null
   },
@@ -69,8 +70,10 @@ module.exports = {
       console.warn('Skipping coverage report')
       return null
     }
-    console.log('saving coverage report')
+    const command = 'nyc'
+    const args = ['report', '--reporter=html']
+    debug('saving coverage report using command: %s %s', command, args)
     // should we generate report via NYC module API?
-    return execa('nyc', ['report', '--reporter=html'], { stdio: 'inherit' })
+    return execa(command, args, { stdio: 'inherit' })
   }
 }