Safe Haskell	None
Language	GHC2021

Stack.Types.Runner

Synopsis

data Runner = Runner {
- globalOpts :: !GlobalOpts
- useColor :: !Bool
- logFunc :: !LogFunc
- termWidth :: !Int
- processContext :: !ProcessContext
- dockerEntrypointMVar :: !(MVar Bool)
}
class (HasProcessContext env, HasLogFunc env) => HasRunner env where
- runnerL :: Lens' env Runner
class HasRunner env => HasDockerEntrypointMVar env where
- dockerEntrypointMVarL :: Lens' env (MVar Bool)
globalOptsL :: HasRunner env => Lens' env GlobalOpts
stackYamlLocL :: HasRunner env => Lens' env StackYamlLoc
lockFileBehaviorL :: HasRunner env => SimpleGetter env LockFileBehavior
terminalL :: HasRunner env => Lens' env Bool
reExecL :: HasRunner env => SimpleGetter env Bool
rslInLogL :: HasRunner env => SimpleGetter env Bool
progNameL :: HasRunner env => SimpleGetter env String
mExecutablePathL :: HasRunner env => SimpleGetter env (Maybe (Path Abs File))
viewExecutablePath :: HasRunner env => RIO env (Path Abs File)

Documentation

data Runner Source #

The base environment that almost everything in Stack runs in, based off of parsing command line options in GlobalOpts. Provides logging, process execution, and the MVar used to ensure that the Docker entrypoint is performed exactly once.

Constructors

Runner
Fields globalOpts :: !GlobalOpts useColor :: !Bool logFunc :: !LogFunc termWidth :: !Int processContext :: !ProcessContext dockerEntrypointMVar :: !(MVar Bool)

Instances

Instances details

HasLogFunc Runner Source #
Instance details Defined in Stack.Types.Runner Methods logFuncL :: Lens' Runner LogFunc #
HasProcessContext Runner Source #
Instance details Defined in Stack.Types.Runner Methods processContextL :: Lens' Runner ProcessContext #
HasTerm Runner Source #
Instance details Defined in Stack.Types.Runner Methods useColorL :: Lens' Runner Bool # termWidthL :: Lens' Runner Int #
HasStylesUpdate Runner Source #
Instance details Defined in Stack.Types.Runner Methods stylesUpdateL :: Lens' Runner StylesUpdate #
HasDockerEntrypointMVar Runner Source #
Instance details Defined in Stack.Types.Runner Methods dockerEntrypointMVarL :: Lens' Runner (MVar Bool) Source #
HasRunner Runner Source #
Instance details Defined in Stack.Types.Runner Methods runnerL :: Lens' Runner Runner Source #

class (HasProcessContext env, HasLogFunc env) => HasRunner env where Source #

Class for environment values which have a Runner.

Methods

runnerL :: Lens' env Runner Source #

Instances

Instances details

HasRunner EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods runnerL :: Lens' EnvConfigPathInfo Runner Source #
HasRunner Ctx Source #
Instance details Defined in Stack.Types.Build.ConstructPlan Methods runnerL :: Lens' Ctx Runner Source #
HasRunner BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods runnerL :: Lens' BuildConfig Runner Source #
HasRunner Config Source #
Instance details Defined in Stack.Types.Config Methods runnerL :: Lens' Config Runner Source #
HasRunner DotConfig Source #
Instance details Defined in Stack.Types.DotConfig Methods runnerL :: Lens' DotConfig Runner Source #
HasRunner EnvConfig Source #
Instance details Defined in Stack.Types.EnvConfig Methods runnerL :: Lens' EnvConfig Runner Source #
HasRunner GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods runnerL :: Lens' GetPackageFileContext Runner Source #
HasRunner Runner Source #
Instance details Defined in Stack.Types.Runner Methods runnerL :: Lens' Runner Runner Source #

class HasRunner env => HasDockerEntrypointMVar env where Source #

Class for environment values which have a Docker entrypoint MVar.

Methods

dockerEntrypointMVarL :: Lens' env (MVar Bool) Source #

Instances

Instances details

HasDockerEntrypointMVar Runner Source #
Instance details Defined in Stack.Types.Runner Methods dockerEntrypointMVarL :: Lens' Runner (MVar Bool) Source #

globalOptsL :: HasRunner env => Lens' env GlobalOpts Source #

See the GlobalOpts type.

stackYamlLocL :: HasRunner env => Lens' env StackYamlLoc Source #

See the stackYaml field of the GlobalOpts data constructor.

lockFileBehaviorL :: HasRunner env => SimpleGetter env LockFileBehavior Source #

See the lockFileBehavior field of the GlobalOpts data constructor.

terminalL :: HasRunner env => Lens' env Bool Source #

See the terminal field of the GlobalOpts data constructor.

reExecL :: HasRunner env => SimpleGetter env Bool Source #

See the reExecVersion field of the GlobalOpts data constructor.

rslInLogL :: HasRunner env => SimpleGetter env Bool Source #

See the rslInLog field of the GlobalOpts data constructor.

progNameL :: HasRunner env => SimpleGetter env String Source #

See the progNameL field of the GlobalOpts data constructor.

mExecutablePathL :: HasRunner env => SimpleGetter env (Maybe (Path Abs File)) Source #

See the mExecutablePath field of the GlobalOpts data constructor.

viewExecutablePath :: HasRunner env => RIO env (Path Abs File) Source #

Yield the path to the current Stack executable, if the operating system provides a reliable way to determine it. Otherwise throw NoExecutablePath.