Moo.Core

Documentation

type AppT a = ReaderT AppState IO a

The monad in which the application runs.

type CommandHandler = StoreData -> AppT ()

The type of actions that are invoked to handle specific commands

data CommandOptions

CommandOptions are those options that can be specified at the command prompt to modify the behavior of a command.

Constructors

CommandOptions

Fields

_configFilePath :: Maybe String

_test :: Bool

_noAsk :: Bool

data Command

A command has a name, a number of required arguments' labels, a number of optional arguments' labels, and an action to invoke.

Constructors

Command

Fields

_cName :: String

_cRequired :: [String]

_cOptional :: [String]

_cAllowedOptions :: [String]

_cDescription :: String

_cHandler :: CommandHandler

data AppState

Application state which can be accessed by any command handler.

Constructors

AppState

Fields

_appOptions :: CommandOptions

_appCommand :: Command

_appRequiredArgs :: [String]

_appOptionalArgs :: [String]

_appStore :: MigrationStore

_appDatabaseConnStr :: DbConnDescriptor

_appDatabaseType :: String

_appStoreData :: StoreData

_appLinearMigrations :: Bool

_appTimestampFilenames :: Bool

data Configuration

Constructors

Configuration

Fields

_connectionString :: String

_databaseType :: String

_migrationStorePath :: FilePath

_linearMigrations :: Bool

_timestampFilenames :: Bool

Instances

Show Configuration

newtype DbConnDescriptor

Constructors

DbConnDescriptor String

databaseTypes :: [(String, String -> IO Backend)]

The values of DBM_DATABASE_TYPE and their corresponding connection factory functions.

envDatabaseName :: String

envDatabaseType :: String

envLinearMigrations :: String

envStoreName :: String

loadConfiguration :: Maybe FilePath -> IO (Either String Configuration)

Loads config file (falling back to default one if not specified) and then overrides configuration with an environment.