aboutsummaryrefslogtreecommitdiff
path: root/node_modules/ava-init/readme.md
blob: 596d098cbff98302102760db2904ade112614573 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# ava-init [![Build Status: Linux](https://travis-ci.org/avajs/ava-init.svg?branch=master)](https://travis-ci.org/avajs/ava-init) [![Build status: Windows](https://ci.appveyor.com/api/projects/status/abj17qsw0j1rts7l/branch/master?svg=true)](https://ci.appveyor.com/project/ava/ava-init/branch/master)

> Add [AVA](https://ava.li) to your project


## Install

```
$ npm install --save ava-init
```


## Usage

```js
const avaInit = require('ava-init');

avaInit().then(() => {
	console.log('done');
});
```


## API

### avaInit([options])

Returns a `Promise`.

#### options

#### cwd

Type: `string`<br>
Default: `'.'`

Current working directory.

#### args

Type: `Array`<br>
Default: CLI arguments *(`process.argv.slice(2)`)*

For instance, with the arguments `['--foo', '--bar']`, the following will be put in package.json:

```json
{
	"name": "awesome-package",
	"scripts": {
		"test": "ava --foo --bar"
	}
}
```


## CLI

Install AVA globally `$ npm install --global ava` and run `$ ava --init [<options>]`.


## License

MIT © [Sindre Sorhus](https://sindresorhus.com)