Safe Haskell	None
Language	GHC2021

Cabal.Matrix.CabalArgs

Description

Converting high-level build matrix concepts into cabal commandlines.

Synopsis

data CabalArgs = CabalArgs {
- cabalExecutable :: FilePath
- mode :: CabalMode
- step :: CabalStep
- options :: [Text]
- targets :: [Text]
- flavor :: Flavor
}
data CabalStep
- = DryRun
- | OnlyDownload
- | OnlyDependencies
- | FullBuild
data PerCabalStep a = PerCabalStep {
- dryRun :: a
- onlyDownload :: a
- onlyDependencies :: a
- fullBuild :: a
}
indexCabalStep :: PerCabalStep a -> CabalStep -> a
tabulateCabalStep' :: (CabalStep -> a) -> PerCabalStep a
modifyCabalStep :: CabalStep -> (a -> a) -> PerCabalStep a -> PerCabalStep a
setCabalStep :: CabalStep -> a -> PerCabalStep a -> PerCabalStep a
data CabalMode
- = ProjectBuild
- | InstallLib
data Flavor = Flavor {
- unorderedOptions :: Set Text
- orderedOptions :: [Text]
}
renderCabalArgs :: CabalArgs -> NonEmpty Text
environmentFilePath :: CabalArgs -> Maybe FilePath

Documentation

data CabalArgs Source #

A single invocation of cabal.

Constructors

CabalArgs
Fields cabalExecutable :: FilePath mode :: CabalMode step :: CabalStep options :: [Text] targets :: [Text] flavor :: Flavor

data CabalStep Source #

Cabal allows interrupting the build process at multiple points, which is useful to know which stage the build failed at.

Constructors

DryRun	Run with `--dry-run`, only creating a plan.
OnlyDownload	Run with `--only-download`, creating a plan and only downloading dependencies.
OnlyDependencies	Run with `--only-dependencies`, creating a plan, downloading and building only the dependencies.
FullBuild	Run without any of the aforementioned options, fully building the selected targets.

Instances

Instances details

Bounded CabalStep Source #
Instance details Defined in Cabal.Matrix.CabalArgs Methods minBound :: CabalStep # maxBound :: CabalStep #
Enum CabalStep Source #
Instance details Defined in Cabal.Matrix.CabalArgs Methods succ :: CabalStep -> CabalStep # pred :: CabalStep -> CabalStep # toEnum :: Int -> CabalStep # fromEnum :: CabalStep -> Int # enumFrom :: CabalStep -> [CabalStep] # enumFromThen :: CabalStep -> CabalStep -> [CabalStep] # enumFromTo :: CabalStep -> CabalStep -> [CabalStep] # enumFromThenTo :: CabalStep -> CabalStep -> CabalStep -> [CabalStep] #
Show CabalStep Source #
Instance details Defined in Cabal.Matrix.CabalArgs Methods showsPrec :: Int -> CabalStep -> ShowS # show :: CabalStep -> String # showList :: [CabalStep] -> ShowS #
Eq CabalStep Source #
Instance details Defined in Cabal.Matrix.CabalArgs Methods (==) :: CabalStep -> CabalStep -> Bool # (/=) :: CabalStep -> CabalStep -> Bool #
Ord CabalStep Source #
Instance details Defined in Cabal.Matrix.CabalArgs Methods compare :: CabalStep -> CabalStep -> Ordering # (<) :: CabalStep -> CabalStep -> Bool # (<=) :: CabalStep -> CabalStep -> Bool # (>) :: CabalStep -> CabalStep -> Bool # (>=) :: CabalStep -> CabalStep -> Bool # max :: CabalStep -> CabalStep -> CabalStep # min :: CabalStep -> CabalStep -> CabalStep #

data PerCabalStep a Source #

A collection of values per each CabalStep. Useful for "memoizing" a function CabalStep -> a.

Constructors

PerCabalStep
Fields dryRun :: a onlyDownload :: a onlyDependencies :: a fullBuild :: a

Instances

Instances details

Foldable PerCabalStep Source #
Instance details Defined in Cabal.Matrix.CabalArgs Methods fold :: Monoid m => PerCabalStep m -> m # foldMap :: Monoid m => (a -> m) -> PerCabalStep a -> m # foldMap' :: Monoid m => (a -> m) -> PerCabalStep a -> m # foldr :: (a -> b -> b) -> b -> PerCabalStep a -> b # foldr' :: (a -> b -> b) -> b -> PerCabalStep a -> b # foldl :: (b -> a -> b) -> b -> PerCabalStep a -> b # foldl' :: (b -> a -> b) -> b -> PerCabalStep a -> b # foldr1 :: (a -> a -> a) -> PerCabalStep a -> a # foldl1 :: (a -> a -> a) -> PerCabalStep a -> a # toList :: PerCabalStep a -> [a] # null :: PerCabalStep a -> Bool # length :: PerCabalStep a -> Int # elem :: Eq a => a -> PerCabalStep a -> Bool # maximum :: Ord a => PerCabalStep a -> a # minimum :: Ord a => PerCabalStep a -> a # sum :: Num a => PerCabalStep a -> a # product :: Num a => PerCabalStep a -> a #
Traversable PerCabalStep Source #
Instance details Defined in Cabal.Matrix.CabalArgs Methods traverse :: Applicative f => (a -> f b) -> PerCabalStep a -> f (PerCabalStep b) # sequenceA :: Applicative f => PerCabalStep (f a) -> f (PerCabalStep a) # mapM :: Monad m => (a -> m b) -> PerCabalStep a -> m (PerCabalStep b) # sequence :: Monad m => PerCabalStep (m a) -> m (PerCabalStep a) #
Functor PerCabalStep Source #
Instance details Defined in Cabal.Matrix.CabalArgs Methods fmap :: (a -> b) -> PerCabalStep a -> PerCabalStep b # (<$) :: a -> PerCabalStep b -> PerCabalStep a #

indexCabalStep :: PerCabalStep a -> CabalStep -> a Source #

tabulateCabalStep' :: (CabalStep -> a) -> PerCabalStep a Source #

Note: the function is evaluated (to WHNF) at each input.

modifyCabalStep :: CabalStep -> (a -> a) -> PerCabalStep a -> PerCabalStep a Source #

setCabalStep :: CabalStep -> a -> PerCabalStep a -> PerCabalStep a Source #

data CabalMode Source #

In either case if we are in a cabal project then we can only install packages that are in the dependency closure of the project, and they will be subject to constraints defined in the project file, if any.

Constructors