Changelogged.Options

Documentation

availableWarningFormats :: [WarningFormat]

>>> availableWarningFormats
[simple,suggest]

availableWarningFormatsStr :: String

>>> availableWarningFormatsStr
"'simple' or 'suggest'"

readWarningFormat :: ReadM WarningFormat

availableLevels :: [Level]

>>> availableLevels
[App,Major,Minor,Fix,Doc]

availableLevelsStr :: String

>>> availableLevelsStr
"'app', 'major', 'minor', 'fix' or 'doc'"

prettyPossibleValues :: Show a => [a] -> String

readLevel :: ReadM Level

parser :: Parser Options

welcome :: Description

data Options

Command line options for changelogged.

Constructors

Options

Fields

• optFormat :: WarningFormat

  Format for missing changelog entry warnings.

• optUpdateChangelog :: Bool

  Add missing changelog entries to changelog files.

• optBumpVersions :: Bool

  Bump versions in version files.

• optChangeLevel :: Maybe Level

  Level of changes (to override one inferred from changelogs).

• optFromBC :: Bool

  Look for missing changelog entries from the start of the project.

• optForce :: Bool

  Bump versions ignoring possibly outdated changelogs.

• optNoCheck :: Bool

  Do not check if changelogs have any missing entries.

parseOptions :: IO Options

Parse command line options.