ava-earl/README.md

AVA CLI for Earl Grey test files.

# ava-earl

[![Earl Grey][earl-grey-badge]][earl-grey-link]
[![npm package][npm-ver-link]][releases]
[![][dl-badge]][npm-pkg-link]
[![][mit-badge]][mit]

A CLI replacement for [AVA](https://github.com/sindresorhus/ava) that works for AVA tests written in [Earl Grey](earl-grey-link)

## Install
```
npm i -D ava-earl
```

## Usage
Add a test file:
```earl-grey
require-macros: ava-earl -> {test, serial-test}

serial-test .baz:
   @false(1 == 2)
   @not("hello", "world")
   @end()

test .foo:
   @pass()
   @end()

test .bar:
   @plan(2)

   set-timeout(fn, 100) where fn = ->
      @equals(.bar, .bar)
      @same({.a, .b}, {.a, .b})
```
Add `ava-earl` to your `package.json` scripts:
```js
{
  "scripts": {
    "test": "agave"
  }
}
```
> `ava-earl`'s executable is called `agave` because it's memorable and has all the letters of `ava` and the initials of Earl Grey.

Then run it:
```sh
$ npm test
```
## Differences
The executable will only search for `.eg` files.  If you want to use `ava` with JavaScript files then use `ava` directly.  Currently `ava-earl` does not support running some tests in Earl Grey and others in JavaScript.

The macro allows you to write tests using the `@` symbol to represent `t` and it fills out the function details behind the scenes.  It also aliases several functions that are builtins for Earl Grey:

in `ava`  | in `ava-earl`
----------|-----------
`is`      | `equals`
`not`     | `nequals`
`true`    | `is-true`
`false`   | `is-false`
`pass`    | `passes`

Currently it only supports named tests and the minimal amount of boilerplate already here makes me feel that it's really unnecessary to go any further.  Not to mention, there might be some added complexity with supporting the named function format.

## Documentation
To learn more about `ava` check out their [documentation](https://github.com/sindresorhus/ava#documentation).

## License

[MIT][mit] © [Jake Russo][author] et [al][contributors]

[mit]:          http://opensource.org/licenses/MIT
[author]:       http://github.com/MadcapJake
[contributors]: https://github.com/MadcapJake/ava-earl/graphs/contributors
[releases]:     https://github.com/MadcapJake/ava-earl/releases
[earl-grey-badge]: https://img.shields.io/badge/Earl-Grey-lightgrey.svg?style=flat-square
[earl-grey-link]:  https://breuleux.github.io/earl-grey/
[mit-badge]: https://img.shields.io/badge/license-MIT-444444.svg?style=flat-square
[npm-pkg-link]: https://www.npmjs.org/package/ava-earl
[npm-ver-link]: https://img.shields.io/npm/v/ava-earl.svg?style=flat-square
[dl-badge]: http://img.shields.io/npm/dm/ava-earl.svg?style=flat-square