Data.Registry.Options.FieldConfiguration

Configuration of fields from field names given as singleton string types For example in the `Parser "myField" MyType myField is used to create an option name like --my-field (by default)

Documentation

data FieldConfiguration

These options are used at runtime to take a field name and build its short/long name + metavar

Constructors

FieldConfiguration

Fields

• makeShortName :: Text -> Char

  make a short name from a field name. For example "force" -> 'f'

• makeLongName :: Text -> Text

  make a long name from a field name. For example "forceCopy" -> 'force-copy'

• makeMetavar :: Text -> Text

  describe the type of a field from its name. For example "sourceFile" -> File

defaultFieldConfiguration :: FieldConfiguration

The default options are taking a Package1.Package2.camelCase name and - creating a short name = "c" - creating a long name = "camel-case" - creating a metavar = CAMELCASE