Stackage.Types

Shared types for various stackage packages.

Types

data SnapshotType

Constructors

STNightly

STNightly2 !Day

STLTS !Int !Int

major, minor

Instances

Eq SnapshotType

Methods

(==) :: SnapshotType -> SnapshotType -> Bool

(/=) :: SnapshotType -> SnapshotType -> Bool

Ord SnapshotType

Methods

compare :: SnapshotType -> SnapshotType -> Ordering

(<) :: SnapshotType -> SnapshotType -> Bool

(<=) :: SnapshotType -> SnapshotType -> Bool

(>) :: SnapshotType -> SnapshotType -> Bool

(>=) :: SnapshotType -> SnapshotType -> Bool

max :: SnapshotType -> SnapshotType -> SnapshotType

min :: SnapshotType -> SnapshotType -> SnapshotType

Read SnapshotType

Methods

readsPrec :: Int -> ReadS SnapshotType

readList :: ReadS [SnapshotType]

readPrec :: ReadPrec SnapshotType

readListPrec :: ReadPrec [SnapshotType]

Show SnapshotType

Methods

showsPrec :: Int -> SnapshotType -> ShowS

show :: SnapshotType -> String

showList :: [SnapshotType] -> ShowS

ToJSON SnapshotType

Methods

toJSON :: SnapshotType -> Value

toEncoding :: SnapshotType -> Encoding

toJSONList :: [SnapshotType] -> Value

toEncodingList :: [SnapshotType] -> Encoding

FromJSON SnapshotType

Methods

parseJSON :: Value -> Parser SnapshotType

parseJSONList :: Value -> Parser [SnapshotType]

type DocMap = Map Text PackageDocs

Package name is key

data PackageDocs

Constructors

PackageDocs

Fields

• pdVersion :: Text
• pdModules :: Map Text [Text]

  module name, path

Instances

ToJSON PackageDocs

Methods

toJSON :: PackageDocs -> Value

toEncoding :: PackageDocs -> Encoding

toJSONList :: [PackageDocs] -> Value

toEncodingList :: [PackageDocs] -> Encoding

FromJSON PackageDocs

Methods

parseJSON :: Value -> Parser PackageDocs

parseJSONList :: Value -> Parser [PackageDocs]

data BuildPlan

Constructors

BuildPlan

Fields

• bpSystemInfo :: SystemInfo
• bpTools :: Vector (PackageName, Version)
• bpPackages :: Map PackageName PackagePlan
• bpGithubUsers :: Map Text (Set Text)
• bpBuildToolOverrides :: Map Text (Set Text)
• bpAllCabalHashesCommit :: Maybe Text
• bpNoRevisions :: !(Set PackageName)

  Packages where we ignore Hackage revisions

• bpCabalFormatVersion :: !(Maybe Version)

  Maximum allowed version of the Cabal file format

Instances

Eq BuildPlan

Methods

(==) :: BuildPlan -> BuildPlan -> Bool

(/=) :: BuildPlan -> BuildPlan -> Bool

Show BuildPlan

Methods

showsPrec :: Int -> BuildPlan -> ShowS

show :: BuildPlan -> String

showList :: [BuildPlan] -> ShowS

ToJSON BuildPlan

Methods

toJSON :: BuildPlan -> Value

toEncoding :: BuildPlan -> Encoding

toJSONList :: [BuildPlan] -> Value

toEncodingList :: [BuildPlan] -> Encoding

FromJSON BuildPlan

Methods

parseJSON :: Value -> Parser BuildPlan

parseJSONList :: Value -> Parser [BuildPlan]

data PackagePlan

Constructors

PackagePlan

Fields

• ppVersion :: Version
• ppCabalFileInfo :: Maybe CabalFileInfo
• ppGithubPings :: Set Text
• ppUsers :: Set PackageName
• ppConstraints :: PackageConstraints
• ppDesc :: SimpleDesc
• ppSourceUrl :: Maybe Text

Instances

Eq PackagePlan

Methods

(==) :: PackagePlan -> PackagePlan -> Bool

(/=) :: PackagePlan -> PackagePlan -> Bool

Show PackagePlan

Methods

showsPrec :: Int -> PackagePlan -> ShowS

show :: PackagePlan -> String

showList :: [PackagePlan] -> ShowS

ToJSON PackagePlan

Methods

toJSON :: PackagePlan -> Value

toEncoding :: PackagePlan -> Encoding

toJSONList :: [PackagePlan] -> Value

toEncodingList :: [PackagePlan] -> Encoding

FromJSON PackagePlan

Methods

parseJSON :: Value -> Parser PackagePlan

parseJSONList :: Value -> Parser [PackagePlan]

data PackageConstraints

Constructors

PackageConstraints

Fields

