base-runner

Orchestrate multiple instances of base at once.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
base-runner
520.9.27 years ago9 years agoMinified + gzip package size for base-runner in KB

Readme

base-runner NPM version NPM monthly downloads NPM total downloads Linux Build Status
Orchestrate multiple instances of base at once.

Install

Install with npm:
$ npm install --save base-runner

Usage

var runner = require('base-runner');
var Base = require('base');

runner(Base, options, argv, function(err, app, runnerContext) {
  // `err`: error object, if an error occurred
  // `app`: instance of `base` 
  // `runnerContext`: object with `argv`, `env` and `options` properties
});

Params
  • Base - (required) base constructor
  • options - (required) configuration options
  • argv - (required) parsed process.argv object from minimist or whatever argv parser you prefer.

Example

var runner = require('base-runner');
var Base = require('base');
var config = {
  name: 'awesome',
  cwd: process.cwd(),
  runner: require('./package.json'),
  processTitle: 'awesome',
  moduleName: 'awesome',
  extensions: {
    '.js': null
  }
};

runner(Base, options, argv, function(err, app, runnerContext) {
  // `err`: error object, if an error occurred
  // `app`: instance of `base` 
  // `runnerContext`: object with `argv`, `env` and `options` properties
});

API

runner

Create a runner with the given constructor, liftoff config object, argv object and callback function.
Params
  • Ctor {Function}: Constructor to use, must inherit base.
  • config {Object}: The config object to pass to liftoff.
  • argv {Object}: Argv object, optionally pre-parsed.
  • cb {Function}: Callback function, which exposes err, app (base application instance) and runnerContext
  • returns {Object}

Example
var Base = require('base');
var argv = require('minimist')(process.argv.slice(2));
var config = {
  name: 'foo',
  cwd: process.cwd(),
  extensions: {'.js': null}
};

runner(Base, config, argv, function(err, app, runnerContext) {
  if (err) throw err;
  // do stuff with `app` and `runnerContext`
  process.exit();
});

Events

The following constructor events are emitted:

preInit

Exposes runnerContext as the only paramter.
Base.on('preInit', function(runnerContext) {
});

init

Exposes runnerContext and app (the application instance) as paramters.
Base.on('init', function(runnerContext, app) {
});

postInit

Exposes runnerContext and app (the application instance) as paramters.
Base.on('postInit', function(runnerContext, app) {
});

finished

Exposes runnerContext and app (the application instance) as paramters.
Base.on('finished', function(runnerContext, app) {
});

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

| Commits | Contributor | | --- | --- | | 239 | jonschlinkert | | 2 | doowb | | 1 | tunnckoCore |

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert
. Released under the MIT License.

This file was generated by verb-generate-readme
, v0.6.0, on July 18, 2017.