Tests

Install

npm install quasix-getopt

Description

This module provides dependency-free parsing of a simple subset of POSIX command line argument syntax.

This module does not parse POSIX.1-2008 or any other official specification. This module parses the following simple POSIX-like constructs.

Examples

• single-dash arguments: -a

    {
        a: true
    }

• single-dash combined arguments: -zxvpf

    {
        z: true,
        x: true,
        v: true,
        p: true,
        f: true
    }

• single-dash combined arguments with a bare value following: -zxvpf blah.tgz

    {
        z: true,
        x: true,
        v: true,
        p: true,
        f: true,
        _extras: ['blah.tgz']
    }

• single-dash arguments with value: -o data.txt

    {
        o: data.txt
    }

• single-dash arguments with value indicated with equal =: -o=data.txt

    {
        o: data.txt
    }

• double-dash arguments: --verbose

    {
        verbose: true
    }

• double-dash arguments with value: --outfile data.txt

    {
        outfile: data.txt
    }

• double-dash arguments with value indicated with equal =: --outfile=data.txt

    {
        outfile: data.txt
    }

• bare keywords: add default gw 192.168.1.10

    {
        _extras: ['add', 'default', 'gw', '192.168.1.10']
    }

Counter-examples

These syntaxes are not parsed as expected.

• single-dash multi-letter option names, like route's -net argument. Example: route add -net 12.34.0.0 netmask 255.255.0.0 gw 12.34.56.1 Result:

    {
        n: true,
        e: true,
        t: true,
        _extras: ['add', '12.34.0.0', 'netmask', '255.255.0.0', 'gw', '12.34.56.1']
    }

Use

Parse process.argv and return an object with the command line arguments in it. This module does not enforce any required options or value formats. It blindly parses assuming a standardish POSIX format and returns all values passed to the command.

const quasix = require('quasix-getopt')
const options = quasix.parse()