Node.Yargs.Setup

data YargsSetup :: Type

A value which can be used to configure the yargs module.

The Semigroup and Monoid instances can be used to combine the various options, which are made available as functions by this module:

setup = fold
  [ usage "$0 -w Word1 -w Word2"
  , example "$0 -w Hello -w World" "Say hello!"
  ]

Instances

• Semigroup YargsSetup
• Monoid YargsSetup

usage :: String -> YargsSetup

Provide a usage message.

example :: String -> String -> YargsSetup

Provide an example command and description.

alias :: String -> String -> YargsSetup

demand :: String -> String -> YargsSetup

demandCount :: Int -> String -> YargsSetup

requiresArg :: String -> YargsSetup

describe :: String -> String -> YargsSetup

boolean :: String -> YargsSetup

string :: String -> YargsSetup

config :: String -> YargsSetup

wrap :: Number -> YargsSetup

strict :: YargsSetup

help :: String -> String -> YargsSetup

defaultHelp :: YargsSetup

Will make --help the option to trigger help output

version :: String -> String -> String -> YargsSetup

defaultVersion :: YargsSetup

Tries to find your package.json and parse the "version" field Will make --version the option to trigger version output

showHelpOnFail :: Boolean -> String -> YargsSetup