impulse-bin

CLI module runner

impulse-bin

node.js CLI module runner

  • CLI scripts that are easier to test without running the executable.
  • Reduce boilerplate.

Executables are reduced to thin loading calls.

var bin = require('impulse-bin').create();
bin.run(require('commander'), require('./lib/cli/myproj'));
 
// Or if your CLI module's run() function is a generator: 
bin.runGenerator(require('commander'), require('./lib/cli/myproj'));

While the rest is separated into input parsing and input consumption.

  • init() receives a CLI input provider like commander.js or node-optimist for you to configure.
  • run() receives the parsed this.options and this.args from the provider.
exports.init = function(provider) {
  provider.option('-c, --config <dir>', 'Config file');
};
 
exports.run = function() {
  this.exitOnMissingOption(['config']);
 
  this.stdout('using config file: %s', this.clc.green(this.options.config));
 
  // ... 
};
// bin/myproj 
bin.run(require('commander'), require('./lib/cli/myproj'), 1, 2, 3);
 
// lib/cli/myproj.js 
exports.run = function() {
  console.log([].slice.call(arguments)); // [1, 2, 3] 
};

NPM

npm install impulse-bin

MIT

npm test