support running ava without arguments

Author: sindresorhus

.gitattributes

@@ -1 +1,3 @@
 * text=auto
+*.ai binary
+*.psd binary

cli.js

@@ -11,10 +11,13 @@ var cli = meow({
 		'Usage',
 		'  ava <file|folder|glob> [...]',
 		'',
-		'Example',
+		'Examples',
+		'  ava',
 		'  ava test.js test2.js',
-		'  ava test',
-		'  ava test-*.js'
+		'  ava test-*.js',
+		'',
+		'Default patterns when no arguments:',
+		'test.js test-*.js test/**'
 	]
 }, {
 	string: ['_']
@@ -37,6 +40,14 @@ function run(file) {
 }
 
 function init(files) {
+	if (files.length === 0) {
+		files = [
+			'test.js',
+			'test-*.js',
+			'test/**'
+		];
+	}
+
 	globby(files, function (err, files) {
 		if (err) {
 			console.error(err.message);
@@ -51,9 +62,4 @@ function init(files) {
 
 updateNotifier({pkg: cli.pkg}).notify();
 
-if (cli.input.length === 0) {
-	console.error('Input required');
-	process.exit(1);
-}
-
 init(cli.input);

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;
 
@@ -96,19 +68,26 @@ Test.prototype.run = function (cb) {
 	}
 
 	try {
-		this.fn(this);
+		var ret = this.fn(this);
+
+		if (ret && typeof ret.then === 'function') {
+			ret.then(this.exit.bind(this)).catch(function (err) {
+				this.assertError = new assert.AssertionError({
+					actual: err,
+					message: 'Promise rejected → ' + err,
+					operator: 'promise',
+					stackStartFunction: this
+				});
+
+				this.exit();
+			}.bind(this));
+		}
 	} catch (err) {
 		this.assertError = err;
 		this.exit();
 	}
 };
 
-/**
- * End test
- *
- * @api public
- */
-
 Test.prototype.end = function () {
 	if (this.endCalled) {
 		throw new Error('.end() called more than once');
@@ -118,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({

media/header.png

@@ -4,7 +4,7 @@
   "description": "Simple concurrent test runner",
   "license": "MIT",
   "repository": "sindresorhus/ava",
-  "bin": "cli.js",
+  "homepage": "http://ava.li",
   "author": {
     "name": "Sindre Sorhus",
     "email": "sindresorhus@gmail.com",
@@ -22,11 +22,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",
@@ -41,6 +42,7 @@
     "runner",
     "concurrent",
     "parallel",
+    "fast",
     "tape",
     "tap",
     "mocha",
@@ -61,7 +63,8 @@
     "update-notifier": "^0.5.0"
   },
   "devDependencies": {
-    "faucet": "^0.0.1",
+    "pinkie-promise": "^1.0.0",
+    "tap-dot": "^1.0.0",
     "tape": "^4.0.0",
     "xo": "*"
   }

media/header.psd

@@ -1,7 +1,11 @@
-# ava [![Build Status](https://travis-ci.org/sindresorhus/ava.svg?branch=master)](https://travis-ci.org/sindresorhus/ava)
+# ![AVA](media/header.png)
 
 > Simple concurrent test runner
 
+[![Build Status](https://travis-ci.org/sindresorhus/ava.svg?branch=master)](https://travis-ci.org/sindresorhus/ava)
+
+Even though JavaScript is single-threaded, IO in Node.js can happen in parallel due to its async nature. AVA takes advantage of this and runs your tests concurrently, which is especially beneficial for IO heavy tests. [Switching](https://github.com/sindresorhus/pageres/commit/663be15acb3dd2eb0f71b1956ef28c2cd3fdeed0) from Mocha to AVA in Pageres brought the test time down from 31 sec to 11 sec. Having tests run concurrently forces you to write atomic tests, meaning tests that don't depend on global state or the state of other tests, which is a great thing!
+
 
 ## Install
 
@@ -12,45 +16,214 @@ $ npm install --save-dev ava
 
 ## Usage
 
-##### Add it to `package.json`
+##### Add it to package.json
 
 ```json
 {
 	"scripts": {
-		"test": "ava test.js"
+		"test": "ava"
 	}
 }
 ```
 
-Ava accepts files/folders/globs.
-
 
 ##### Create your test file
 
 ```js
 var test = require('ava');
 
-test('test something', function (t) {
-	t.assert(true);
-	t.is('unicorn', 'unicorn');
+test('foo', function (t) {
+	t.pass();
 	t.end();
 });
+
+test('bar', function (t) {
+	t.plan(2)
+
+	setTimeout(function () {
+		t.is('bar', 'bar');
+		t.same(['a', 'b'], ['a', 'b']);
+	}, 100);
+});
 ```
 
+<img src="screenshot.png" width="150" align="right">
+
 ##### Run it
 
 ```
 $ npm test
 ```
 
 
-## Credit
+## CLI
+
+```
+$ ava --help
+
+  Usage
+    ava <file|folder|glob> [...]
+
+  Examples
+    ava
+    ava test.js test2.js
+    ava test-*.js
+
+  Default patterns when no arguments:
+  test.js test-*.js test/**
+```
+
+
+## Documentation
+
+Test files are just normal Node.js scripts and can be run with `$ node test.js`. However, using the CLI is preferred for simplicity and future [parallelism support](https://github.com/sindresorhus/ava/issues/1).
+
+Tests are run async and require you to either set planned assertions `t.plan(1)`, explicitly end the test when done `t.end()`, or return a promise.
+
+You have to define all tests synchronously, meaning you can't define a test in the next tick, e.g. inside a `setTimeout`.
+
+### Test anatomy
+
+To create a test, you just call the `test` function you require'd from AVA and pass in an optional test name and a callback function containing the test execution. The passed callback function is given the context as the first argument where you can call the different AVA methods and assertions.
+
+```js
+test('name', function (t) {
+	t.pass();
+	t.end();
+});
+```
+
+### Optional test name
+
+Naming a test is optional, but you're recommended to use one if you have more than one test.
+
+```js
+test(function (t) {
+	t.end();
+});
+```
+
+You can also choose to use a named function instead:
+
+```js
+test(function name(t) {
+	t.end();
+});
+```
+
+### Planned assertions
+
+Planned assertions are useful for being able to assert that all async actions happened and catch bugs where too many assertions happen. It also comes with the benefit of not having to manually end the test.
+
+This will result in a passed test:
+
+```js
+test(function (t) {
+	t.plan(1);
+
+	setTimeout(function () {
+		t.pass();
+	}, 100);
+});
+```
+
+And this will result in an error because the code called more assertions than planned:
+
+```js
+test(function (t) {
+	t.plan(1);
+
+	t.pass();
+
+	setTimeout(function () {
+		t.pass();
+	}, 100);
+});
+```
+
+### Promise support
+
+If you return a promise in the test you don't need to explicitly end the test as it will end when the promise resolves.
+
+```js
+test(function (t) {
+	return somePromise().then(function (result) {
+		t.is(result, 'unicorn');
+	});
+});
+```
+
+
+### Serial test execution
+
+While concurrency is awesome, there are some things that can't be done concurrently. In these rare cases, you can call `test.serial`, which will force those tests to run serially before the concurrent ones.
+
+```js
+test.serial(function (t) {
+	t.end();
+});
+```
+
+
+## API
+
+### test([name], body)
+### test.serial([name], body)
+
+#### name
 
-[![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://sindresorhus.com) | [Kevin Mårtensson](https://github.com/kevva)
+Type: `string`
+
+Test name.
+
+#### body(context)
+
+Type: `function`
+
+Should contain the actual test.
+
+##### context
+
+Passed into the test function and contains the different AVA methods and assertions.
+
+See the [`claim` docs](https://github.com/kevva/claim#api) for supported assertions.
+
+###### plan(count)
+
+Plan how many assertion there are in the test. The test will fail if the actual assertion count doesn't match planned assertions. When planned assertions are used you don't need to explicitly end the test.
+
+Be aware that this doesn't work with custom assert modules. You must then call `.end()` explicitly.
+
+###### end()
+
+End the test. Use this when `plan()` is not used.
+
+
+## Tips
+
+### Temp files
+
+Running tests concurrently comes with some challenges, doing IO is one. Usually, serial tests just create temp directories in the current test directory and cleans it up at the end. This won't work when you run tests concurrently as tests will conflict with each other. The correct way to do it is to use a new temp directory for each test. The [`tempfile`](https://github.com/sindresorhus/tempfile) and [`temp-write`](https://github.com/sindresorhus/temp-write) modules can be helpful.
+
+
+## FAQ
+
+### Why not `mocha`, `tape`, `node-tap`?
+
+Mocha requires you to use implicit globals like `describe` and `it`, too unopinionated, bloated, synchronous by default, serial test execution, and slow. Tape and node-tap are pretty good. AVA is highly inspired by their syntax. However, they both execute tests serially and they've made [TAP](https://testanything.org) a first-class citizen which has IMHO made their codebases a bit convoluted and coupled. TAP output is hard to read so you always end up using an external tap reporter. AVA is highly opinionated and concurrent. It comes with a default simple reporter and will in the future support TAP through a reporter.
 
 
 ## License
 
 MIT © [Sindre Sorhus](http://sindresorhus.com)
+
+
+<div align="center">
+	<br>
+	<br>
+	<br>
+	<img src="https://cdn.rawgit.com/sindresorhus/ava/fe1cea1ca3d2c8518c0cc39ec8be592beab90558/media/logo.svg" width="200" alt="AVA">
+	<br>
+	<br>
+</div>
+

media/logo.ai

@@ -1,5 +1,6 @@
 'use strict';
 var test = require('tape');
+var Promise = require('pinkie-promise');
 var ava = require('../lib/test');
 var Runner = require('../lib/runner');
 
@@ -292,3 +293,53 @@ test.skip('skip test with `.skip()`', function (t) {
 		t.end();
 	});
 });
+
+function promisePass() {
+	return new Promise(function (resolve) {
+		setImmediate(resolve);
+	});
+}
+
+function promiseFail() {
+	return new Promise(function (resolve, reject) {
+		setImmediate(function () {
+			reject(new Error('unicorn'));
+		});
+	});
+}
+
+test('promise support - assert pass', function (t) {
+	ava(function (a) {
+		return promisePass().then(function () {
+			a.pass();
+		});
+	}).run(function () {
+		t.is(this.assertCount, 1);
+		t.end();
+	});
+});
+
+test('promise support - assert fail', function (t) {
+	ava(function (a) {
+		return promisePass().then(function () {
+			// TODO: replace with `a.fail()` when it's available
+			a.true(false);
+		});
+	}).run(function (err) {
+		t.true(err);
+		t.is(err.name, 'AssertionError');
+		t.end();
+	});
+});
+
+test('promise support - reject', function (t) {
+	ava(function (a) {
+		return promiseFail().then(function () {
+			a.pass();
+		});
+	}).run(function (err) {
+		t.true(err);
+		t.is(err.name, 'AssertionError');
+		t.end();
+	});
+});