lasalefamine / runnable-exports

Run your exports as command line arguments

runnable-exports

Run your exports as command line arguments

If you want to easily create a command line tool from a file and a bunch of exported functions.

Install

$ yarn add runnable-exports

Usage

// your-file.js
const runnableExports = require('runnable-exports')
module.exports.awesome = ...args => {
	console.log('Awesome', args)
}
runnableExports()

And simply

$ node your-file.js awesome and nice arguments

Output

Awesome ['and', 'nice', 'arguments']

ObjectArgs

// your-file.js
const runnableExports = require('runnable-exports')
module.exports.awesome = args => {
	console.log('Awesome', args)
}
runnableExports()

Under the hood yargs is used, so you can pass easily also objectArgs like so

$ node your-file.js awesome --nice

Output

Awesome {nice: true}

NOTE: the module accepts both types of args, the object args will be the first arg passed to the called function, all other args will follow from this

Test

XO and AVA

$ yarn test

Related

This is a fork of make-runnable

License

MIT © LasaleFamine

runnable-exports's Issues

Error when no function specified

Firstly, thanks for the repo, I really like your module and it's exactly the sort of thing I was looking for.

Unfortunately, if the user runs the JS file without specifying a function they get this error: Error: RUNNABLE-EXPORTS: can't run your command:

It would be nice if it instead suggested to the user which commands can be run, similar to the original make-runnable project. Currently the output is a bit ugly especially if it's being used in production. Even if this was a configurable option that would be great.