Stack.Types.Config

Documentation

data Config

The top-level Stackage configuration.

Constructors

Config

Fields

• workDir :: !(Path Rel Dir)

  this allows to override .stack-work directory

• userGlobalConfigFile :: !(Path Abs File)

  The user-specific global configuration file.

• build :: !BuildOpts

  Build configuration

• docker :: !DockerOpts

  Docker configuration

• nix :: !NixOpts

  Execution environment (e.g nix-shell) configuration

• processContextSettings :: !(EnvSettings -> IO ProcessContext)

  Environment variables to be passed to external tools

• localProgramsBase :: !(Path Abs Dir)

  Non-platform-specific path containing local installations

• localPrograms :: !(Path Abs Dir)

  Path containing local installations (mainly GHC)

• hideTHLoading :: !Bool

  Hide the Template Haskell "Loading package ..." messages from the console

• prefixTimestamps :: !Bool

  Prefix build output with timestamps for each line.

• platform :: !Platform

  The platform we're building for, used in many directory names

• platformVariant :: !PlatformVariant

  Variant of the platform, also used in directory names

• ghcVariant :: !(Maybe GHCVariant)

  The variant of GHC requested by the user.

• ghcBuild :: !(Maybe CompilerBuild)

  Override build of the compiler distribution (e.g. standard, gmp4, tinfo6)

• latestSnapshot :: !Text

  URL of a JSON file providing the latest LTS and Nightly snapshots.

• systemGHC :: !Bool

  Should we use the system-installed GHC (on the PATH) if available? Can be overridden by command line options.

• installGHC :: !Bool

  Should we automatically install GHC if missing or the wrong version is available? Can be overridden by command line options.

• skipGHCCheck :: !Bool

  Don't bother checking the GHC version or architecture.

• skipMsys :: !Bool

  On Windows: don't use a sandboxed MSYS

• msysEnvironment :: !(Maybe MsysEnvironment)

  On Windows: what MSYS2 environment to apply. Nothing on other operating systems.

• compilerCheck :: !VersionCheck

  Specifies which versions of the compiler are acceptable.

• compilerRepository :: !CompilerRepository

  Specifies the repository containing the compiler sources

• localBin :: !(Path Abs Dir)

  Directory we should install executables into

• fileWatchHook :: !(Maybe (Path Abs File))

  Optional path of executable used to override --file-watch post-processing.

• requireStackVersion :: !VersionRange

  Require a version of Stack within this range.

• jobs :: !Int

  How many concurrent jobs to run, defaults to number of capabilities

• overrideGccPath :: !(Maybe (Path Abs File))

  Optional gcc override path

• extraIncludeDirs :: ![FilePath]
  • -extra-include-dirs arguments
• extraLibDirs :: ![FilePath]
  • -extra-lib-dirs arguments
• customPreprocessorExts :: ![Text]

  List of custom preprocessors to complete the hard coded ones

• concurrentTests :: !Bool

  Run test suites concurrently

• templateParams :: !(Map Text Text)

  Parameters for templates.

• scmInit :: !(Maybe SCM)

  Initialize SCM (e.g. git) when creating new projects.

• ghcOptionsByName :: !(Map PackageName [Text])

  Additional GHC options to apply to specific packages.

• ghcOptionsByCat :: !(Map ApplyGhcOptions [Text])

  Additional GHC options to apply to categories of packages

• cabalConfigOpts :: !(Map CabalConfigKey [Text])

  Additional options to be passed to ./Setup.hs configure

• setupInfoLocations :: ![String]

  URLs or paths to stack-setup.yaml files, for finding tools. If none present, the default setup-info is used.

• setupInfoInline :: !SetupInfo

  Additional SetupInfo to use to find tools.

• pvpBounds :: !PvpBounds

  How PVP upper bounds should be added to packages

• modifyCodePage :: !Bool

  Force the code page to UTF-8 on Windows

• rebuildGhcOptions :: !Bool

  Rebuild on GHC options changes

• applyGhcOptions :: !ApplyGhcOptions

  Which packages do --ghc-options on the command line apply to?

• applyProgOptions :: !ApplyProgOptions

  Which packages do all and any --PROG-option options on the command line apply to?

• allowNewer :: !(First Bool)

  Ignore version ranges in .cabal files. Funny naming chosen to match cabal.

• allowNewerDeps :: !(Maybe [PackageName])

  Ignore dependency upper and lower bounds only for specified packages. No effect unless allow-newer is enabled.

• defaultInitSnapshot :: !(First AbstractSnapshot)

  An optional default snapshot to use with stack init when none is specified at the command line.

• defaultTemplate :: !(Maybe TemplateName)

  The default template to use when none is specified. (If Nothing, the 'default' default template is used.)

• allowDifferentUser :: !Bool

  Allow users other than the Stack root owner to use the Stack installation.

