ofi
v1.3.4
Published
Yet another arguments parser
Downloads
44
Maintainers
Readme
ofi
Yet another argument parser.
A tiny cli flags parser.
Install
npm i ofi
Usage
Import:
// ESM
import { parse } from 'ofi';
// CJS
const { parse } = require('ofi');
Setup options parser:
import { parse } from 'ofi';
parse(process.argv.slice(2), {
number: ['size'],
string: ['foo', 'name', 'surname'],
boolean: ['dice', 'friendly'],
array: ['list', 'my-numbers'],
alias: { foo: ['f'] },
default: { surname: 'obama', list: [] }
});
This would give the following results:
$ node program.js --size=3 --name barack -f baz --no-dice --friendly
{
_: [],
size: 3,
name: 'barack',
surname: 'obama',
foo: 'baz',
dice: false,
list: [],
friendly: true
}
$ node program.js --list a b c -N hi there --myNumbers=13,1,2,3 -fas
{
_: ['hi', 'there'],
surname: 'obama',
list: [ 'a', 'b', 'c' ],
N: true,
'my-numbers': [ 13, 1, 2, 3 ],
foo: true,
a: true,
s: true
}
API
parse(arguments, options?)
Function that parses given arguments.
Returns an argument object argv
which contains all parsed flags.
argv._
includes all arguments that weren't associated with any option.
Any argument after --
(end-of-flags) won't be parsed and will end up in argv._
and argv['--']
if populate--
option is set to true
.
arguments
Type: String | Array<String>
String or an array of strings to be parsed.
For example:
import { parse } from 'ofi';
parse(process.argv.slice(2));
options
Type: Object
Options for parsing given arguments.
boolean
Arguments that should be parsed as booleans.
Type: String | Array<String>
{ boolean: ['dice'] }
Booleans prefixed with --no
will be treated as negations.\
string
Arguments that should be parsed as strings.
Type: String | Array<String>
{ string: ['name'] }
number
Arguments that should be parsed as numbers.
Type: String | Array<String>
{ number: ['age'] }
array
Arguments that should be parsed as arrays.
Type: String | Array<String>
{ array: ['list'] }
default
Set default values.
Type: Object
{ default: { name: 'joe' } }
alias
Set aliases of options.
Type: Object
{ alias: { foo: ['f'], baz: 'b' } }
populate--
Populate '--'
property in Argv
with everything after double-dash (--
, aka. end-of-flags).
Type: Boolean
Default: false
parseNumber
Should values that look like numbers be parsed into them.
Type: Boolean
Default: true
NOTE: This doesn't apply to flags marked as strings.
shortFlagGroup
Should a group of short options be treated as seperate flags.
Example: -abc
-> { a: true, b: true, c: true }
Type: Boolean
Default: true
camelize
Convert results to camel-case.
Type: Boolean
Default: false
coerce
Custom synchronous function for parsing provided argument.
Type: Object
Default: undefined
{ coerce: { len: (arg) => arg + ' cm' } }
unknown
Callback function that runs whenever a parsed flag has not been defined in options.
Type: Function
Default: undefined
{ unknown: function (flag) { console.log('Unknown flag: "%s"', flag); } }
License
MIT 💖