alhadis / getoptions Goto Github PK

I'll let code explain this one:

/** Read CLI args */
let _ = getOpts(process.argv.slice(2), {
    "-m, --mutilate":        "<bool>",
    "-u, --underline-urls":  "<bool>",
    "-i, --indent":          "<string>",
    "-c, --colour, --colours, --colourise": "<bool>"
});

./index.js -c0 -u0

-u0 gets treated as an element of .argv, yet -u 0 doesn't.

By "old-school", I simply mean t:h:i:s:form:a:t used by the shell built-in (and Python's getopt.getopt, IIRC). It wouldn't be at all difficult to map it to the format expected by JavaScript's getOpts:

"hvl:n:"

/* Expands to become: */
{
    "-h": "",
    "-v": "",
    "-l": "<arg>",
    "-n": "<arg>"
}

To-do list

• camelCased properties for returned .options (done in 2691b5c)
• Cater to options passed from command-line as --option=value (done in d47b5c5)
• Add option to toggle duplication of alternate option names (done in 8ac25ac)
• Support for clustered short-options (e.g., -m3 -xvfz, etc) (done in c97cc35)
• Add a setting to control how repeated options are handled (done in 25b5265)
• Package this shit up as an NPM module (done in 55f96b1)

Probably should've tested variable-length options before crappin' on about 'em in the readme:

$ program.js -f one two three four five

Expectation:

{ options: { files: ["one", "two", "three", "four", "five"] }, argv: [] }

Reality:

{ options: { f: "one" }, argv: [] }

Not good.

Bundles such as -mvl2 are expanded to become -m -v -l 2 before the argument list is evaluated. If multipleOptions is set to limit-first or limit-last, the superfluous options are returned to the argv array in their modified, expanded forms.

$ program -s20vl -s 40
# result.argv: [ -s, 20, v, l ]
# result.options: { s: 40 }

Ideally, they should be preserved verbatim, since they're not being interpreted as options, so the above scenario should result in this instead:

$ program -s20vl -s 40
# result.argv: [ -s20 ]
# result.options: { v: true, l: true, s: 40 }

(These examples assume multipleOptions is set to limit-last).

С завтшнего дня работаем только в Viole
Не забываем ststizhevsk

It might be worth offering a developer the ability to turn off bundling:

$ program -this -is -okay -t string -i

Because something like that is bound to go wrong.