Safe Haskell	None
Language	GHC2021

Stack.Types.BuildConfig

Synopsis

data BuildConfig = BuildConfig {
- config :: !Config
- smWanted :: !SMWanted
- extraPackageDBs :: ![Path Abs Dir]
- configFile :: !(Either (Path Abs File) (Path Abs File))
- projectStorage :: !ProjectStorage
- curator :: !(Maybe Curator)
}
class HasConfig env => HasBuildConfig env where
- buildConfigL :: Lens' env BuildConfig
configFileL :: HasBuildConfig env => Lens' env (Either (Path Abs File) (Path Abs File))
configFileRootL :: HasBuildConfig env => Getting r env (Path Abs Dir)
getWorkDir :: (HasBuildConfig env, MonadReader env m) => m (Path Abs Dir)
wantedCompilerVersionL :: HasBuildConfig s => Getting r s WantedCompiler

Documentation

data BuildConfig Source #

A superset of Config adding information on how to build code. The reason for this breakdown is because we will need some of the information from Config in order to determine the values here.

These are the components which know nothing about local configuration.

Constructors

BuildConfig

Fields

config :: !Config
smWanted :: !SMWanted
extraPackageDBs :: ![Path Abs Dir]
Extra package databases
configFile :: !(Either (Path Abs File) (Path Abs File))
Either (Left) the location of the user-specific global configuration file or, in most cases, (Right) the location of the project-level coniguration file (stack.yaml, by default).
Note: if the STACK_YAML environment variable is used, the location of the project-level configuration file may be different from projectRootL / "stack.yaml" if a different file name is used.
projectStorage :: !ProjectStorage
Database connection pool for project Stack database
curator :: !(Maybe Curator)

Instances

Instances details

HasPantryConfig BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods pantryConfigL :: Lens' BuildConfig PantryConfig #
HasLogFunc BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods logFuncL :: Lens' BuildConfig LogFunc #
HasProcessContext BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods processContextL :: Lens' BuildConfig ProcessContext #
HasTerm BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods useColorL :: Lens' BuildConfig Bool # termWidthL :: Lens' BuildConfig Int #
HasStylesUpdate BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods stylesUpdateL :: Lens' BuildConfig StylesUpdate #
HasBuildConfig BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods buildConfigL :: Lens' BuildConfig BuildConfig Source #
HasConfig BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods configL :: Lens' BuildConfig Config Source #
HasGHCVariant BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods ghcVariantL :: SimpleGetter BuildConfig GHCVariant Source #
HasPlatform BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods platformL :: Lens' BuildConfig Platform Source # platformVariantL :: Lens' BuildConfig PlatformVariant Source #
HasRunner BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods runnerL :: Lens' BuildConfig Runner Source #

class HasConfig env => HasBuildConfig env where Source #

Methods

buildConfigL :: Lens' env BuildConfig Source #

Instances

Instances details

HasBuildConfig EnvConfigPathInfo Source #
Instance details Defined in Stack.Path Methods buildConfigL :: Lens' EnvConfigPathInfo BuildConfig Source #
HasBuildConfig Ctx Source #
Instance details Defined in Stack.Types.Build.ConstructPlan Methods buildConfigL :: Lens' Ctx BuildConfig Source #
HasBuildConfig BuildConfig Source #
Instance details Defined in Stack.Types.BuildConfig Methods buildConfigL :: Lens' BuildConfig BuildConfig Source #
HasBuildConfig DotConfig Source #
Instance details Defined in Stack.Types.DotConfig Methods buildConfigL :: Lens' DotConfig BuildConfig Source #
HasBuildConfig EnvConfig Source #
Instance details Defined in Stack.Types.EnvConfig Methods buildConfigL :: Lens' EnvConfig BuildConfig Source #
HasBuildConfig GetPackageFileContext Source #
Instance details Defined in Stack.Types.PackageFile Methods buildConfigL :: Lens' GetPackageFileContext BuildConfig Source #

configFileL :: HasBuildConfig env => Lens' env (Either (Path Abs File) (Path Abs File)) Source #

configFileRootL :: HasBuildConfig env => Getting r env (Path Abs Dir) Source #

Directory containing the configuration file.

getWorkDir :: (HasBuildConfig env, MonadReader env m) => m (Path Abs Dir) Source #

Work directory in the directory of the configuration file (global or project-level).

wantedCompilerVersionL :: HasBuildConfig s => Getting r s WantedCompiler Source #

The compiler specified by the SnapshotDef. This may be different from the actual compiler used!