Safe Haskell	None
Language	GHC2021

Stack.Types.ConfigMonoid

Synopsis

data ConfigMonoid = ConfigMonoid {
- stackRoot :: !(First (Path Abs Dir))
- workDir :: !(First (Path Rel Dir))
- buildOpts :: !BuildOptsMonoid
- dockerOpts :: !DockerOptsMonoid
- nixOpts :: !NixOptsMonoid
- connectionCount :: !(First Int)
- hideTHLoading :: !FirstTrue
- prefixTimestamps :: !(First Bool)
- latestSnapshot :: !(First Text)
- packageIndex :: !(First PackageIndexConfig)
- systemGHC :: !(First Bool)
- installGHC :: !FirstTrue
- skipGHCCheck :: !FirstFalse
- skipMsys :: !FirstFalse
- msysEnvironment :: !(First MsysEnvironment)
- compilerCheck :: !(First VersionCheck)
- compilerRepository :: !(First CompilerRepository)
- requireStackVersion :: !IntersectingVersionRange
- arch :: !(First String)
- ghcVariant :: !(First GHCVariant)
- ghcBuild :: !(First CompilerBuild)
- jobs :: !(First Int)
- extraIncludeDirs :: ![FilePath]
- extraLibDirs :: ![FilePath]
- customPreprocessorExts :: ![Text]
- overrideGccPath :: !(First (Path Abs File))
- overrideHpack :: !(First FilePath)
- hpackForce :: !FirstFalse
- concurrentTests :: !(First Bool)
- localBinPath :: !(First FilePath)
- fileWatchHook :: !(First FilePath)
- templateParameters :: !(Map Text Text)
- scmInit :: !(First SCM)
- ghcOptionsByName :: !(MonoidMap PackageName (Dual [Text]))
- ghcOptionsByCat :: !(MonoidMap ApplyGhcOptions (Dual [Text]))
- cabalConfigOpts :: !(MonoidMap CabalConfigKey (Dual [Text]))
- extraPath :: ![Path Abs Dir]
- setupInfoLocations :: ![String]
- setupInfoInline :: !SetupInfo
- localProgramsBase :: !(First (Path Abs Dir))
- pvpBounds :: !(First PvpBounds)
- modifyCodePage :: !FirstTrue
- rebuildGhcOptions :: !FirstFalse
- applyGhcOptions :: !(First ApplyGhcOptions)
- applyProgOptions :: !(First ApplyProgOptions)
- allowNewer :: !(First Bool)
- allowNewerDeps :: !(Maybe AllowNewerDeps)
- defaultInitSnapshot :: !(First (Unresolved AbstractSnapshot))
- defaultTemplate :: !(First TemplateName)
- allowDifferentUser :: !(First Bool)
- dumpLogs :: !(First DumpLogs)
- saveHackageCreds :: !FirstTrue
- hackageBaseUrl :: !(First Text)
- colorWhen :: !(First ColorWhen)
- styles :: !StylesUpdate
- hideSourcePaths :: !FirstTrue
- recommendStackUpgrade :: !FirstTrue
- notifyIfNixOnPath :: !FirstTrue
- notifyIfGhcUntested :: !FirstTrue
- notifyIfCabalUntested :: !FirstTrue
- notifyIfArchUnknown :: !FirstTrue
- casaOpts :: !CasaOptsMonoid
- casaRepoPrefix :: !(First CasaRepoPrefix)
- snapshotLocation :: !(First Text)
- globalHintsLocation :: !(First (Unresolved GlobalHintsLocation))
- noRunCompile :: !FirstFalse
- stackDeveloperMode :: !(First Bool)
}
parseConfigMonoid :: Path Abs Dir -> Value -> Parser (WithJSONWarnings ConfigMonoid)
parseConfigMonoidObject :: Path Abs Dir -> Object -> WarningParser ConfigMonoid
configMonoidAllowDifferentUserName :: Text
configMonoidGHCVariantName :: Text
configMonoidInstallGHCName :: Text
configMonoidRecommendStackUpgradeName :: Text
configMonoidSystemGHCName :: Text