• pcVersionRange :: VersionRange
• pcMaintainer :: Maybe Maintainer
• pcTests :: TestState
• pcBenches :: TestState
• pcHaddocks :: TestState
• pcFlagOverrides :: Map FlagName Bool
• pcConfigureArgs :: Vector Text
• pcEnableLibProfile :: Bool
• pcSkipBuild :: Bool

  Don't even bother building this library, useful when dealing with OS-specific packages. See: https://github.com/fpco/stackage-curator/issues/3

• pcHide :: !Bool

  Hide this package after registering, useful for avoiding module name conflicts

Instances

Eq PackageConstraints

Methods

(==) :: PackageConstraints -> PackageConstraints -> Bool

(/=) :: PackageConstraints -> PackageConstraints -> Bool

Show PackageConstraints

Methods

showsPrec :: Int -> PackageConstraints -> ShowS

show :: PackageConstraints -> String

showList :: [PackageConstraints] -> ShowS

ToJSON PackageConstraints

Methods

toJSON :: PackageConstraints -> Value

toEncoding :: PackageConstraints -> Encoding

toJSONList :: [PackageConstraints] -> Value

toEncodingList :: [PackageConstraints] -> Encoding

FromJSON PackageConstraints

Methods

parseJSON :: Value -> Parser PackageConstraints

parseJSONList :: Value -> Parser [PackageConstraints]

data ParseFailedException

Constructors

ParseFailedException TypeRep Text

Instances

Show ParseFailedException

Methods

showsPrec :: Int -> ParseFailedException -> ShowS

show :: ParseFailedException -> String

showList :: [ParseFailedException] -> ShowS

Exception ParseFailedException

Methods

toException :: ParseFailedException -> SomeException

fromException :: SomeException -> Maybe ParseFailedException

displayException :: ParseFailedException -> String

data TestState

Constructors

ExpectSuccess

ExpectFailure

Don'tBuild

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

Instances

Bounded TestState

Methods

minBound :: TestState

maxBound :: TestState

Enum TestState

Methods

succ :: TestState -> TestState

pred :: TestState -> TestState

toEnum :: Int -> TestState

fromEnum :: TestState -> Int

enumFrom :: TestState -> [TestState]

enumFromThen :: TestState -> TestState -> [TestState]

enumFromTo :: TestState -> TestState -> [TestState]

enumFromThenTo :: TestState -> TestState -> TestState -> [TestState]

Eq TestState

Methods

(==) :: TestState -> TestState -> Bool

(/=) :: TestState -> TestState -> Bool

Ord TestState

Methods

compare :: TestState -> TestState -> Ordering

(<) :: TestState -> TestState -> Bool

(<=) :: TestState -> TestState -> Bool

(>) :: TestState -> TestState -> Bool

(>=) :: TestState -> TestState -> Bool

max :: TestState -> TestState -> TestState

min :: TestState -> TestState -> TestState

Show TestState

Methods

showsPrec :: Int -> TestState -> ShowS

show :: TestState -> String

showList :: [TestState] -> ShowS

ToJSON TestState

Methods

toJSON :: TestState -> Value

toEncoding :: TestState -> Encoding

toJSONList :: [TestState] -> Value

toEncodingList :: [TestState] -> Encoding

FromJSON TestState

Methods

parseJSON :: Value -> Parser TestState

parseJSONList :: Value -> Parser [TestState]

data SystemInfo

Constructors

SystemInfo

Fields

• siGhcVersion :: Version
• siOS :: OS
• siArch :: Arch
• siCorePackages :: Map PackageName Version
• siCoreExecutables :: Set ExeName

Instances

Eq SystemInfo

Methods

(==) :: SystemInfo -> SystemInfo -> Bool

(/=) :: SystemInfo -> SystemInfo -> Bool

Ord SystemInfo

Methods

compare :: SystemInfo -> SystemInfo -> Ordering

(<) :: SystemInfo -> SystemInfo -> Bool

(<=) :: SystemInfo -> SystemInfo -> Bool

(>) :: SystemInfo -> SystemInfo -> Bool

(>=) :: SystemInfo -> SystemInfo -> Bool

max :: SystemInfo -> SystemInfo -> SystemInfo

min :: SystemInfo -> SystemInfo -> SystemInfo

Show SystemInfo

Methods

showsPrec :: Int -> SystemInfo -> ShowS

show :: SystemInfo -> String

showList :: [SystemInfo] -> ShowS

ToJSON SystemInfo

Methods

toJSON :: SystemInfo -> Value

toEncoding :: SystemInfo -> Encoding

toJSONList :: [SystemInfo] -> Value

toEncodingList :: [SystemInfo] -> Encoding

FromJSON SystemInfo

Methods

parseJSON :: Value -> Parser SystemInfo

parseJSONList :: Value -> Parser [SystemInfo]

newtype Maintainer

Constructors

