Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

xo-init

xojs27.4kMIT0.7.0

Add XO to your project

❤️, init, initialize, add, create, setup, generate, generator, scaffold, xo

readme

xo-init Build Status

Add XO to your project

Install

$ npm install xo-init

Usage

const xoInit = require('xo-init');

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

API

xoInit([options])

Returns a Promise.

options

cwd

Type: string
Default: process.cwd()

Current working directory.

args

Type: Array
Default: CLI arguments (process.argv.slice(2))

Options to put in XO's config in package.json.

For instance, with the arguments ['--space', '--env=node'] the following will be put in package.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