Cartel.Betsy

Public interface for Betsy, the Cartel flag maker. Simply re-exports safe bindings from Cartel.Betsy.Internal.

Documentation

data FlagName

The name of a flag. Only makeFlag creates flags; it will return a FlagName to you. You can then use that FlagName in a conditional using flag.

Instances

Eq FlagName

Ord FlagName

Show FlagName

Renderable FlagName

RenderableIndented [(FlagName, FlagOpts)]

RenderableIndented (FlagName, FlagOpts)

flagNameHead :: FlagName -> Char

flagNameTail :: FlagName -> String

data FlagOpts

Options for flags, except for the flag's name.

Constructors

FlagOpts

Fields

flagDescription :: String

A one-line description of what the flag does; this is optional.

flagDefault :: Bool

Is this flag on or off by default?

flagManual :: Bool

If a flag is manual, Cabal will not change its value. If a flag is not manual, Cabal will change its value automatically to attempt to satisfy the package's dependencies.

Instances

Eq FlagOpts

Ord FlagOpts

Show FlagOpts

RenderableIndented [(FlagName, FlagOpts)]

RenderableIndented (FlagName, FlagOpts)

data Betsy m a

Computations that can create and use Cabal flags. Use of this type, along with the defaultMain function ensures that any FlagName you use has been properly set up by using makeFlag. That way, you don't use flags in a flag without actually declaring the flag. When defaultMain creates your Cabal file, it will print the necessary Flag sections.

Betsy is parameterized on a type, m. When this type is a monad, Betsy is also a monad, allowing you to use use the usual monad combinators and do notation. Betsy is also a monad transformer.

Instances

MonadTrans Betsy

Monad m => Monad (Betsy m)

Functor m => Functor (Betsy m)

(Monad m, Functor m) => Applicative (Betsy m)

MonadIO m => MonadIO (Betsy m)

data Error

Errors that may result from running a Betsy computation.

Constructors

DuplicateFlag FlagName

The user requested creation of a duplicate flag.

Failed String

fail was invoked.

EmptyFlagName

The user requested creation of a flag with an empty name.

Instances

Eq Error

Ord Error

Show Error

RenderableIndented Error

runBetsy

Arguments

:: Functor m

=> Betsy m a

-> m (Either Error (a, [(FlagName, FlagOpts)]))

Returns Left if the making of a flag failed. Otherwise, returns the result of the computation, along with a list of all flags made.

makeFlag

Arguments

:: Applicative m

=> NonEmptyString

Name of flag

-> FlagOpts

Options for the flag

-> Betsy m FlagName

This operation will fail if there is already a flag with the name you gave.

Creates new flags.

currentFlags :: Applicative f => Betsy f [(FlagName, FlagOpts)]

Returns a list of all flags made so far.