Vorpal Boilerplate

A boilerplate for creating awesome Vorpal apps.

Contents

• Vorpal
• ESLint
• Airbnb ESLint Config
• Mocha
• Chai
• Sinon
• NYC
• Husky
• .travis.yml file for Travis CI integration

How to use

• Fork this repo
• Rename your local repo, change project info in package.json, etc.
• Place your Vorpal Commands modules into the commands folder.
• Each module should expose a function that takes a Vorpal instance.
• Add the commands you want for that module!
• Husky is setup to run tests and lint the code.
• Run npm run test-local to test your code.
• Run npm start to start your app.
• If you want to setup Coveralls just go ahead to your Travis CI project and add the COVERALLS_REPO_TOKEN to your env vars.

Example

module.exports = (cli) => {
    cli.command('hello', 'echos your hello').action((args, callback) => {
        // ...
    });

    cli.command('world', 'echos your world').action((args, callback) => {
        // ...
    });
}

The index.js will dynamically require all the command files inside the commands folder!