Super light-weight --argument value parser, with --bool key support
npm install nano-argv
A small module to do simple argument parsing.
When you do this on the command line...:
``
$ node myscript.js --arg1 value1 --bool1 --arg2 value2 --BOOL2
Then you can do this in myscript.js...:
`
var args = require('nano-argv');
var CLI_ARGS = args({
arg2: 'willBeOverridden',
arg3: 'aDefaultValue',
bool3: true
});
console.log(CLI_ARGS);
/*
Will log:
{
arg1: 'value1',
arg2: 'value2',
arg3: 'aDefaultValue',
bool1: true,
bool2: true,
bool3: true
}
*/
`
That is...:
- All --keys on the CLI will be lowercased when output in the arguments hash by the module.--key value
- Any pairing will set the value of key key to value value in the hash returned from the function--key1 --key2 value
- Any sequence, that is, where --key1 has another --key2 flag immediately to the right, will make --key1 a boolean argument flag set to true
- Any with no value to the right, and no other key (it is the last piece of the command) will also be treated as a boolean argument with the flag set to true
- If you pass an object into the function in the JS, those will be used as the for the output object of the function.defaults
- If you do not pass anything, is simply set to {} and no keys will have defaults.defaults
- The argument you use in the JS can only handle plain JSON objects, that is, no function values will work, prototype` keys will not be inherited, and so on and so forth.