Safe Haskell	None
Language	GHC2021

Shrun.Configuration.Data.Core

Contents

Types
Functions

Synopsis

data CoreConfigP (p :: ConfigPhase) notifyEnv = MkCoreConfigP {
- init :: ConfigPhaseDisabledMaybeF p Text
- legendKeysCache :: LegendKeysCacheF p
- timeout :: TimeoutF p
- commonLogging :: TomlOptF p (CommonLoggingP p)
- commandLogging :: TomlOptF p (CommandLoggingP p)
- consoleLogging :: TomlOptF p (ConsoleLoggingP p)
- fileLogging :: ArgsOnlyDetF p (FileLoggingP p)
- notifications :: ArgsOnlyDetF p (NotifyP p notifyEnv)
}
type CoreConfigArgs = CoreConfigP 'ConfigPhaseArgs
type CoreConfigToml = CoreConfigP 'ConfigPhaseToml
type CoreConfigMerged = CoreConfigP 'ConfigPhaseMerged
mergeCoreConfig :: (HasCallStack, MonadCatch m, MonadIORef m, MonadTerminal m) => NESeq CommandP1 -> CoreConfigArgs r -> CoreConfigToml r -> m (CoreConfigMerged r)
withCoreEnv :: (HasCallStack, MonadAtomic m, MonadFileWriter m, MonadHandleWriter m, MonadMask m, MonadNotify m, MonadPathReader m, MonadPathWriter m, MonadPosixFiles m, MonadTerminal m, NotifyEnvF m ~ r) => CoreConfigMerged r -> (CoreConfigEnv r -> m a) -> m a

Types

data CoreConfigP (p :: ConfigPhase) notifyEnv Source #

Holds core configuration data.

Constructors

MkCoreConfigP

Fields

init :: ConfigPhaseDisabledMaybeF p Text
Shell logic to run before each command.
legendKeysCache :: LegendKeysCacheF p
Whether to save legend keys.
timeout :: TimeoutF p
Timeout.
commonLogging :: TomlOptF p (CommonLoggingP p)
Holds common logging config.
commandLogging :: TomlOptF p (CommandLoggingP p)
Command log config.
consoleLogging :: TomlOptF p (ConsoleLoggingP p)
Holds console logging config.
fileLogging :: ArgsOnlyDetF p (FileLoggingP p)
File log config.
notifications :: ArgsOnlyDetF p (NotifyP p notifyEnv)
Notify config.

Instances

Instances details