Documentation

data ConfigMonoid Source #

An uninterpreted representation of configuration options. Configurations may be "cascaded" using mappend (left-biased).

Constructors

ConfigMonoid

Fields

stackRoot :: !(First (Path Abs Dir))
See: clStackRoot
workDir :: !(First (Path Rel Dir))
See: configWorkDir.
buildOpts :: !BuildOptsMonoid
build options.
dockerOpts :: !DockerOptsMonoid
Docker options.
nixOpts :: !NixOptsMonoid
Options for the execution environment (nix-shell or container)
connectionCount :: !(First Int)
See: configConnectionCount
hideTHLoading :: !FirstTrue
See: configHideTHLoading
prefixTimestamps :: !(First Bool)
See: configPrefixTimestamps
latestSnapshot :: !(First Text)
See: configLatestSnapshot
packageIndex :: !(First PackageIndexConfig)
See: withPantryConfig
systemGHC :: !(First Bool)
See: configSystemGHC
installGHC :: !FirstTrue
See: configInstallGHC
skipGHCCheck :: !FirstFalse
See: configSkipGHCCheck
skipMsys :: !FirstFalse
See: configSkipMsys
msysEnvironment :: !(First MsysEnvironment)
See: configMsysEnvironment
compilerCheck :: !(First VersionCheck)
See: configCompilerCheck
compilerRepository :: !(First CompilerRepository)
See: configCompilerRepository
requireStackVersion :: !IntersectingVersionRange
See: configRequireStackVersion
arch :: !(First String)
Used for overriding the platform
ghcVariant :: !(First GHCVariant)
Used for overriding the platform
ghcBuild :: !(First CompilerBuild)
Used for overriding the GHC build
jobs :: !(First Int)
See: configJobs
extraIncludeDirs :: ![FilePath]
See: configExtraIncludeDirs
extraLibDirs :: ![FilePath]
See: configExtraLibDirs
customPreprocessorExts :: ![Text]
See: configCustomPreprocessorExts
overrideGccPath :: !(First (Path Abs File))
Allow users to override the path to gcc
overrideHpack :: !(First FilePath)
Use Hpack executable (overrides bundled Hpack)
hpackForce :: !FirstFalse
Pass --force to Hpack to always overwrite Cabal file
concurrentTests :: !(First Bool)
See: configConcurrentTests
localBinPath :: !(First FilePath)
Used to override the binary installation dir
fileWatchHook :: !(First FilePath)
Path to executable used to override --file-watch post-processing.
templateParameters :: !(Map Text Text)
Template parameters.
scmInit :: !(First SCM)
Initialize SCM (e.g. git init) when making new projects?
ghcOptionsByName :: !(MonoidMap PackageName (Dual [Text]))
See configGhcOptionsByName. Uses Dual so that options from the configs on the right come first, so that they can be overridden.
ghcOptionsByCat :: !(MonoidMap ApplyGhcOptions (Dual [Text]))
See configGhcOptionsAll. Uses Dual so that options from the configs on the right come first, so that they can be overridden.
cabalConfigOpts :: !(MonoidMap CabalConfigKey (Dual [Text]))
See configCabalConfigOpts.
extraPath :: ![Path Abs Dir]
Additional paths to search for executables in
setupInfoLocations :: ![String]
See configSetupInfoLocations
setupInfoInline :: !SetupInfo
See configSetupInfoInline
localProgramsBase :: !(First (Path Abs Dir))
Override the default local programs dir, where e.g. GHC is installed.
pvpBounds :: !(First PvpBounds)
See configPvpBounds
modifyCodePage :: !FirstTrue
See configModifyCodePage
rebuildGhcOptions :: !FirstFalse
See configMonoidRebuildGhcOptions
applyGhcOptions :: !(First ApplyGhcOptions)
See configApplyGhcOptions
applyProgOptions :: !(First ApplyProgOptions)
See configApplyProgOptions
allowNewer :: !(First Bool)
See configMonoidAllowNewer
allowNewerDeps :: !(Maybe AllowNewerDeps)
See configMonoidAllowNewerDeps
defaultInitSnapshot :: !(First (Unresolved AbstractSnapshot))
An optional default snapshot to use with stack init when none is specified.
defaultTemplate :: !(First TemplateName)
The default template to use when none is specified. (If Nothing, the 'default' default template is used.)
allowDifferentUser :: !(First Bool)
Allow users other than the Stack root owner to use the Stack installation.
dumpLogs :: !(First DumpLogs)
See configDumpLogs
saveHackageCreds :: !FirstTrue
See configSaveHackageCreds
hackageBaseUrl :: !(First Text)
See configHackageBaseUrl
colorWhen :: !(First ColorWhen)
When to use ANSI colors
styles :: !StylesUpdate
hideSourcePaths :: !FirstTrue
See configHideSourcePaths
recommendStackUpgrade :: !FirstTrue
See configRecommendStackUpgrade
notifyIfNixOnPath :: !FirstTrue
See configNotifyIfNixOnPath
notifyIfGhcUntested :: !FirstTrue
See configNotifyIfGhcUntested
notifyIfCabalUntested :: !FirstTrue
See configNotifyIfCabalUntested
notifyIfArchUnknown :: !FirstTrue
See configNotifyIfArchUnknown
casaOpts :: !CasaOptsMonoid
Casa configuration options.
casaRepoPrefix :: !(First CasaRepoPrefix)
Casa repository prefix (deprecated).
snapshotLocation :: !(First Text)
Custom location of LTS/Nightly snapshots
globalHintsLocation :: !(First (Unresolved GlobalHintsLocation))
Custom location of global hints
noRunCompile :: !FirstFalse
See: configNoRunCompile
stackDeveloperMode :: !(First Bool)
See configStackDeveloperMode

