minirocket

Quick scaffold for cli tool development


Keywords
minimist, cli, minimisted, cli-dispatch, actions
License
MIT
Install
npm install minirocket@2.0.0

Documentation

minirocket v2.0.0

CircleCI codecov js-standard-style

Quick scaffold for cli tool development.

Install

npm install minirocket

Usage

First set up the directory like the following:

bin/
├── main.js
└── actions
    ├── foo.js
    ├── bar.js
    └── baz.js

Then in main.js:

const argv = require('minimist')(process.argv.slice(2))
const minirocket = require('minirocket')

minirocket({
  foo: argv.foo,
  bar: argv.bar,
  [argv._.[0]]: true
}, actionFunc => {
  actionFunc(argv)
}).on('no-action', action => {
  console.log(`No such action: ${action}`)
})

actions/foo.js:

module.exports = () => console.log('foo!')

actions/bar.js:

module.exports = ({name}) => console.log(`Hello, ${name}!`)

actions/baz.js:

module.exports = () => console.log('baz')

Then, main.js works like the following:

$ node main.js --foo
foo!
$ node main.js --bar --name John
Hello, John!
$ node main.js baz
baz!
$ node main.js spam
No such action: spam

API

const minirocket = require('minirocket')

minirocket(actionDefinition, options)

  • @param {object} actionDefinition The definition of the action selection
  • @param {object} options The options
  • @param {Function} callback The callback of the action
  • @param {string} [options.actions] The directory under which it look for the action files. Default is {minirocket's callers dir}/actions.
  • @return {Minirocket} Minirocket class instance

This invokes the action function with the given argv.

actionDefinition is an object. The each key should have a boolean value. The first key which has true (or truthy value) is chosen as the action name. If none of the keys have truthy values then it throws an error.

Then it look for the .js file under the ./actions directory (this is configurable by the options.actions). If it finds the actionName.js, then requires it and passes it to the given callback function. If it cannot find it, then it emits 'no-action' event.

no-action event

no-action event is emitted on Minirocket object with the value of the given action name.

Example

License

MIT