cleanup

Author: sindresorhus

index.js

@@ -7,10 +7,6 @@ var Runner = require('./lib/runner');
 var log = new Squeak({separator: ' '});
 var runner = new Runner();
 
-/**
- * Add log types
- */
-
 log.type('success', {
 	color: 'green',
 	prefix: figures.tick
@@ -21,14 +17,6 @@ log.type('error', {
 	prefix: figures.cross
 });
 
-/**
- * Handle test
- *
- * @param {Object} err
- * @param {String} title
- * @api private
- */
-
 function test(err, title) {
 	if (err) {
 		log.error(title, chalk.red(err.message));
@@ -38,13 +26,6 @@ function test(err, title) {
 	log.success(title);
 }
 
-/**
- * Show stack for each failed test
- *
- * @param {Array} results
- * @api private
- */
-
 function stack(results) {
 	var i = 0;
 
@@ -61,14 +42,6 @@ function stack(results) {
 	});
 }
 
-/**
- * Show summary and exit
- *
- * @param {Object} stats
- * @param {Array} results
- * @api private
- */
-
 function exit(stats, results) {
 	if (stats.testCount > 0) {
 		log.write();

lib/runner.js

@@ -5,13 +5,6 @@ var each = require('each-async');
 var eachSerial = require('async-each-series');
 var Test = require('./test');
 
-/**
- * Initialize a new `Runner`
- *
- * @param {Object} opts
- * @api public
- */
-
 function Runner(opts) {
 	if (!(this instanceof Runner)) {
 		return new Runner(opts);
@@ -31,39 +24,16 @@ function Runner(opts) {
 util.inherits(Runner, EventEmitter);
 module.exports = Runner;
 
-/**
- * Add concurrent test to `Runner`
- *
- * @param {String} title
- * @param {Function} cb
- * @api public
- */
-
 Runner.prototype.addTest = function (title, cb) {
 	this.stats.testCount++;
 	this.tests.concurrent.push(new Test(title, cb));
 };
 
-/**
- * Add serial test to `Runner`
- *
- * @param {String} title
- * @param {Function} cb
- * @api public
- */
-
 Runner.prototype.addSerialTest = function (title, cb) {
 	this.stats.testCount++;
 	this.tests.serial.push(new Test(title, cb));
 };
 
-/**
- * Run concurrent tests
- *
- * @param {Function} cb
- * @api private
- */
-
 Runner.prototype.concurrent = function (cb) {
 	each(this.tests.concurrent, function (test, i, next) {
 		test.run(function (err) {
@@ -82,13 +52,6 @@ Runner.prototype.concurrent = function (cb) {
 	}.bind(this), cb);
 };
 
-/**
- * Run serial tests
- *
- * @param {Function} cb
- * @api private
- */
-
 Runner.prototype.serial = function (cb) {
 	eachSerial(this.tests.serial, function (test, next) {
 		test.run(function (err) {
@@ -107,13 +70,6 @@ Runner.prototype.serial = function (cb) {
 	}.bind(this), cb);
 };
 
-/**
- * Run the `Runner`
- *
- * @param {Function} cb
- * @api public
- */
-
 Runner.prototype.run = function (cb) {
 	var concurrent = this.tests.concurrent;
 	var serial = this.tests.serial;
@@ -136,13 +92,6 @@ Runner.prototype.run = function (cb) {
 	this.end(cb);
 };
 
-/**
- * Handle completion
- *
- * @param {Function} cb
- * @api private
- */
-
 Runner.prototype.end = function (cb) {
 	this.stats.passCount = this.stats.testCount - this.stats.failCount;
 	cb(this.stats, this.results);

lib/test.js

@@ -5,14 +5,6 @@ var EventEmitter = require('events').EventEmitter;
 var fnName = require('fn-name');
 var claim = require('claim');
 
-/**
- * Initialize a new `Test`
- *
- * @param {String} title
- * @param {Function} fn
- * @api public
- */
-
 function Test(title, fn) {
 	if (!(this instanceof Test)) {
 		return new Test(title, fn);
@@ -56,13 +48,6 @@ Object.keys(claim).forEach(function (el) {
 	};
 });
 
-/**
- * Plan number of assertions
- *
- * @param {Number} count
- * @api public
- */
-
 Test.prototype.plan = function (count) {
 	if (typeof count !== 'number') {
 		throw new TypeError('Expected a number');
@@ -71,23 +56,10 @@ Test.prototype.plan = function (count) {
 	this.planCount = count;
 };
 
-/**
- * Skip test
- *
- * @api public
- */
-
 Test.prototype.skip = function () {
 	this.skipTest = true;
 };
 
-/**
- * Run test
- *
- * @param {Function} cb
- * @api public
- */
-
 Test.prototype.run = function (cb) {
 	this.cb = cb;
 
@@ -116,12 +88,6 @@ Test.prototype.run = function (cb) {
 	}
 };
 
-/**
- * End test
- *
- * @api public
- */
-
 Test.prototype.end = function () {
 	if (this.endCalled) {
 		throw new Error('.end() called more than once');
@@ -131,12 +97,6 @@ Test.prototype.end = function () {
 	this.exit();
 };
 
-/**
- * Exit test
- *
- * @api private
- */
-
 Test.prototype.exit = function () {
 	if (this.planCount !== null && this.planCount !== this.assertCount) {
 		this.assertError = new assert.AssertionError({

package.json

@@ -4,7 +4,6 @@
   "description": "Simple concurrent test runner",
   "license": "MIT",
   "repository": "sindresorhus/ava",
-  "bin": "cli.js",
   "maintainers": [
     {
       "name": "Sindre Sorhus",
@@ -17,11 +16,12 @@
       "url": "github.com/kevva"
     }
   ],
+  "bin": "cli.js",
   "engines": {
     "node": ">=0.10.0"
   },
   "scripts": {
-    "test": "xo && node cli.js test/test.js | faucet"
+    "test": "xo && node test/test.js | tap-dot"
   },
   "files": [
     "index.js",
@@ -36,6 +36,7 @@
     "runner",
     "concurrent",
     "parallel",
+    "fast",
     "tape",
     "tap",
     "mocha",
@@ -56,7 +57,6 @@
     "update-notifier": "^0.5.0"
   },
   "devDependencies": {
-    "faucet": "^0.0.1",
     "pinkie-promise": "^1.0.0",
     "tape": "^4.0.0",
     "xo": "*"

readme.md

@@ -31,7 +31,6 @@ Ava accepts files/folders/globs.
 var test = require('ava');
 
 test('test something', function (t) {
-	t.assert(true);
 	t.is('unicorn', 'unicorn');
 	t.end();
 });
@@ -46,7 +45,7 @@ $ npm test
 
 ## Credit
 
-[![Sindre Sorhus](http://gravatar.com/avatar/d36a92237c75c5337c17b60d90686bf9?s=144)](http://sindresorhus.com) | [![Kevin Mårtensson](http://gravatar.com/avatar/48fa294e3cd41680b80d3ed6345c7b4d?s=144)](https://github.com/kevva)
+[![Sindre Sorhus](http://gravatar.com/avatar/d36a92237c75c5337c17b60d90686bf9?s=120)](http://sindresorhus.com) | [![Kevin Mårtensson](http://gravatar.com/avatar/48fa294e3cd41680b80d3ed6345c7b4d?s=120)](https://github.com/kevva)
 ---|---
 [Sindre Sorhus](http://sindresorhus.com) | [Kevin Mårtensson](https://github.com/kevva)