rename config to file

Author: chrisbreiding

index.js

@@ -33,7 +33,7 @@ const defaultOptions = {
 // export a function that returns another function, making it easy for users
 // to configure like so:
 //
-// on('file:preprocessor', webpack(config, options))
+// on('file:preprocessor', webpack(options))
 //
 const preprocessor = (options = {}) => {
   log('user options:', options)
@@ -49,8 +49,8 @@ const preprocessor = (options = {}) => {
   // when running in the GUI, it will likely get called multiple times
   // with the same filePath, as the user could re-run the tests, causing
   // the supported file and spec file to be requested again
-  return (config) => {
-    const filePath = config.filePath
+  return (file) => {
+    const filePath = file.filePath
     log('get', filePath)
 
     // since this function can get called multiple times with the same
@@ -68,7 +68,7 @@ const preprocessor = (options = {}) => {
     // we're provided a default output path that lives alongside Cypress's
     // app data files so we don't have to worry about where to put the bundled
     // file on disk
-    const outputPath = config.outputPath
+    const outputPath = file.outputPath
 
     // we need to set entry and output
     webpackOptions = Object.assign(webpackOptions, {
@@ -132,25 +132,25 @@ const preprocessor = (options = {}) => {
         log('- compile finished for', filePath)
         // when the bundling is finished, we call `util.fileUpdated`
         // to let Cypress know to re-run the spec
-        config.emit('rerun')
+        file.emit('rerun')
       })
     })
 
-    if (config.shouldWatch) {
+    if (file.shouldWatch) {
       log('watching')
     }
 
-    const bundler = config.shouldWatch ?
+    const bundler = file.shouldWatch ?
       compiler.watch(watchOptions, handle) :
       compiler.run(handle)
 
     // when the spec or project is closed, we need to clean up the cached
     // bundle promise and stop the watcher via `bundler.close()`
-    config.on('close', () => {
+    file.on('close', () => {
       log('close', filePath)
       delete bundles[filePath]
 
-      if (config.shouldWatch) {
+      if (file.shouldWatch) {
         bundler.close()
       }
     })

test/index_spec.js

@@ -35,7 +35,7 @@ describe('webpack preprocessor', function () {
       toJson () { return { warnings: [], errors: [] } },
     }
 
-    this.config = {
+    this.file = {
       filePath: 'path/to/file.js',
       outputPath: 'output/output.js',
       shouldWatch: false,
@@ -50,7 +50,7 @@ describe('webpack preprocessor', function () {
     }
 
     this.run = () => {
-      return preprocessor(this.options)(this.config)
+      return preprocessor(this.options)(this.file)
     }
   })
 
@@ -67,7 +67,7 @@ describe('webpack preprocessor', function () {
 
   describe('preprocessor function', function () {
     afterEach(function () {
-      this.config.on.withArgs('close').yield() // resets the cached bundles
+      this.file.on.withArgs('close').yield() // resets the cached bundles
     })
 
     describe('when it finishes cleanly', function () {
@@ -86,14 +86,14 @@ describe('webpack preprocessor', function () {
         webpack.returns(this.compilerApi)
 
         const run = preprocessor(this.options)
-        run(this.config)
-        run(this.config)
+        run(this.file)
+        run(this.file)
         expect(webpack).to.be.calledOnce
       })
 
       it('specifies the entry file', function () {
         return this.run().then(() => {
-          expect(webpack.lastCall.args[0].entry).to.equal(this.config.filePath)
+          expect(webpack.lastCall.args[0].entry).to.equal(this.file.filePath)
         })
       })
 
@@ -113,15 +113,15 @@ describe('webpack preprocessor', function () {
       })
 
       it('watches when shouldWatch is true', function () {
-        this.config.shouldWatch = true
+        this.file.shouldWatch = true
         this.compilerApi.watch.yields(null, this.statsApi)
         return this.run().then(() => {
           expect(this.compilerApi.watch).to.be.called
         })
       })
 
       it('includes watchOptions if provided', function () {
-        this.config.shouldWatch = true
+        this.file.shouldWatch = true
         this.compilerApi.watch.yields(null, this.statsApi)
         this.options.watchOptions = { poll: true }
         return this.run().then(() => {
@@ -133,29 +133,29 @@ describe('webpack preprocessor', function () {
 
       it('resolves with the output path', function () {
         return this.run().then((outputPath) => {
-          expect(outputPath).to.be.equal(this.config.outputPath)
+          expect(outputPath).to.be.equal(this.file.outputPath)
         })
       })
 
       it('emits `rerun` when there is an update', function () {
         this.compilerApi.plugin.withArgs('compile').yields()
         return this.run().then(() => {
-          expect(this.config.emit).to.be.calledWith('rerun')
+          expect(this.file.emit).to.be.calledWith('rerun')
         })
       })
 
       it('closes bundler when shouldWatch is true and `close` is emitted', function () {
-        this.config.shouldWatch = true
+        this.file.shouldWatch = true
         this.compilerApi.watch.yields(null, this.statsApi)
         return this.run().then(() => {
-          this.config.on.withArgs('close').yield()
+          this.file.on.withArgs('close').yield()
           expect(this.watchApi.close).to.be.called
         })
       })
 
       it('does not close bundler when shouldWatch is false and `close` is emitted', function () {
         return this.run().then(() => {
-          this.config.on.withArgs('close').yield()
+          this.file.on.withArgs('close').yield()
           expect(this.watchApi.close).not.to.be.called
         })
       })