• dumpLogs :: !DumpLogs

  Dump logs of local non-dependencies when doing a build.

• project :: !(ProjectConfig (Project, Path Abs File))

  Project information and stack.yaml file location

• allowLocals :: !Bool

  Are we allowed to build local packages? The script command disallows this.

• saveHackageCreds :: !FirstTrue

  Should we save Hackage credentials to a file?

• hackageBaseUrl :: !Text

  Hackage base URL used when uploading packages

• runner :: !Runner
• pantryConfig :: !PantryConfig
• stackRoot :: !(Path Abs Dir)
• snapshot :: !(Maybe AbstractSnapshot)

  Any snapshot override from the command line

• userStorage :: !UserStorage

  Database connection pool for user Stack database

• hideSourcePaths :: !Bool

  Enable GHC hiding source paths?

• recommendStackUpgrade :: !Bool

  Recommend a Stack upgrade?

• notifyIfNixOnPath :: !Bool

  Notify if the Nix package manager (nix) is on the PATH, but Stack's Nix integration is not enabled?

• notifyIfGhcUntested :: !Bool

  Notify if Stack has not been tested with the GHC version?

• notifyIfCabalUntested :: !Bool

  Notify if Stack has not been tested with the Cabal version?

• notifyIfArchUnknown :: !Bool

  Notify if the specified machine architecture is unknown to Cabal (the library)?

• noRunCompile :: !Bool

  Use --no-run and --compile options when using `stack script`

• stackDeveloperMode :: !Bool

  Turn on Stack developer mode for additional messages?

• casa :: !(Maybe (CasaRepoPrefix, Int))

  Optional Casa configuration

Instances

HasPantryConfig Config

Defined in Stack.Types.Config

Methods

pantryConfigL :: Lens' Config PantryConfig

HasLogFunc Config

Defined in Stack.Types.Config

Methods

logFuncL :: Lens' Config LogFunc

HasProcessContext Config

Defined in Stack.Types.Config

Methods

processContextL :: Lens' Config ProcessContext

HasTerm Config

Defined in Stack.Types.Config

Methods

useColorL :: Lens' Config Bool

termWidthL :: Lens' Config Int

HasStylesUpdate Config

Defined in Stack.Types.Config

Methods

stylesUpdateL :: Lens' Config StylesUpdate

HasConfig Config

Defined in Stack.Types.Config

Methods

configL :: Lens' Config Config

HasGHCVariant Config

Defined in Stack.Types.Config

Methods

ghcVariantL :: SimpleGetter Config GHCVariant

HasPlatform Config

Defined in Stack.Types.Config

Methods

platformL :: Lens' Config Platform

platformVariantL :: Lens' Config PlatformVariant

HasRunner Config

Defined in Stack.Types.Config

Methods

runnerL :: Lens' Config Runner

class (HasPlatform env, HasGHCVariant env, HasProcessContext env, HasPantryConfig env, HasTerm env, HasRunner env) => HasConfig env where

Class for environment values that can provide a Config.

Methods

configL :: Lens' env Config

Instances

HasConfig EnvConfigPathInfo

Defined in Stack.Path

Methods

configL :: Lens' EnvConfigPathInfo Config

HasConfig Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

configL :: Lens' Ctx Config

HasConfig BuildConfig

Defined in Stack.Types.BuildConfig

Methods

configL :: Lens' BuildConfig Config

HasConfig Config

Defined in Stack.Types.Config

Methods

configL :: Lens' Config Config

HasConfig DotConfig

Defined in Stack.Types.DotConfig

Methods

configL :: Lens' DotConfig Config

HasConfig EnvConfig

Defined in Stack.Types.EnvConfig

Methods

configL :: Lens' EnvConfig Config

HasConfig GetPackageFileContext

Defined in Stack.Types.PackageFile

Methods

configL :: Lens' GetPackageFileContext Config

askLatestSnapshotUrl :: (MonadReader env m, HasConfig env) => m Text

Get the URL to request the information on the latest snapshots

configProjectRoot :: Config -> Maybe (Path Abs Dir)

The project root directory, if in a project.

ghcInstallHook :: HasConfig env => RIO env (Path Abs File)

STACK_ROOT/hooks/ghc-install.sh

Lens helpers

buildOptsL :: HasConfig s => Lens' s BuildOpts

envOverrideSettingsL :: HasConfig env => Lens' env (EnvSettings -> IO ProcessContext)

globalOptsL :: HasRunner env => Lens' env GlobalOpts

userGlobalConfigFileL :: HasConfig s => Lens' s (Path Abs File)

stackRootL :: HasConfig s => Lens' s (Path Abs Dir)

workDirL :: HasConfig env => Lens' env (Path Rel Dir)

".stack-work"

Helper logging functions

prettyStackDevL :: HasConfig env => [StyleDoc] -> RIO env ()

In dev mode, print as a warning, otherwise as debug