Refactor.

* Add more tests.
* Redefine the way formatters can be configured.
 `progress` will only be valid when `ansi` is true,
 and `ansi` is no longer available for `markdown`.

Author: zoubin

bin/cmd.js

@@ -1,21 +1,26 @@
 #!/usr/bin/env node
-var minimist = require('minimist')
 
-var opts = minimist(process.argv.slice(2), {
-  boolean: true,
-  alias: {
-    ansi: 'a',
-    progress: 'p',
-    markdown: 'm',
-  },
-  default: {
-    ansi: true,
-    progress: true,
-    markdown: false,
-  },
-})
+var Command = require('commander').Command
+var program = new Command('tap-summary')
+
+program
+  .version(require('../package.json').version)
+  .option('--no-ansi', 'Disable ANSI formatting. Only valid for the default formatter.')
+  .option('--no-progress', 'Disable progress output during tests. Only valid for the default formatter.')
+  .option('-m, --markdown', 'Use the markdown formatter.')
+  .option('-f, --formatter <formatter>', 'Specify how to format the output. `markdown` and `default` are available.')
+  .parse(process.argv)
+
+var reporter
+if (program.markdown || program.formatter === 'markdown') {
+  reporter = require('../lib/markdown')()
+} else {
+  reporter = require('..')({
+    ansi: program.ansi,
+    progress: program.progress,
+  })
+}
 
-var reporter = require('..')(opts)
 
 process.stdin
   .pipe(reporter)

example/comment.js

@@ -0,0 +1,16 @@
+var test = require('tape')
+
+test('sync', function (t) {
+  t.ok(true, 'should pass')
+  console.log('Hello, ')
+  t.end()
+})
+
+test('async', function (t) {
+  process.nextTick(function () {
+    t.ok(true, 'should pass')
+    console.log('world!')
+    t.end()
+  })
+})
+

example/error.js

@@ -0,0 +1,17 @@
+var test = require('tape')
+
+test('pass', function (t) {
+  t.ok(true, 'should pass')
+  t.end()
+})
+
+test('fail', function (t) {
+  t.ok(false, 'should fail')
+  t.end()
+})
+
+test('pass and fail', function (t) {
+  t.ok(true, 'should pass')
+  t.ok(false, 'should fail')
+  t.end()
+})

example/empty.js example/no-plan.js

@@ -1,7 +1,7 @@
 var test = require('tape')
 var math = require('./math')
 
