xo-init
Version:
Add XO to your project
67 lines (39 loc) • 1 kB
Markdown
# xo-init [](https://travis-ci.org/xojs/xo-init)
> Add [XO](https://github.com/xojs/xo) to your project
## Install
```
$ npm install xo-init
```
## Usage
```js
const xoInit = require('xo-init');
xoInit().then(() => {
console.log('done');
});
```
## API
### xoInit([options])
Returns a `Promise`.
#### options
#### cwd
Type: `string`<br>
Default: `process.cwd()`
Current working directory.
#### args
Type: `Array`<br>
Default: CLI arguments *(`process.argv.slice(2)`)*
Options to put in [XO's config](https://www.npmjs.com/package/xo#config) in `package.json`.
For instance, with the arguments `['--space', '--env=node']` the following will be put in `package.json`:
```json
{
"name": "awesome-package",
"xo": {
"space": true,
"envs": ["node"]
}
}
```
## CLI
Install XO globally `$ npm install --global xo` and run `$ xo --init [<options>]`.
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)