Parses hledger flags
> parse('-f ledger.journal bal -M')
{
command: 'balance',
file: 'ledger.journal',
query: [],
monthly: true
}
Parses flags for hledger. Knows most of hledger's flag aliases and other quirks.
Options for rminimist.
> OPTIONS.boolean
[ 'ignore-assertions', 'cleared', 'pending', ... ]
> OPTIONS.string
[ 'file', 'begin', 'end', ... ]
> OPTIONS.alias
{ f: 'file', b: 'begin', e: 'end', ... }
parse(string)
Parses a string into a Ledger Flags object.
> parse('-f ledger.journal bal -M')
{
command: 'balance',
file: 'ledger.journal',
query: [],
monthly: true
}
The return value is an object that always has the following fields:
command (String) - the command to be executedquery (Array) - query to runAll other attributes are derived from the flags.
normalizeCommand(cmd)
Normalizes a command based on aliases.
> normalizeCommand('reg')
'register'
> normalizeCommand('bal')
'balance'
toString(flags)
Converts Ledger Flags back into string.
> args = parse('bal -f ledger.journal -M');
> toString(args)
'balance --file ledger.journal --monthly'
parseMany(strings...)
Parses many arguments.
> args = parseMany('-f ledger.journal', 'bal -M');
> toString(args)
'balance --file ledger.journal --monthly'
hledger-flags © 2016+, Rico Sta. Cruz. Released under the MIT License.
Authored and maintained by Rico Sta. Cruz with help from contributors (list).
ricostacruz.com · GitHub @rstacruz · Twitter @rstacruz