HelpFlag

The names of the product elements

The name of the type

The mirrored *-type

Create a new instance of type T with elements taken from product p.

Checks if flags to trigger this Flag are present in the provided Command arguments

A partial function that will take the String value of the passed argument, and convert it to type F.

Typical usage might be for parsing String to Int/Float/Custom Domain, e.g. for a Flag[Int], parse = str => str.toInt.

Advanced usage could be used to do more targeted work as well, such as processing the argument directly, versus simply obtaining the value for it to be parsed later, e.g. for a Flag[String], parse = str => str.toUpperCase

A method that will find the first instance of an argument triggering this Flag, if present, and evaluate the parseArgument partial function on it.

Most useful when this Flag is expected once.

Finds instances of arguments that trigger this Flag, and processes them through parseArgument

A method to remove the flag trigger, and any arguments, from the input args, so that positional Args can then be processed

A description of the purpose of this flag, used in documentation.

The name of the flag, e.g. "help". This will be parsed as s"--$name", e.g. "--help"

A short-key version of name, e.g. "h". This will be parsed as s"-$shortKey", e.g. "-h"

Indicates this Flag expects an argument. Defaults to true.