Maintainer

Fields

• unMaintainer :: Text

Instances

Eq Maintainer

Methods

(==) :: Maintainer -> Maintainer -> Bool

(/=) :: Maintainer -> Maintainer -> Bool

Ord Maintainer

Methods

compare :: Maintainer -> Maintainer -> Ordering

(<) :: Maintainer -> Maintainer -> Bool

(<=) :: Maintainer -> Maintainer -> Bool

(>) :: Maintainer -> Maintainer -> Bool

(>=) :: Maintainer -> Maintainer -> Bool

max :: Maintainer -> Maintainer -> Maintainer

min :: Maintainer -> Maintainer -> Maintainer

Show Maintainer

Methods

showsPrec :: Int -> Maintainer -> ShowS

show :: Maintainer -> String

showList :: [Maintainer] -> ShowS

IsString Maintainer

Methods

fromString :: String -> Maintainer

Hashable Maintainer

Methods

hashWithSalt :: Int -> Maintainer -> Int

hash :: Maintainer -> Int

ToJSON Maintainer

Methods

toJSON :: Maintainer -> Value

toEncoding :: Maintainer -> Encoding

toJSONList :: [Maintainer] -> Value

toEncodingList :: [Maintainer] -> Encoding

FromJSON Maintainer

Methods

parseJSON :: Value -> Parser Maintainer

parseJSONList :: Value -> Parser [Maintainer]

newtype ExeName

Name of an executable.

Constructors

ExeName

Fields

• unExeName :: Text

Instances

Eq ExeName

Methods

(==) :: ExeName -> ExeName -> Bool

(/=) :: ExeName -> ExeName -> Bool

Ord ExeName

Methods

compare :: ExeName -> ExeName -> Ordering

(<) :: ExeName -> ExeName -> Bool

(<=) :: ExeName -> ExeName -> Bool

(>) :: ExeName -> ExeName -> Bool

(>=) :: ExeName -> ExeName -> Bool

max :: ExeName -> ExeName -> ExeName

min :: ExeName -> ExeName -> ExeName

Show ExeName

Methods

showsPrec :: Int -> ExeName -> ShowS

show :: ExeName -> String

showList :: [ExeName] -> ShowS

IsString ExeName

Methods

fromString :: String -> ExeName

Generic ExeName

Associated Types

type Rep ExeName :: * -> *

Methods

from :: ExeName -> Rep ExeName x

to :: Rep ExeName x -> ExeName

Hashable ExeName

Methods

hashWithSalt :: Int -> ExeName -> Int

hash :: ExeName -> Int

ToJSON ExeName

Methods

toJSON :: ExeName -> Value

toEncoding :: ExeName -> Encoding

toJSONList :: [ExeName] -> Value

toEncodingList :: [ExeName] -> Encoding

FromJSON ExeName

Methods

parseJSON :: Value -> Parser ExeName

parseJSONList :: Value -> Parser [ExeName]

Store ExeName

Methods

size :: Size ExeName

poke :: ExeName -> Poke ()

peek :: Peek ExeName

type Rep ExeName

