Stack.BuildPlan

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

Documentation

data BuildPlanException

Constructors

UnknownPackages (Path Abs File) (Map PackageName (Maybe Version, Set PackageName)) (Map PackageName (Set PackageIdentifier))

SnapshotNotFound SnapName

FilepathInDownloadedSnapshot Text

NeitherCompilerOrResolverSpecified Text

Instances

Show BuildPlanException

Exception BuildPlanException

data BuildPlanCheck

Constructors

BuildPlanCheckOk (Map PackageName (Map FlagName Bool))

BuildPlanCheckPartial (Map PackageName (Map FlagName Bool)) DepErrors

BuildPlanCheckFail (Map PackageName (Map FlagName Bool)) DepErrors CompilerVersion

Instances

Show BuildPlanCheck

checkSnapBuildPlan :: (StackM env m, HasConfig env, HasGHCVariant env) => [GenericPackageDescription] -> Maybe (Map PackageName (Map FlagName Bool)) -> SnapName -> m 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

Constructors

DepError

Fields

deVersion :: !(Maybe Version)

deNeededBy :: !(Map PackageName VersionRange)

Instances

Show DepError

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

A simplified version of the BuildPlan + cabal file.

Constructors

MiniBuildPlan

Fields

mbpCompilerVersion :: !CompilerVersion

mbpPackages :: !(Map PackageName MiniPackageInfo)

Instances

Eq MiniBuildPlan

Data MiniBuildPlan

Show MiniBuildPlan

Generic MiniBuildPlan

NFData MiniBuildPlan

Store MiniBuildPlan

type Rep MiniBuildPlan

data MiniPackageInfo

Information on a single package for the MiniBuildPlan.

Constructors

MiniPackageInfo

Fields

mpiVersion :: !Version

mpiFlags :: !(Map FlagName Bool)

mpiGhcOptions :: ![Text]

mpiPackageDeps :: !(Set PackageName)

mpiToolDeps :: !(Set Text)

Due to ambiguity in Cabal, it is unclear whether this refers to the executable name, the package name, or something else. We have to guess based on what's available, which is why we store this is an unwrapped Text.

mpiExes :: !(Set ExeName)

Executables provided by this package

mpiHasLibrary :: !Bool

Is there a library present?

mpiGitSHA1 :: !(Maybe GitSHA1)

An optional SHA1 representation in hex format of the blob containing the cabal file contents. Useful for grabbing the correct cabal file revision directly from a Git repo

Instances

Eq MiniPackageInfo

Data MiniPackageInfo

Show MiniPackageInfo

Generic MiniPackageInfo

NFData MiniPackageInfo

Store MiniPackageInfo

type Rep MiniPackageInfo

loadResolver :: (StackMiniM env m, HasConfig env, HasGHCVariant env) => Maybe (Path Abs File) -> Resolver -> m (MiniBuildPlan, LoadedResolver)

loadMiniBuildPlan :: (StackMiniM env m, HasConfig env, HasGHCVariant env) => SnapName -> m MiniBuildPlan

Load up a MiniBuildPlan, preferably from cache

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

resolveBuildPlan

Arguments

:: (StackMiniM env m, HasBuildConfig env)

=> 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 :: (StackM env m, HasConfig env, HasGHCVariant env) => [GenericPackageDescription] -> NonEmpty SnapName -> m (SnapName, BuildPlanCheck)

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

getToolMap :: MiniBuildPlan -> Map Text (Set PackageName)

Map from tool name to package providing it

shadowMiniBuildPlan :: MiniBuildPlan -> Set PackageName -> (MiniBuildPlan, Map PackageName MiniPackageInfo)

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

showPackageFlags :: PackageName -> Map FlagName Bool -> Text

parseCustomMiniBuildPlan

Arguments

:: (StackMiniM env m, HasConfig env, HasGHCVariant env)

=> Maybe (Path Abs File)

Root directory for when url is a filepath

-> Text

-> m (MiniBuildPlan, SnapshotHash)