| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Stack.BuildPlan
Description
Resolving a build plan for a set of packages in a given Stackage snapshot.
- data BuildPlanException
- data BuildPlanCheck
- checkSnapBuildPlan :: (MonadIO m, MonadCatch m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, HasGHCVariant env, MonadBaseControl IO m) => [GenericPackageDescription] -> Maybe (Map PackageName (Map FlagName Bool)) -> SnapName -> m BuildPlanCheck
- data DepError = DepError {
- deVersion :: !(Maybe Version)
- deNeededBy :: !(Map PackageName VersionRange)
- type DepErrors = Map PackageName DepError
- gpdPackageDeps :: GenericPackageDescription -> CompilerVersion -> Platform -> Map FlagName Bool -> Map PackageName VersionRange
- gpdPackages :: [GenericPackageDescription] -> Map PackageName Version
- gpdPackageName :: GenericPackageDescription -> PackageName
- data MiniBuildPlan = MiniBuildPlan {}
- data MiniPackageInfo = MiniPackageInfo {
- mpiVersion :: !Version
- mpiFlags :: !(Map FlagName Bool)
- mpiPackageDeps :: !(Set PackageName)
- mpiToolDeps :: !(Set Text)
- mpiExes :: !(Set ExeName)
- mpiHasLibrary :: !Bool
- loadMiniBuildPlan :: (MonadIO m, MonadThrow m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, HasGHCVariant env, MonadBaseControl IO m, MonadCatch m) => SnapName -> m MiniBuildPlan
- removeSrcPkgDefaultFlags :: [GenericPackageDescription] -> Map PackageName (Map FlagName Bool) -> Map PackageName (Map FlagName Bool)
- resolveBuildPlan :: (MonadThrow m, MonadIO m, MonadReader env m, HasBuildConfig env, MonadLogger m, HasHttpManager env, MonadBaseControl IO m, MonadCatch m) => MiniBuildPlan -> (PackageName -> Bool) -> Map PackageName (Set PackageName) -> m (Map PackageName (Version, Map FlagName Bool), Map PackageName (Set PackageName))
- selectBestSnapshot :: (MonadIO m, MonadCatch m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, HasGHCVariant env, MonadBaseControl IO m) => [GenericPackageDescription] -> [SnapName] -> m (SnapName, BuildPlanCheck)
- type ToolMap = Map ByteString (Set PackageName)
- getToolMap :: MiniBuildPlan -> Map Text (Set PackageName)
- shadowMiniBuildPlan :: MiniBuildPlan -> Set PackageName -> (MiniBuildPlan, Map PackageName MiniPackageInfo)
- showItems :: Show a => [a] -> Text
- parseCustomMiniBuildPlan :: (MonadIO m, MonadCatch m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, MonadBaseControl IO m) => Path Abs File -> Text -> m MiniBuildPlan
Documentation
data BuildPlanException Source
Constructors
| UnknownPackages (Path Abs File) (Map PackageName (Maybe Version, Set PackageName)) (Map PackageName (Set PackageIdentifier)) | |
| SnapshotNotFound SnapName |
data BuildPlanCheck Source
Constructors
Instances
checkSnapBuildPlan :: (MonadIO m, MonadCatch m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, HasGHCVariant env, MonadBaseControl IO m) => [GenericPackageDescription] -> Maybe (Map PackageName (Map FlagName Bool)) -> SnapName -> m BuildPlanCheck Source
Check a set of GenericPackageDescriptions and a set of flags against a
given snapshot. Returns how well the snapshot satisfies the dependencies of
the packages.
Constructors
| DepError | |
Fields
| |
type DepErrors = Map PackageName DepError Source
gpdPackageDeps :: GenericPackageDescription -> CompilerVersion -> Platform -> Map FlagName Bool -> Map PackageName VersionRange Source
data MiniBuildPlan Source
A simplified version of the BuildPlan + cabal file.
Constructors
| MiniBuildPlan | |
Fields | |
data MiniPackageInfo Source
Information on a single package for the MiniBuildPlan.
Constructors
| MiniPackageInfo | |
Fields
| |
loadMiniBuildPlan :: (MonadIO m, MonadThrow m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, HasGHCVariant env, MonadBaseControl IO m, MonadCatch m) => SnapName -> m MiniBuildPlan Source
Load up a MiniBuildPlan, preferably from cache
removeSrcPkgDefaultFlags :: [GenericPackageDescription] -> Map PackageName (Map FlagName Bool) -> Map PackageName (Map FlagName Bool) Source
Arguments
| :: (MonadThrow m, MonadIO m, MonadReader env m, HasBuildConfig env, MonadLogger m, HasHttpManager env, MonadBaseControl IO m, MonadCatch m) | |
| => MiniBuildPlan | |
| -> (PackageName -> Bool) | is it shadowed by a local package? |
| -> Map PackageName (Set PackageName) | required packages, and users of it |
| -> m (Map PackageName (Version, Map FlagName Bool), Map PackageName (Set PackageName)) |
Determine the necessary packages to install to have the given set of packages available.
This function will not provide test suite and benchmark dependencies.
This may fail if a target package is not present in the BuildPlan.
selectBestSnapshot :: (MonadIO m, MonadCatch m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, HasGHCVariant env, MonadBaseControl IO m) => [GenericPackageDescription] -> [SnapName] -> m (SnapName, BuildPlanCheck) Source
Find a snapshot and set of flags that is compatible with and matches as
best as possible with the given GenericPackageDescriptions. Returns
Nothing if no such snapshot is found.
type ToolMap = Map ByteString (Set PackageName) Source
Look up with packages provide which tools.
getToolMap :: MiniBuildPlan -> Map Text (Set PackageName) Source
Map from tool name to package providing it
shadowMiniBuildPlan :: MiniBuildPlan -> Set PackageName -> (MiniBuildPlan, Map PackageName MiniPackageInfo) Source
parseCustomMiniBuildPlan Source
Arguments
| :: (MonadIO m, MonadCatch m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, MonadBaseControl IO m) | |
| => Path Abs File | stack.yaml file location |
| -> Text | |
| -> m MiniBuildPlan |