Instances

Instances details

Monoid ConfigMonoid Source #

Instance details

Defined in Stack.Types.ConfigMonoid

Methods

mempty :: ConfigMonoid #

mappend :: ConfigMonoid -> ConfigMonoid -> ConfigMonoid #

mconcat :: [ConfigMonoid] -> ConfigMonoid #

Semigroup ConfigMonoid Source #

Instance details

Defined in Stack.Types.ConfigMonoid

Methods

(<>) :: ConfigMonoid -> ConfigMonoid -> ConfigMonoid #

sconcat :: NonEmpty ConfigMonoid -> ConfigMonoid #

stimes :: Integral b => b -> ConfigMonoid -> ConfigMonoid #

Generic ConfigMonoid Source #

Instance details

Defined in Stack.Types.ConfigMonoid

Associated Types

type Rep ConfigMonoid

Instance details

Defined in Stack.Types.ConfigMonoid

Methods

from :: ConfigMonoid -> Rep ConfigMonoid x #

to :: Rep ConfigMonoid x -> ConfigMonoid #

type Rep ConfigMonoid Source #

Instance details

Defined in Stack.Types.ConfigMonoid

parseConfigMonoid :: Path Abs Dir -> Value -> Parser (WithJSONWarnings ConfigMonoid) Source #

parseConfigMonoidObject :: Path Abs Dir -> Object -> WarningParser ConfigMonoid Source #

Parse a partial configuration. Used both to parse both a standalone config file and a project file, so that a sub-parser is not required, which would interfere with warnings for missing fields.

configMonoidAllowDifferentUserName :: Text Source #

configMonoidGHCVariantName :: Text Source #

configMonoidInstallGHCName :: Text Source #

configMonoidRecommendStackUpgradeName :: Text Source #

configMonoidSystemGHCName :: Text Source #