Safe Haskell	None
Language	Haskell2010

Stack.BuildPlan

Description

Resolving a build plan for a set of packages in a given Stackage snapshot.

Synopsis

data BuildPlanException
- = UnknownPackages (Path Abs File) (Map PackageName (Maybe Version, Set PackageName)) (Map PackageName (Set PackageIdentifier))
- | SnapshotNotFound SnapName
- | NeitherCompilerOrResolverSpecified Text
data BuildPlanCheck
- = BuildPlanCheckOk (Map PackageName (Map FlagName Bool))
- | BuildPlanCheckPartial (Map PackageName (Map FlagName Bool)) DepErrors
- | BuildPlanCheckFail (Map PackageName (Map FlagName Bool)) DepErrors (CompilerVersion CVActual)
checkSnapBuildPlan :: (HasConfig env, HasGHCVariant env) => Path Abs Dir -> [GenericPackageDescription] -> Maybe (Map PackageName (Map FlagName Bool)) -> SnapshotDef -> Maybe (CompilerVersion CVActual) -> RIO env BuildPlanCheck
data DepError = DepError {
- deVersion :: !(Maybe Version)
- deNeededBy :: !(Map PackageName VersionRange)
}
type DepErrors = Map PackageName DepError
gpdPackageDeps :: GenericPackageDescription -> CompilerVersion CVActual -> Platform -> Map FlagName Bool -> Map PackageName VersionRange
gpdPackages :: [GenericPackageDescription] -> Map PackageName Version
removeSrcPkgDefaultFlags :: [GenericPackageDescription] -> Map PackageName (Map FlagName Bool) -> Map PackageName (Map FlagName Bool)
selectBestSnapshot :: (HasConfig env, HasGHCVariant env) => Path Abs Dir -> [GenericPackageDescription] -> NonEmpty SnapName -> RIO env (SnapshotDef, BuildPlanCheck)
showItems :: Show a => [a] -> Text

Documentation

data BuildPlanException Source #

Constructors

UnknownPackages (Path Abs File) (Map PackageName (Maybe Version, Set PackageName)) (Map PackageName (Set PackageIdentifier))
SnapshotNotFound SnapName
NeitherCompilerOrResolverSpecified Text

Instances

Show BuildPlanException Source #
Instance details Defined in Stack.BuildPlan Methods showsPrec :: Int -> BuildPlanException -> ShowS # show :: BuildPlanException -> String # showList :: [BuildPlanException] -> ShowS #
Exception BuildPlanException Source #
Instance details Defined in Stack.BuildPlan Methods toException :: BuildPlanException -> SomeException # fromException :: SomeException -> Maybe BuildPlanException # displayException :: BuildPlanException -> String #

data BuildPlanCheck Source #

Constructors

BuildPlanCheckOk (Map PackageName (Map FlagName Bool))
BuildPlanCheckPartial (Map PackageName (Map FlagName Bool)) DepErrors
BuildPlanCheckFail (Map PackageName (Map FlagName Bool)) DepErrors (CompilerVersion CVActual)

Instances

Show BuildPlanCheck Source #
Instance details Defined in Stack.BuildPlan Methods showsPrec :: Int -> BuildPlanCheck -> ShowS # show :: BuildPlanCheck -> String # showList :: [BuildPlanCheck] -> ShowS #

checkSnapBuildPlan Source #

Arguments

:: (HasConfig env, HasGHCVariant env)
=> Path Abs Dir	project root, used for checking out necessary files
-> [GenericPackageDescription]
-> Maybe (Map PackageName (Map FlagName Bool))
-> SnapshotDef
-> Maybe (CompilerVersion CVActual)
-> RIO env BuildPlanCheck

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.

data DepError Source #

Constructors

DepError
Fields deVersion :: !(Maybe Version) deNeededBy :: !(Map PackageName VersionRange)

Instances

Show DepError Source #
Instance details Defined in Stack.BuildPlan Methods showsPrec :: Int -> DepError -> ShowS # show :: DepError -> String # showList :: [DepError] -> ShowS #

type DepErrors = Map PackageName DepError Source #

gpdPackageDeps :: GenericPackageDescription -> CompilerVersion CVActual -> Platform -> Map FlagName Bool -> Map PackageName VersionRange Source #

gpdPackages :: [GenericPackageDescription] -> Map PackageName Version Source #

removeSrcPkgDefaultFlags :: [GenericPackageDescription] -> Map PackageName (Map FlagName Bool) -> Map PackageName (Map FlagName Bool) Source #

selectBestSnapshot Source #

Arguments

:: (HasConfig env, HasGHCVariant env)
=> Path Abs Dir	project root, used for checking out necessary files
-> [GenericPackageDescription]
-> NonEmpty SnapName
-> RIO env (SnapshotDef, BuildPlanCheck)

Find a snapshot and set of flags that is compatible with and matches as best as possible with the given GenericPackageDescriptions.

showItems :: Show a => [a] -> Text Source #