(k ~ A_Lens, a ~ TomlOptF p (CommandLoggingP p), b ~ TomlOptF p (CommandLoggingP p)) => LabelOptic "commandLogging" k (CoreConfigP p r) (CoreConfigP p r) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p r) (CoreConfigP p r) a b Source #
(k ~ A_Lens, a ~ TomlOptF p (CommonLoggingP p), b ~ TomlOptF p (CommonLoggingP p)) => LabelOptic "commonLogging" k (CoreConfigP p r) (CoreConfigP p r) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p r) (CoreConfigP p r) a b Source #
(k ~ A_Lens, a ~ TomlOptF p (ConsoleLoggingP p), b ~ TomlOptF p (ConsoleLoggingP p)) => LabelOptic "consoleLogging" k (CoreConfigP p r) (CoreConfigP p r) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p r) (CoreConfigP p r) a b Source #
(k ~ A_Lens, a ~ ArgsOnlyDetF p (FileLoggingP p), b ~ ArgsOnlyDetF p (FileLoggingP p)) => LabelOptic "fileLogging" k (CoreConfigP p r) (CoreConfigP p r) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p r) (CoreConfigP p r) a b Source #
(k ~ A_Lens, a ~ ConfigPhaseDisabledMaybeF p Text, b ~ ConfigPhaseDisabledMaybeF p Text) => LabelOptic "init" k (CoreConfigP p r) (CoreConfigP p r) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p r) (CoreConfigP p r) a b Source #
(k ~ A_Lens, a ~ LegendKeysCacheF p, b ~ LegendKeysCacheF p) => LabelOptic "legendKeysCache" k (CoreConfigP p r) (CoreConfigP p r) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p r) (CoreConfigP p r) a b Source #
(k ~ A_Lens, a ~ ArgsOnlyDetF p (NotifyP p r), b ~ ArgsOnlyDetF p (NotifyP p r)) => LabelOptic "notifications" k (CoreConfigP p r) (CoreConfigP p r) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p r) (CoreConfigP p r) a b Source #
(k ~ A_Lens, a ~ TimeoutF p, b ~ TimeoutF p) => LabelOptic "timeout" k (CoreConfigP p r) (CoreConfigP p r) a b Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods labelOptic :: Optic k NoIx (CoreConfigP p r) (CoreConfigP p r) a b Source #
Monoid (CoreConfigToml r) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods mempty :: CoreConfigToml r # mappend :: CoreConfigToml r -> CoreConfigToml r -> CoreConfigToml r # mconcat :: [CoreConfigToml r] -> CoreConfigToml r #
Semigroup (CoreConfigToml r) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods (<>) :: CoreConfigToml r -> CoreConfigToml r -> CoreConfigToml r # sconcat :: NonEmpty (CoreConfigToml r) -> CoreConfigToml r # stimes :: Integral b => b -> CoreConfigToml r -> CoreConfigToml r #
Pretty (CoreConfigMerged r) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods pretty :: CoreConfigMerged r -> Doc ann Source # prettyList :: [CoreConfigMerged r] -> Doc ann Source #
Show (CoreConfigP 'ConfigPhaseArgs r) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods showsPrec :: Int -> CoreConfigP 'ConfigPhaseArgs r -> ShowS # show :: CoreConfigP 'ConfigPhaseArgs r -> String # showList :: [CoreConfigP 'ConfigPhaseArgs r] -> ShowS #
Show (CoreConfigP 'ConfigPhaseMerged r) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods showsPrec :: Int -> CoreConfigP 'ConfigPhaseMerged r -> ShowS # show :: CoreConfigP 'ConfigPhaseMerged r -> String # showList :: [CoreConfigP 'ConfigPhaseMerged r] -> ShowS #
Show (CoreConfigP 'ConfigPhaseToml r) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods showsPrec :: Int -> CoreConfigP 'ConfigPhaseToml r -> ShowS # show :: CoreConfigP 'ConfigPhaseToml r -> String # showList :: [CoreConfigP 'ConfigPhaseToml r] -> ShowS #
Eq (CoreConfigP 'ConfigPhaseArgs r) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods (==) :: CoreConfigP 'ConfigPhaseArgs r -> CoreConfigP 'ConfigPhaseArgs r -> Bool # (/=) :: CoreConfigP 'ConfigPhaseArgs r -> CoreConfigP 'ConfigPhaseArgs r -> Bool #
Eq (CoreConfigP 'ConfigPhaseMerged r) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods (==) :: CoreConfigP 'ConfigPhaseMerged r -> CoreConfigP 'ConfigPhaseMerged r -> Bool # (/=) :: CoreConfigP 'ConfigPhaseMerged r -> CoreConfigP 'ConfigPhaseMerged r -> Bool #
Eq (CoreConfigP 'ConfigPhaseToml r) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods (==) :: CoreConfigP 'ConfigPhaseToml r -> CoreConfigP 'ConfigPhaseToml r -> Bool # (/=) :: CoreConfigP 'ConfigPhaseToml r -> CoreConfigP 'ConfigPhaseToml r -> Bool #
Default (CoreConfigP 'ConfigPhaseArgs r) Source #
Instance details Defined in Shrun.Configuration.Data.Core Methods def :: CoreConfigP 'ConfigPhaseArgs r Source #

type CoreConfigArgs = CoreConfigP 'ConfigPhaseArgs Source #

type CoreConfigToml = CoreConfigP 'ConfigPhaseToml Source #

type CoreConfigMerged = CoreConfigP 'ConfigPhaseMerged Source #

Functions

mergeCoreConfig :: (HasCallStack, MonadCatch m, MonadIORef m, MonadTerminal m) => NESeq CommandP1 -> CoreConfigArgs r -> CoreConfigToml r -> m (CoreConfigMerged r) Source #

withCoreEnv :: (HasCallStack, MonadAtomic m, MonadFileWriter m, MonadHandleWriter m, MonadMask m, MonadNotify m, MonadPathReader m, MonadPathWriter m, MonadPosixFiles m, MonadTerminal m, NotifyEnvF m ~ r) => CoreConfigMerged r -> (CoreConfigEnv r -> m a) -> m a Source #

Given a merged CoreConfig, constructs a ConfigEnv and calls the continuation.