Runnable-exports NPM

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