api return object consistency, closes #148

Author: Jeff Escalante

lib/index.js

@@ -33,17 +33,13 @@ class Spike extends EventEmitter {
    * @fires Spike#error
    * @fires Spike#warning
    * @fires Spike#compile
-   * @return {Array} a unique compile id, and webpack compiler instance
+   * @return {Object} compile id, webpack compiler
    */
   compile () {
     const id = this._id()
     const compiler = webpack(this.config)
-
     compiler.run(compileCallback.bind(this, id))
-
-    // Returns the compilation's ID synchronously, this can be checked against
-    // events emitted from the project instance.
-    return [id, compiler]
+    return {id, compiler}
   }
 
   /**
@@ -52,13 +48,14 @@ class Spike extends EventEmitter {
    * @fires Spike#error
    * @fires Spike#warning
    * @fires Spike#compile
-   * @return {Watcher} webpack watcher instance
+   * @return {Object} watch id, webpack watcher
    */
   watch (opts = {}) {
     const id = this._id()
     this.compiler = webpack(this.config)
-    this.watcher = this.compiler.watch(opts, compileCallback.bind(this, id))
-    return this.watcher
+    const watcher = this.compiler.watch(opts, compileCallback.bind(this, id))
+    this.watcher = watcher
+    return {id, watcher}
   }
 
   /**
@@ -76,10 +73,10 @@ class Spike extends EventEmitter {
    * @static
    * @param {Object} options - options for new project
    * @param {String} options.root - path ro the root of the project
-   * @param {String} [options.template='base'] - name of the template to use
-   * @param {String} [options.src=https://github.com/static-dev/spike-tpl-base.git] - path to the template source
-   * @param {Object} [options.overrides] - locals provided to the sprout template
+   * @param {String} [options.template] - name of the template to use
+   * @param {Object} [options.locals] - locals provided to the sprout template
    * @param {EventEmitter} [options.emitter] - an event emitter for feedback
+   * @param {Inquirer} [options.inquirer] - inquirer instance for CLI
    * @fires Spike#info
    * @fires Spike#error
    * @fires Spike#done
@@ -127,11 +124,11 @@ class Spike extends EventEmitter {
 
     // run it
     promise
-      .tap(() => { emit('info', 'initializing template') })
+      .tap(() => emit('info', 'initializing template'))
       .then(sprout.init.bind(sprout, opts.template, opts.root, sproutOptions))
-      .tap(() => { emit('info', 'installing production dependencies') })
+      .tap(() => emit('info', 'installing production dependencies'))
       .then(npmInstall.bind(null, opts))
-      .then(() => { return new Spike({ root: opts.root }) })
+      .then(() => new Spike({ root: opts.root }))
       .done(
         (instance) => { emit('done', instance) },
         (err) => { emit('error', err) }
@@ -181,7 +178,7 @@ function compileCallback (id, err, stats) {
     this.emit('warning', new Warning({ id: id, message: jsonStats.warnings }))
   }
 
-  this.emit('compile', { id: id, stats: stats })
+  this.emit('compile', {id, stats})
 }
 
 /**
@@ -195,7 +192,7 @@ Spike.template = {
    * @param {String} src - url from which the template can be `git clone`d
    * @param {EventEmitter} emitter - will return events to report progress
    * @fires emitter#info
-   * @fires emitter#done
+   * @fires emitter#success
    * @fires emitter#error
    */
   add: function (options = {}) {
@@ -278,7 +275,6 @@ Spike.template = {
   },
   /**
    * Removes the primary spike config and all templates, like a clean install
-   * @private
    */
   reset: function () {
     try {

test/watch.js

@@ -24,7 +24,7 @@ test.cb('watches the project, reloads on modification', (t) => {
     }
   })
 
-  const watcher = project.watch()
+  const {watcher} = project.watch()
   // make sure the watcher is returned
   t.truthy((typeof watcher.startTime) === 'number')
 })
@@ -53,5 +53,5 @@ test.cb('incorporates new file when added while watching', (t) => {
     }
   })
 
-  const watcher = project.watch()
+  const {watcher} = project.watch()
 })