-test('t.plan', function(t) {
+test('pass', function(t) {
   t.plan(3)
 
   t.equal(
@@ -20,7 +20,7 @@ test('t.plan', function(t) {
   })
 })
 
-test('t.end', function(t) {
+test('fail', function(t) {
   t.equal(
     math.precision(0),
     0
@@ -39,67 +39,20 @@ test('t.end', function(t) {
       if (plan) {
         NEXT()
       } else {
-        console.log('DONE')
         t.end()
       }
     })
   })()
 })
 
-test('promise support', function(t) {
-  var plan = 10
-  t.equal(
-    math.add(0.34, 0.01),
-    0.35
-  )
-  t.equal(
-    math.add(1.1111, -1.11),
-    0.0011
-  )
-  // the test will end when the returned promise resolves
-  return new Promise(function (rs) {
-    (function NEXT() {
-      next(function () {
-        t.equal(
-          math.add(1, 2),
-          --plan === 5 ? 2 : 3
-        )
-        if (plan) {
-          NEXT()
-        } else {
-          console.log('DONE')
-          rs()
-        }
-      })
-    })()
-  })
-})
-
-test('callback support', function(t, cb) {
+test('comment', function (t) {
   next(function () {
-    t.equal(
-      math.add(0.34, 0.01),
-      0.35
-    )
-    cb()
-  })
-})
-
-test('check `task-tape` for more information', function(t) {
-  t.task(function (cb) {
-    next(function () {
-      t.equal(
-        math.precision(0.1),
-        1
-      )
-      cb()
-    })
+    t.ok(true, 'should pass')
+    console.log('This is something from `console.log`')
+    t.end()
   })
 })
 
 function next(fn) {
-  setTimeout(function() {
-    fn()
-  }, 100)
+  setTimeout(fn, 100)
 }
-

example/test-pass.js example/pass.js

@@ -1,2 +1 @@
-
-module.exports = require('./lib/summary')
+module.exports = require('./lib/screen')

example/run-test.js

@@ -0,0 +1,70 @@
+var reporter = require('./reporter')
+var symbols = require('figures')
+var prettyMs = require('pretty-ms')
+var LF = '\n'
+
+module.exports = function (opts) {
+  return reporter(new Formatter(opts))
+}
+module.exports.Formatter = Formatter
+
+function Formatter(opts) {
+  this.needDuration = !(opts && opts.duration === false)
+}
+
+Formatter.prototype.summary = function (summary) {
+  var output = [LF]
+  output.push('# Summary')
+  if (this.needDuration) {
+    output.push('- duration: ' + prettyMs(summary.duration))
+  }
+  output.push('- planned: ' + summary.planned)
+  output.push('- assertions: ' + summary.assertions)
+  output.push('- pass: ' + summary.pass)
+  output.push('- fail: ' + summary.fail)
+  return output.join(LF)
+}
+
+Formatter.prototype.comment = function (comments) {
+  var output = [LF]
+  output.push('# Comments')
+  output.push('```')
+  output.push(Object.keys(comments).map(function (name) {
+    return '# ' + name + LF + comments[name].join(LF)
+  }).join(LF + LF))
+  output.push('```')
+  return output.join(LF)
+}
+
+Formatter.prototype.fail = function (fail) {
+  var output = [LF]
+  output.push(('# Fails'))
+  output.push('```')
+  output.push(Object.keys(fail).map(function (name) {
+    var res = ['# ' + name]
+    fail[name].forEach(function (assertion) {
+      res.push('  ' + symbols.cross + ' ' + assertion.name)
+      res.push(this.prettifyError(assertion))
+    }, this)
+    return res.join(LF)
+  }, this).join(LF + LF))
+
+  output.push('```')
+  return output.join(LF)
+}
+
+Formatter.prototype.prettifyError = function (assertion) {
+  return assertion.error.raw
+}
+
+Formatter.prototype.test = function (test) {
+  if (!test) {
+    return '# Tests'
+  }
+  var title = test.name + ' [' +
+    'pass: ' + test.pass + ', fail: ' + test.fail +
+    (this.needDuration ? ', duration: ' + prettyMs(test.duration) : '') +
+    ']'
+  return LF + '- ' + (test.fail ? symbols.cross : symbols.tick) + ' ' + title
+}
+

example/test-error.js

@@ -0,0 +1,40 @@
+var summarize = require('./summarize')
+
+module.exports = function (formatter) {
+  var reporter = summarize()
+
+  if (formatter.init) {
+    formatter.init(reporter)
+  }
+
+  reporter.push(formatter.test())
+
+  reporter.on('test.end', function (test) {
+    reporter.push(formatter.test(test))
+  })
+
+  reporter.on('summary', function (summary, fails, comments) {
+    reporter.failed = !!summary.fail
+    if (summary.planned < 1) {
+      reporter.failed = true
+      summary.planned = 'NA (plans must appear once in output)'
+    } else if (summary.assertions !== summary.planned) {
+      reporter.failed = true
+      summary.planned = summary.planned + "(plans don't match final assertions)"
+    }
+
+    reporter.push(formatter.summary(summary))
+
+    if (summary.fail) {
+      reporter.push(formatter.fail(fails))
+    }
+    if (summary.comments) {
+      reporter.push(formatter.comment(comments))
+    }
+    reporter.push('\n\n')
+    reporter.push(null)
+  })
+
+  return reporter
+}
+