Stack.Types.BuildPlan

Shared types for various stackage packages.

Types

data BuildPlan

Constructors

BuildPlan

Fields

bpSystemInfo :: SystemInfo

bpTools :: Vector (PackageName, Version)

bpPackages :: Map PackageName PackagePlan

bpGithubUsers :: Map Text (Set Text)

Instances

Eq BuildPlan

Show BuildPlan

ToJSON BuildPlan

FromJSON BuildPlan

data PackagePlan

Constructors

PackagePlan

Fields

ppVersion :: Version

ppGithubPings :: Set Text

ppUsers :: Set PackageName

ppConstraints :: PackageConstraints

ppDesc :: SimpleDesc

Instances

Eq PackagePlan

Show PackagePlan

ToJSON PackagePlan

FromJSON PackagePlan

data PackageConstraints

Constructors

PackageConstraints

Fields

pcVersionRange :: VersionRange

pcMaintainer :: Maybe Maintainer

pcTests :: TestState

pcHaddocks :: TestState

pcBuildBenchmarks :: Bool

pcFlagOverrides :: Map FlagName Bool

pcEnableLibProfile :: Bool

Instances

Eq PackageConstraints

Show PackageConstraints

ToJSON PackageConstraints

FromJSON PackageConstraints

data TestState

Constructors

ExpectSuccess

ExpectFailure

Don'tBuild

when the test suite will pull in things we don't want

Instances

Bounded TestState

Enum TestState

Eq TestState

Ord TestState

Show TestState

ToJSON TestState

FromJSON TestState

data SystemInfo

Constructors

SystemInfo

Fields

siGhcVersion :: Version

siOS :: OS

siArch :: Arch

siCorePackages :: Map PackageName Version

siCoreExecutables :: Set ExeName

Instances

Eq SystemInfo

Ord SystemInfo

Show SystemInfo

ToJSON SystemInfo

FromJSON SystemInfo

newtype Maintainer

Constructors

Maintainer

Fields

unMaintainer :: Text

Instances

Eq Maintainer

Ord Maintainer

Show Maintainer

IsString Maintainer

Hashable Maintainer

ToJSON Maintainer

FromJSON Maintainer

newtype ExeName

Name of an executable.

Constructors

ExeName

Fields

unExeName :: ByteString

Instances

Eq ExeName

Ord ExeName

Show ExeName

IsString ExeName

Generic ExeName

Binary ExeName

Hashable ExeName

ToJSON ExeName

FromJSON ExeName

ToJSON a => ToJSON (Map ExeName a)

FromJSON a => FromJSON (Map ExeName a)

type Rep ExeName

data SimpleDesc

A simplified package description that tracks:

• Package dependencies
• Build tool dependencies
• Provided executables

It has fully resolved all conditionals

Constructors

SimpleDesc

Fields

sdPackages :: Map PackageName DepInfo

sdTools :: Map ExeName DepInfo

sdProvidedExes :: Set ExeName

sdModules :: Set Text

modules exported by the library

Instances

Eq SimpleDesc

Show SimpleDesc

Monoid SimpleDesc

ToJSON SimpleDesc

FromJSON SimpleDesc

data DepInfo

Constructors

DepInfo

Fields

diComponents :: Set Component

diRange :: VersionRange

Instances

Eq DepInfo

Show DepInfo

Monoid DepInfo

ToJSON DepInfo

FromJSON DepInfo

data Component

Constructors

CompLibrary

CompExecutable

CompTestSuite

CompBenchmark

Instances

Bounded Component

Enum Component

Eq Component

Ord Component

Read Component

Show Component

ToJSON Component

FromJSON Component

data SnapName

The name of an LTS Haskell or Stackage Nightly snapshot.

Constructors

LTS !Int !Int

Nightly !Day

Instances

Eq SnapName

Ord SnapName

Show SnapName

data MiniBuildPlan

A simplified version of the BuildPlan + cabal file.

Constructors

MiniBuildPlan

Fields

mbpGhcVersion :: !Version

mbpPackages :: !(Map PackageName MiniPackageInfo)

Instances

Eq MiniBuildPlan

Show MiniBuildPlan

Generic MiniBuildPlan

Binary MiniBuildPlan

type Rep MiniBuildPlan

data MiniPackageInfo

Information on a single package for the MiniBuildPlan.

Constructors

MiniPackageInfo

Fields

mpiVersion :: !Version

mpiFlags :: !(Map FlagName Bool)

mpiPackageDeps :: !(Set PackageName)

mpiToolDeps :: !(Set ByteString)

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 ByteString.

mpiExes :: !(Set ExeName)

Executables provided by this package

mpiHasLibrary :: !Bool

Is there a library present?

Instances

Eq MiniPackageInfo

Show MiniPackageInfo

Generic MiniPackageInfo

Binary MiniPackageInfo

type Rep MiniPackageInfo

renderSnapName :: SnapName -> Text

Convert a SnapName into its short representation, e.g. lts-2.8, nightly-2015-03-05.

parseSnapName :: MonadThrow m => Text -> m SnapName

Parse the short representation of a SnapName.