Refurb.Run.Internal

Module containing shared types and functions used for implementing the various commands.

Documentation

data Context

Reader context for all command execution which contains the command line options, database connection and connection information, and known migrations.

Constructors

Context

Fields

• contextOptions :: Opts

  The Opts structure parsed from the command line by Refurb.Cli.

• contextDbConn :: Connection

  The open database Connection.

• contextDbConnInfo :: ConnInfo

  The information used to connect to the database, required for running command line tools like pg_dump against the same database.

• contextMigrations :: [Migration]

  The known migrations passed in to refurbMain.

type MonadRefurb m = (MonadBaseControl IO m, MonadFail m, MonadMask m, MonadReader Context m, MonadLogger m, MonadLoggerIO m)

Constraint of actions for command execution, including access to the Context, logging, and underlying IO.

optionallyColorM :: MonadRefurb m => m (Doc -> Doc)

Given the configuration implicitly available to MonadRefurb, produce a function which possibly strips ANSI colorization from a Doc if the user requested colorless output.

optionallyColoredM :: MonadRefurb m => m (Doc -> m ())

Given the configuration implicitly available to MonadRefurb, produce a function which emits a Doc on stdout that is colored unless the user requested colorless output.

migrationResultDoc :: MigrationResult -> Doc

Produce a colorized Doc with success or failure, based on which MigrationResult value was passed.