akutz / gotopt

69%

master: 69%

push

travis-ci

Adds Usage functions

This patch adds the ability for a Parser to generate usage text for the
options it will parse. Usage text can be returned as a string or printed
to an io.Writer with or without leading indentation. For example:

    p := NewParser()
    p.Opt('n', "name", NoArgument, "",
        "A flag indicating the name is a trailing arg")
    p.Opt('t', "time", RequiredArgument, "epoch", "The epoch")
    p.Opt('x', "xist", OptionalArgument, "val",
        "A value with the answer to our existence")
    p.Opt(0, "play", NoArgument, "", "Whether or not it's time to play")
    p.Opt(0, "fast", OptionalArgument, "mph", "How fast to go")
    p.Opt(0, "slow", RequiredArgument, "mph", "How slow to go")
    p.Opt('h', "", RequiredArgument, "00-23", "The current hour")
    p.Opt('o', "", OptionalArgument, "asc|desc", "The current order")
    p.Opt('z', "", NoArgument, "",
        "Drop the zero, and get with the hero")

    p.PrintUsage(os.Stdout)

The above snippet will emit the following to Stdout:

        -n, --name       A flag indicating the name is a trailing arg
        -t, --time epoch The epoch
        -x, --xist [val] A value with the answer to our existence
            --play       Whether or not it's time to play
            --fast [mph] How fast to go
            --slow mph   How slow to go
        -h 00-23         The current hour
        -o [asc|desc]    The current order
        -z               Drop the zero, and get with the hero

121 of 121 new or added lines in 1 file covered. (100.0%)

755 of 1088 relevant lines covered (69.39%)

0.69 hits per line