type Rep ExeName = D1 (MetaData "ExeName" "Stackage.Types" "stackage-curator-0.15.0.0-8trSdbTq3Td90E9cWwn9G6" True) (C1 (MetaCons "ExeName" PrefixI True) (S1 (MetaSel (Just Symbol "unExeName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

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

• sdCabalVersion :: Option (Max Version)

  minimum acceptable Cabal version

• sdSetupDeps :: Maybe (Set PackageName)

Instances

Eq SimpleDesc

Methods

(==) :: SimpleDesc -> SimpleDesc -> Bool

(/=) :: SimpleDesc -> SimpleDesc -> Bool

Show SimpleDesc

Methods

showsPrec :: Int -> SimpleDesc -> ShowS

show :: SimpleDesc -> String

showList :: [SimpleDesc] -> ShowS

Monoid SimpleDesc

Methods

mempty :: SimpleDesc

mappend :: SimpleDesc -> SimpleDesc -> SimpleDesc

mconcat :: [SimpleDesc] -> SimpleDesc

ToJSON SimpleDesc

Methods

toJSON :: SimpleDesc -> Value

toEncoding :: SimpleDesc -> Encoding

toJSONList :: [SimpleDesc] -> Value

toEncodingList :: [SimpleDesc] -> Encoding

FromJSON SimpleDesc

Methods

parseJSON :: Value -> Parser SimpleDesc

parseJSONList :: Value -> Parser [SimpleDesc]

data DepInfo

Constructors

DepInfo

Fields

• diComponents :: Set Component
• diRange :: VersionRange

Instances

Eq DepInfo

Methods

(==) :: DepInfo -> DepInfo -> Bool

(/=) :: DepInfo -> DepInfo -> Bool

Show DepInfo

Methods

showsPrec :: Int -> DepInfo -> ShowS

show :: DepInfo -> String

showList :: [DepInfo] -> ShowS

Semigroup DepInfo

Methods

(<>) :: DepInfo -> DepInfo -> DepInfo

sconcat :: NonEmpty DepInfo -> DepInfo

stimes :: Integral b => b -> DepInfo -> DepInfo

ToJSON DepInfo

Methods

toJSON :: DepInfo -> Value

toEncoding :: DepInfo -> Encoding

toJSONList :: [DepInfo] -> Value

toEncodingList :: [DepInfo] -> Encoding

FromJSON DepInfo

Methods

parseJSON :: Value -> Parser DepInfo

parseJSONList :: Value -> Parser [DepInfo]

data Component

Constructors

CompLibrary

CompExecutable

CompTestSuite

CompBenchmark

Instances

Bounded Component

Methods

minBound :: Component

maxBound :: Component

Enum Component

Methods

succ :: Component -> Component

pred :: Component -> Component

toEnum :: Int -> Component

fromEnum :: Component -> Int

enumFrom :: Component -> [Component]

enumFromThen :: Component -> Component -> [Component]

enumFromTo :: Component -> Component -> [Component]

enumFromThenTo :: Component -> Component -> Component -> [Component]

Eq Component

Methods

(==) :: Component -> Component -> Bool

(/=) :: Component -> Component -> Bool

Ord Component

Methods

compare :: Component -> Component -> Ordering

(<) :: Component -> Component -> Bool

(<=) :: Component -> Component -> Bool

(>) :: Component -> Component -> Bool

(>=) :: Component -> Component -> Bool

max :: Component -> Component -> Component

min :: Component -> Component -> Component

Read Component

Methods

readsPrec :: Int -> ReadS Component

readList :: ReadS [Component]

readPrec :: ReadPrec Component

readListPrec :: ReadPrec [Component]

Show Component

Methods

showsPrec :: Int -> Component -> ShowS

show :: Component -> String

showList :: [Component] -> ShowS

ToJSON Component

Methods

toJSON :: Component -> Value

toEncoding :: Component -> Encoding

toJSONList :: [Component] -> Value

toEncodingList :: [Component] -> Encoding

FromJSON Component

Methods

parseJSON :: Value -> Parser Component

parseJSONList :: Value -> Parser [Component]

data CabalFileInfo

Information on the contents of a cabal file

Constructors

CabalFileInfo

Fields

• cfiSize :: !Int

  File size in bytes

• cfiHashes :: !(Map Text Text)

  Various hashes of the file contents

Instances

Eq CabalFileInfo

Methods

(==) :: CabalFileInfo -> CabalFileInfo -> Bool

(/=) :: CabalFileInfo -> CabalFileInfo -> Bool

Show CabalFileInfo

Methods

showsPrec :: Int -> CabalFileInfo -> ShowS

show :: CabalFileInfo -> String

showList :: [CabalFileInfo] -> ShowS

Generic CabalFileInfo

Associated Types

type Rep CabalFileInfo :: * -> *

Methods

from :: CabalFileInfo -> Rep CabalFileInfo x

to :: Rep CabalFileInfo x -> CabalFileInfo

ToJSON CabalFileInfo

Methods

toJSON :: CabalFileInfo -> Value

toEncoding :: CabalFileInfo -> Encoding

toJSONList :: [CabalFileInfo] -> Value

toEncodingList :: [CabalFileInfo] -> Encoding

FromJSON CabalFileInfo

Methods

parseJSON :: Value -> Parser CabalFileInfo

parseJSONList :: Value -> Parser [CabalFileInfo]

Store CabalFileInfo

Methods

size :: Size CabalFileInfo

poke :: CabalFileInfo -> Poke ()

peek :: Peek CabalFileInfo

type Rep CabalFileInfo

type Rep CabalFileInfo = D1 (MetaData "CabalFileInfo" "Stackage.Types" "stackage-curator-0.15.0.0-8trSdbTq3Td90E9cWwn9G6" False) (C1 (MetaCons "CabalFileInfo" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "cfiSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "cfiHashes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map Text Text)))))

Helper functions

display :: Text a => a -> Text

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

unPackageName :: PackageName -> String

Convert PackageName to String

mkPackageName :: String -> PackageName

Construct a PackageName from a String

mkPackageName is the inverse to unPackageName

Note: No validations are performed to ensure that the resulting PackageName is valid

Since: 2.0

unFlagName :: FlagName -> String

Convert FlagName to String

Since: 2.0

mkFlagName :: String -> FlagName

Construct a FlagName from a String

mkFlagName is the inverse to unFlagName

Note: No validations are performed to ensure that the resulting FlagName is valid

Since: 2.0

intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange

compToText :: Component -> Text