Merge pull request #142 from static-dev/event-naming

Switch up the event naming a bit

Author: Jeff Escalante

lib/index.js

@@ -208,7 +208,7 @@ Spike.template = {
 
     emit('info', 'adding template')
     sprout.add(opts.name, opts.src).done(() => {
-      emit('done', `template "${opts.name}" added`)
+      emit('success', `template "${opts.name}" added`)
     }, (err) => {
       emit('error', err)
     })
@@ -219,7 +219,7 @@ Spike.template = {
    * @param {String} name - name of the template to remove
    * @param {EventEmitter} emitter - will return events to report progress
    * @fires emitter#info
-   * @fires emitter#done
+   * @fires emitter#success
    */
   remove: function (options = {}) {
     const schema = Joi.object().keys({
@@ -230,7 +230,7 @@ Spike.template = {
 
     emit('info', 'removing template')
     sprout.remove(opts.name).done(() => {
-      emit('done', `template "${opts.name}" removed`)
+      emit('success', `template "${opts.name}" removed`)
     })
   },
   /**
@@ -239,7 +239,7 @@ Spike.template = {
    * @param {String} name - name of the template to make default
    * @param {EventEmitter} [emitter] - will return events to report progress
    * @fires emitter#info
-   * @fires emitter#done
+   * @fires emitter#success
    * @fires emitter#error
    */
   default: function (options = {}) {
@@ -253,7 +253,7 @@ Spike.template = {
     if (tpl) {
       writeConfig({ defaultTemplate: { name: tpl.name, src: tpl.src } })
       const message = `template "${opts.name}" is now the default`
-      emit('done', message)
+      emit('success', message)
       return message
     } else {
       const message = `template "${opts.name}" doesn't exist`
@@ -265,15 +265,15 @@ Spike.template = {
    * Sets a template as the default when creating projects with `Spike.new`
    * @param {EventEmitter} [emitter] - will return events to report progress
    * @fires emitter#info
-   * @fires emitter#done
+   * @fires emitter#success
    */
   list: function (options = {}) {
     const schema = Joi.object().keys({
       emitter: Joi.func().default({ emit: (x) => x })
     })
     const {emit, sprout} = this._init(options, schema)
 
-    emit('done', sprout.templates)
+    emit('success', sprout.templates)
     return sprout.templates
   },
   /**

readme.md

@@ -139,7 +139,7 @@ const emitter = new EventEmitter()
 
 emitter.on('info', console.log)
 emitter.on('error', console.error)
-emitter.on('done', console.log)
+emitter.on('success', console.log)
 
 Spike.template.add({
   name: 'test',
@@ -157,7 +157,7 @@ const EventEmitter = require('events')
 const emitter = new EventEmitter()
 
 emitter.on('info', console.log)
-emitter.on('done', console.log)
+emitter.on('success', console.log)
 
 Spike.template.remove({ name: 'test' emitter: emitter })
 ```
@@ -172,7 +172,7 @@ const emitter = new EventEmitter()
 
 emitter.on('info', console.log)
 emitter.on('error', console.log)
-emitter.on('done', console.log)
+emitter.on('success', console.log)
 
 Spike.template.default({ name: 'test' emitter: emitter })
 ```
@@ -193,7 +193,7 @@ const EventEmitter = require('events')
 const emitter = new EventEmitter()
 
 emitter.on('info', console.log)
-emitter.on('done', console.log)
+emitter.on('success', console.log)
 
 Spike.template.list({ emitter: emitter })
 ```

test/new.js

@@ -37,7 +37,7 @@ test.cb('creates a new project with a custom template', (t) => {
   const e2 = new EventEmitter()
 
   e1.on('info', debug)
-  e1.on('done', (res) => {
+  e1.on('success', (res) => {
     Spike.new({
       root: testPath,
       emitter: e2,

test/template.js

@@ -3,7 +3,7 @@ const EventEmitter = require('events')
 const path = require('path')
 const fs = require('fs')
 const rimraf = require('rimraf')
-const {fixturesPath} = require('./_helpers')
+const {fixturesPath, debug} = require('./_helpers')
 const Spike = require('..')
 
 test.before((t) => { Spike.template.reset() })
@@ -12,9 +12,9 @@ test.afterEach((t) => { Spike.template.reset() })
 test.cb('template.add adds a template', (t) => {
   const emitter = new EventEmitter()
 
-  emitter.on('info', console.log)
+  emitter.on('info', debug)
 
-  emitter.on('done', (res) => {
+  emitter.on('success', (res) => {
     t.truthy(res === 'template "test" added')
     t.truthy(Object.keys(Spike.template.list()).indexOf('test') > -1)
     t.end()
@@ -31,14 +31,14 @@ test.cb('template.remove gets rid of a template', (t) => {
   const e1 = new EventEmitter()
   const e2 = new EventEmitter()
 
-  e1.on('info', console.log)
-  e2.on('info', console.log)
+  e1.on('info', debug)
+  e2.on('info', debug)
 
-  e1.on('done', (res) => {
+  e1.on('success', (res) => {
     Spike.template.remove({ name: 'test', emitter: e2 })
   })
 
-  e2.on('done', (res) => {
+  e2.on('success', (res) => {
     t.truthy(res === 'template "test" removed')
     t.falsy(Object.keys(Spike.template.list()).indexOf('test') > -1)
     t.end()
@@ -57,15 +57,15 @@ test.cb('template.default sets the default template', (t) => {
   const e3 = new EventEmitter()
   const testPath = path.join(fixturesPath, 'new_test')
 
-  e1.on('info', console.log)
-  e2.on('info', console.log)
-  e3.on('info', console.log)
+  e1.on('info', debug)
+  e2.on('info', debug)
+  e3.on('info', debug)
 
-  e1.on('done', (res) => {
+  e1.on('success', (res) => {
     Spike.template.default({ name: 'test', emitter: e2 })
   })
 
-  e2.on('done', (res) => {
+  e2.on('success', (res) => {
     t.truthy(res === 'template "test" is now the default')
     Spike.new({
       root: testPath,