feat: allow a custom storagePath

Author: mvegter

README.md

@@ -33,7 +33,7 @@ Convert coverage from the format outputted by [puppeteer](https://developers.goo
         page.coverage.stopJSCoverage(),
         page.coverage.stopCSSCoverage(),
       ]);
-      pti.write([...jsCoverage, ...cssCoverage])
+      pti.write([...jsCoverage, ...cssCoverage], { storagePath: './.nyc_output' })
       await browser.close()
     })()
     ```

index.js

@@ -1,8 +1,8 @@
 const PuppeteerToIstanbul = require('./lib/puppeteer-to-istanbul')
 
 module.exports = {
-  write: (puppeteerFormat) => {
-    const pti = PuppeteerToIstanbul(puppeteerFormat)
-    pti.writeIstanbulFormat()
+  write: (puppeteerFormat, options) => {
+    const pti = PuppeteerToIstanbul(puppeteerFormat, options)
+    pti.writeIstanbulFormat(options)
   }
 }

lib/output-files.js

@@ -9,11 +9,14 @@ const clone = require('clone')
 const pathLib = require('path')
 const url = require('url')
 
-const storagePath = './.nyc_output/js'
 let iterator = {}
 
 class OutputFiles {
-  constructor (coverageInfo) {
+  constructor (coverageInfo, options) {
+    options = options || {}
+    options.storagePath = options.storagePath || './.nyc_output'
+    this.storagePath = `${options.storagePath}/js`
+
     // Clone coverageInfo to prevent mutating the passed in data
     this.coverageInfo = clone(coverageInfo)
     this._parseAndIsolate()
@@ -53,11 +56,11 @@ class OutputFiles {
     // Special case: when html present, strip and return specialized string
     if (pathLib.extname(parsedPath) === '.html') {
       isInline = true
-      parsedPath = pathLib.resolve(storagePath, parsedPath + 'puppeteerTemp-inline')
+      parsedPath = pathLib.resolve(this.storagePath, parsedPath + 'puppeteerTemp-inline')
     } else {
-      parsedPath = pathLib.resolve(storagePath, pathLib.dirname(parsedPath), pathLib.basename(parsedPath, '.js'))
+      parsedPath = pathLib.resolve(this.storagePath, pathLib.dirname(parsedPath), pathLib.basename(parsedPath, '.js'))
     }
-    mkdirp.sync(storagePath)
+    mkdirp.sync(this.storagePath)
     if (fs.existsSync(parsedPath + '.js') && isInline) {
       if (!Number.isInteger(iterator[parsedPath])) {
         iterator[parsedPath] = 1
@@ -90,8 +93,8 @@ class OutputFiles {
   }
 }
 
-function genOutputFiles (coverageInfo) {
-  return new OutputFiles(coverageInfo)
+function genOutputFiles (coverageInfo, options) {
+  return new OutputFiles(coverageInfo, options)
 }
 
 genOutputFiles.resetIterator = function () {

lib/puppeteer-to-istanbul.js

@@ -7,9 +7,13 @@ const v8toIstanbul = require('v8-to-istanbul')
 let jsonPart = {}
 
 class PuppeteerToIstanbul {
-  constructor (coverageInfo) {
+  constructor (coverageInfo, options) {
+    options = options || {}
+    options.storagePath = options.storagePath || './.nyc_output'
+
     this.coverageInfo = coverageInfo
-    this.puppeteerToConverter = OutputFiles(coverageInfo).getTransformedCoverage()
+    this.options = options
+    this.puppeteerToConverter = OutputFiles(coverageInfo, options).getTransformedCoverage()
     this.puppeteerToV8Info = PuppeteerToV8(this.puppeteerToConverter).convertCoverage()
   }
 
@@ -18,9 +22,9 @@ class PuppeteerToIstanbul {
   }
 
   writeIstanbulFormat () {
-    mkdirp.sync('./.nyc_output')
+    mkdirp.sync(this.options.storagePath)
 
-    const outFilePath = './.nyc_output/out.json'
+    const outFilePath = `${this.options.storagePath}/out.json`
 
     fs.writeFileSync(outFilePath, '')
 
@@ -61,8 +65,8 @@ function mergeCoverageData (obja, objb) {
   return obja
 }
 
-function genPuppeteerToIstanbul (coverageInfo) {
-  return new PuppeteerToIstanbul(coverageInfo)
+function genPuppeteerToIstanbul (coverageInfo, options) {
+  return new PuppeteerToIstanbul(coverageInfo, options)
 }
 
 genPuppeteerToIstanbul.resetJSONPart = function () {

test/puppeteer-to-istanbul.js

@@ -7,7 +7,7 @@ const OutputFiles = require('../lib/output-files')
 var PuppeteerToIstanbul = require('../lib/puppeteer-to-istanbul')
 
 describe('puppeteer-to-istanbul', () => {
-  it('outputs a valid out.json file', () => {
+  it('outputs a valid out.json file, to the default location', () => {
     const fixture = require('./fixtures/two-inline.json')
     const pti = PuppeteerToIstanbul(fixture)
     pti.writeIstanbulFormat()
@@ -17,6 +17,16 @@ describe('puppeteer-to-istanbul', () => {
     fs.unlinkSync('.nyc_output/out.json')
   })
 
+  it('outputs a valid out.json file, in the custom location', () => {
+    const fixture = require('./fixtures/two-inline.json')
+    const pti = PuppeteerToIstanbul(fixture, { storagePath: '.nyc_output/custom' })
+    pti.writeIstanbulFormat()
+    const content = fs.readFileSync('.nyc_output/custom/out.json', 'utf8')
+    const jsonObject = JSON.parse(content)
+    should.exist(jsonObject)
+    fs.unlinkSync('.nyc_output/custom/out.json')
+  })
+
   it('correctly sets coverage info', () => {
     const fixture = require('./fixtures/two-inline.json')
     const pti = PuppeteerToIstanbul(fixture)