Safe Haskell	None
Language	Haskell2010

Stackage.Types

Contents

Types
Helper functions

Description

Shared types for various stackage packages.

Synopsis

Types

data SnapshotType Source

Constructors

STNightly
STLTS !Int !Int	major, minor

Instances

Eq SnapshotType
Ord SnapshotType
Read SnapshotType
Show SnapshotType
ToJSON SnapshotType
FromJSON SnapshotType

type DocMap = Map Text PackageDocs Source

Package name is key

data PackageDocs Source

Constructors

PackageDocs
Fields pdVersion :: Text pdModules :: Map Text [Text] module name, path

Instances

ToJSON PackageDocs
FromJSON PackageDocs

data BuildPlan Source

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 Source

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 Source

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 ParseFailedException Source

Constructors

ParseFailedException TypeRep Text

Instances

Show ParseFailedException
Exception ParseFailedException
Typeable * ParseFailedException

data TestState Source

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 Source

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 Source

Constructors

Maintainer
Fields unMaintainer :: Text

Instances

Eq Maintainer
Ord Maintainer
Show Maintainer
IsString Maintainer
ToJSON Maintainer
FromJSON Maintainer
Hashable Maintainer

newtype ExeName Source

Name of an executable.

Constructors

ExeName
Fields unExeName :: Text

Instances

Eq ExeName
Ord ExeName
Show ExeName
IsString ExeName
ToJSON ExeName
FromJSON ExeName
Hashable ExeName

data SimpleDesc Source

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 Source

Constructors

DepInfo
Fields diComponents :: Set Component diRange :: VersionRange

Instances

Eq DepInfo
Show DepInfo
ToJSON DepInfo
FromJSON DepInfo
Semigroup DepInfo

data Component Source

Constructors

CompLibrary
CompExecutable
CompTestSuite
CompBenchmark

Instances

Bounded Component
Enum Component
Eq Component
Ord Component
Read Component
Show Component
ToJSON Component
FromJSON Component

Helper functions

display :: Text a => a -> Text Source

simpleParse :: (MonadThrow m, Text a, Typeable a) => Text -> m a Source

unPackageName :: PackageName -> Text Source

mkPackageName :: Text -> PackageName Source

unFlagName :: FlagName -> Text Source

mkFlagName :: Text -> FlagName Source

intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange Source