Safe Haskell | None |
---|---|
Language | Haskell2010 |
The general Stack configuration that starts everything off. This should be smart to falback if there is no stack.yaml, instead relying on whatever files are available.
If there is no stack.yaml, and there is a cabal.config, we read in those constraints, and if there's a cabal.sandbox.config, we read any constraints from there and also find the package database from there, etc. And if there's nothing, we should probably default to behaving like cabal, possibly with spitting out a warning that "you should run `stk init` to make things better".
- data MiniConfig
- loadConfig :: StackM env m => ConfigMonoid -> Maybe AbstractResolver -> StackYamlLoc (Path Abs File) -> m (LoadConfig m)
- loadConfigMaybeProject :: StackM env m => ConfigMonoid -> Maybe AbstractResolver -> LocalConfigStatus (Project, Path Abs File, ConfigMonoid) -> m (LoadConfig m)
- loadMiniConfig :: Config -> MiniConfig
- loadConfigYaml :: (MonadIO m, MonadLogger m) => (Value -> Parser (WithJSONWarnings a)) -> Path Abs File -> m a
- packagesParser :: Parser [String]
- getLocalPackages :: (StackMiniM env m, HasEnvConfig env) => m (Map (Path Abs Dir) TreatLikeExtraDep)
- resolvePackageEntry :: (StackMiniM env m, HasConfig env) => EnvOverride -> Path Abs Dir -> PackageEntry -> m [(Path Abs Dir, TreatLikeExtraDep)]
- getImplicitGlobalProjectDir :: (MonadIO m, MonadLogger m) => Config -> m (Path Abs Dir)
- getStackYaml :: (StackMiniM env m, HasConfig env) => m (Path Abs File)
- getSnapshots :: (StackMiniM env m, HasConfig env) => m Snapshots
- makeConcreteResolver :: (StackMiniM env m, HasConfig env) => AbstractResolver -> m Resolver
- checkOwnership :: (MonadIO m, MonadCatch m) => Path Abs Dir -> m ()
- getInContainer :: MonadIO m => m Bool
- getInNixShell :: MonadIO m => m Bool
- defaultConfigYaml :: ByteString
- getProjectConfig :: (MonadIO m, MonadThrow m, MonadLogger m) => StackYamlLoc (Path Abs File) -> m (LocalConfigStatus (Path Abs File))
- data LocalConfigStatus a
- removePathFromPackageEntry :: (StackMiniM env m, HasConfig env) => EnvOverride -> Path Abs Dir -> Path Abs Dir -> PackageEntry -> m (Maybe PackageEntry)
Documentation
data MiniConfig Source #
An environment with a subset of BuildConfig used for setup.
:: StackM env m | |
=> ConfigMonoid | Config monoid from parsed command-line arguments |
-> Maybe AbstractResolver | Override resolver |
-> StackYamlLoc (Path Abs File) | Override stack.yaml |
-> m (LoadConfig m) |
Load the configuration, using current directory, environment variables,
and defaults as necessary. The passed Maybe (Path Abs File)
is an
override for the location of the project's stack.yaml.
loadConfigMaybeProject Source #
:: StackM env m | |
=> ConfigMonoid | Config monoid from parsed command-line arguments |
-> Maybe AbstractResolver | Override resolver |
-> LocalConfigStatus (Project, Path Abs File, ConfigMonoid) | Project config to use, if any |
-> m (LoadConfig m) |
loadMiniConfig :: Config -> MiniConfig Source #
Load the MiniConfig
.
loadConfigYaml :: (MonadIO m, MonadLogger m) => (Value -> Parser (WithJSONWarnings a)) -> Path Abs File -> m a Source #
Load and parse YAML from the given config file. Throws
ParseConfigFileException
when there's a decoding error.
packagesParser :: Parser [String] Source #
getLocalPackages :: (StackMiniM env m, HasEnvConfig env) => m (Map (Path Abs Dir) TreatLikeExtraDep) Source #
Get packages from EnvConfig, downloading and cloning as necessary. If the packages have already been downloaded, this uses a cached value (
:: (StackMiniM env m, HasConfig env) | |
=> EnvOverride | |
-> Path Abs Dir | project root |
-> PackageEntry | |
-> m [(Path Abs Dir, TreatLikeExtraDep)] |
Resolve a PackageEntry into a list of paths, downloading and cloning as necessary.
getImplicitGlobalProjectDir :: (MonadIO m, MonadLogger m) => Config -> m (Path Abs Dir) Source #
Get the location of the implicit global project directory. If the directory already exists at the deprecated location, its location is returned. Otherwise, the new location is returned.
getStackYaml :: (StackMiniM env m, HasConfig env) => m (Path Abs File) Source #
This is slightly more expensive than
and should only be used when no asks
(bcStackYaml
.
getBuildConfig
)BuildConfig
is at hand.
getSnapshots :: (StackMiniM env m, HasConfig env) => m Snapshots Source #
Download the Snapshots
value from stackage.org.
makeConcreteResolver :: (StackMiniM env m, HasConfig env) => AbstractResolver -> m Resolver Source #
Turn an AbstractResolver
into a Resolver
.
checkOwnership :: (MonadIO m, MonadCatch m) => Path Abs Dir -> m () Source #
throws checkOwnership
dirUserDoesn'tOwnDirectory
if dir
isn't owned by the current user.
If dir
doesn't exist, its parent directory is checked instead.
If the parent directory doesn't exist either,
is thrown.NoSuchDirectory
(parent
dir)
getInContainer :: MonadIO m => m Bool Source #
True
if we are currently running inside a Docker container.
:: (MonadIO m, MonadThrow m, MonadLogger m) | |
=> StackYamlLoc (Path Abs File) | Override stack.yaml |
-> m (LocalConfigStatus (Path Abs File)) |
Get the location of the project config file, if it exists.
data LocalConfigStatus a Source #
removePathFromPackageEntry Source #
:: (StackMiniM env m, HasConfig env) | |
=> EnvOverride | |
-> Path Abs Dir | project root |
-> Path Abs Dir | path to remove |
-> PackageEntry | |
-> m (Maybe PackageEntry) | Nothing if the whole package entry should be removed, otherwise it returns the updated PackageEntry |
Remove path from package entry. If the package entry contains subdirs, then it removes the subdir. If the package entry points to the path to remove, this function returns Nothing. If the package entry doesn't mention the path to remove, it is returned unchanged