Cabal.Plan

Utilities for reading cabal's plan.json file

plan.json are generated when using cabal Nix-style Local Builds.

Documentation

data PlanJson

Represents the information contained in cabal's plan.json file.

This comprises basic information describing the environment as well as the install/build plan computed by cabal.

Constructors

PlanJson

Fields

• pjCabalVersion :: !Ver

  Version of cabal frontend

• pjCabalLibVersion :: !Ver

  Version of Cabal library

• pjCompilerId :: !PkgId

  Name and version of Haskell compiler

• pjArch :: !Text

  Architecture name

• pjOs :: !Text

  Operating system name

• pjUnits :: !(Map UnitId Unit)

  install/build plan

Instances

Show PlanJson

Methods

showsPrec :: Int -> PlanJson -> ShowS

show :: PlanJson -> String

showList :: [PlanJson] -> ShowS

FromJSON PlanJson

Methods

parseJSON :: Value -> Parser PlanJson

parseJSONList :: Value -> Parser [PlanJson]

data Unit

Represents a build-plan unit uniquely identified by its UnitId

Constructors

Unit

Fields

• uId :: !UnitId

  Unit ID uniquely identifying a Unit in install plan

• uPId :: !PkgId

  Package name and version (not necessarily unique within plan)

• uType :: !UnitType

  Describes type of build item, see UnitType

• uSha256 :: !(Maybe Sha256)

  SHA256 source tarball checksum (as used by e.g. hackage-security)

• uComps :: !(Map CompName CompInfo)

  Components identified by UnitId

  When cabal needs to fall back to legacy-mode (currently for custom build-types or obsolete cabal-version values), uComps may contain more than one element.

• uFlags :: !(Map Text Bool)

  cabal flag settings (not available for UnitTypeBuiltin)

Instances

Show Unit

Methods

showsPrec :: Int -> Unit -> ShowS

show :: Unit -> String

showList :: [Unit] -> ShowS

FromJSON Unit

Methods

parseJSON :: Value -> Parser Unit

parseJSONList :: Value -> Parser [Unit]

data CompName

Component name inside a build-plan unit

A similiar type exists in Cabal codebase, see Distribution.Simple.LocalBuildInfo.ComponentName

Constructors

CompNameLib

CompNameSubLib !Text

CompNameExe !Text

CompNameTest !Text

CompNameBench !Text

CompNameSetup

Instances

Eq CompName

Methods

(==) :: CompName -> CompName -> Bool

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

Ord CompName

Methods

compare :: CompName -> CompName -> Ordering

(<) :: CompName -> CompName -> Bool

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

(>) :: CompName -> CompName -> Bool

(>=) :: CompName -> CompName -> Bool

max :: CompName -> CompName -> CompName

min :: CompName -> CompName -> CompName

Show CompName

Methods

showsPrec :: Int -> CompName -> ShowS

show :: CompName -> String

showList :: [CompName] -> ShowS

ToJSON CompName

Methods

toJSON :: CompName -> Value

toEncoding :: CompName -> Encoding

toJSONList :: [CompName] -> Value

toEncodingList :: [CompName] -> Encoding

ToJSONKey CompName

Methods

toJSONKey :: ToJSONKeyFunction CompName

toJSONKeyList :: ToJSONKeyFunction [CompName]

FromJSON CompName

Methods

parseJSON :: Value -> Parser CompName

parseJSONList :: Value -> Parser [CompName]

FromJSONKey CompName

Methods

fromJSONKey :: FromJSONKeyFunction CompName

fromJSONKeyList :: FromJSONKeyFunction [CompName]

dispCompName :: CompName -> Text

Pretty print CompName

data CompInfo

Describes component-specific information inside a Unit

Constructors

CompInfo

Fields

• ciLibDeps :: Set UnitId

  library dependencies

• ciExeDeps :: Set UnitId

  executable dependencies

• ciBinFile :: Maybe FilePath

  path-name of artifact if available

Instances

Show CompInfo

Methods

showsPrec :: Int -> CompInfo -> ShowS

show :: CompInfo -> String

showList :: [CompInfo] -> ShowS

FromJSON CompInfo

Methods

parseJSON :: Value -> Parser CompInfo

parseJSONList :: Value -> Parser [CompInfo]

data UnitType

Describes kind of build unit and its provenance

Constructors

UnitTypeBuiltin

Lives in global (non-nix-style) package db

UnitTypeGlobal

Lives in Nix-store cache

UnitTypeLocal

Local package

UnitTypeInplace

Local in-place package

Instances

Eq UnitType

Methods

(==) :: UnitType -> UnitType -> Bool

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

Show UnitType

Methods

showsPrec :: Int -> UnitType -> ShowS

show :: UnitType -> String

showList :: [UnitType] -> ShowS

Basic types

newtype Ver

Equivalent to Cabal's Distribution.Package.Version

Constructors

Ver [Int]

Instances

Eq Ver

Methods

(==) :: Ver -> Ver -> Bool

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

Ord Ver

Methods

compare :: Ver -> Ver -> Ordering

(<) :: Ver -> Ver -> Bool

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

(>) :: Ver -> Ver -> Bool

(>=) :: Ver -> Ver -> Bool

max :: Ver -> Ver -> Ver

min :: Ver -> Ver -> Ver

Show Ver

Methods

showsPrec :: Int -> Ver -> ShowS

show :: Ver -> String

showList :: [Ver] -> ShowS

ToJSON Ver

Methods

toJSON :: Ver -> Value

toEncoding :: Ver -> Encoding

toJSONList :: [Ver] -> Value

toEncodingList :: [Ver] -> Encoding

FromJSON Ver

Methods

parseJSON :: Value -> Parser Ver

parseJSONList :: Value -> Parser [Ver]

dispVer :: Ver -> Text

Pretty print Ver

newtype PkgName

Equivalent to Cabal's Distribution.Package.PackageName

Constructors

PkgName Text

Instances

Eq PkgName

Methods

(==) :: PkgName -> PkgName -> Bool

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

Ord PkgName

Methods

compare :: PkgName -> PkgName -> Ordering

(<) :: PkgName -> PkgName -> Bool

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

(>) :: PkgName -> PkgName -> Bool

(>=) :: PkgName -> PkgName -> Bool

max :: PkgName -> PkgName -> PkgName

min :: PkgName -> PkgName -> PkgName

Show PkgName

Methods

showsPrec :: Int -> PkgName -> ShowS

show :: PkgName -> String

showList :: [PkgName] -> ShowS

ToJSON PkgName

Methods

toJSON :: PkgName -> Value

toEncoding :: PkgName -> Encoding

toJSONList :: [PkgName] -> Value

toEncodingList :: [PkgName] -> Encoding

FromJSON PkgName

Methods

parseJSON :: Value -> Parser PkgName

parseJSONList :: Value -> Parser [PkgName]

data PkgId

Equivalent to Cabal's Distribution.Package.PackageIdentifier

Constructors

PkgId !PkgName !Ver

Instances

Eq PkgId

Methods

(==) :: PkgId -> PkgId -> Bool

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

Ord PkgId

Methods

compare :: PkgId -> PkgId -> Ordering

(<) :: PkgId -> PkgId -> Bool

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

(>) :: PkgId -> PkgId -> Bool

(>=) :: PkgId -> PkgId -> Bool

max :: PkgId -> PkgId -> PkgId

min :: PkgId -> PkgId -> PkgId

Show PkgId

Methods

showsPrec :: Int -> PkgId -> ShowS

show :: PkgId -> String

showList :: [PkgId] -> ShowS

ToJSON PkgId

Methods

toJSON :: PkgId -> Value

toEncoding :: PkgId -> Encoding

toJSONList :: [PkgId] -> Value

toEncodingList :: [PkgId] -> Encoding

FromJSON PkgId

Methods

parseJSON :: Value -> Parser PkgId

parseJSONList :: Value -> Parser [PkgId]

dispPkgId :: PkgId -> Text

Pretty print PkgId

newtype UnitId

Equivalent to Cabal's Distribution.Package.UnitId

Constructors

UnitId Text

Instances

Eq UnitId

Methods

(==) :: UnitId -> UnitId -> Bool

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

Ord UnitId

Methods

compare :: UnitId -> UnitId -> Ordering

(<) :: UnitId -> UnitId -> Bool

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

(>) :: UnitId -> UnitId -> Bool

(>=) :: UnitId -> UnitId -> Bool

max :: UnitId -> UnitId -> UnitId

min :: UnitId -> UnitId -> UnitId

Show UnitId

Methods

showsPrec :: Int -> UnitId -> ShowS

show :: UnitId -> String

showList :: [UnitId] -> ShowS

ToJSON UnitId

Methods

toJSON :: UnitId -> Value

toEncoding :: UnitId -> Encoding

toJSONList :: [UnitId] -> Value

toEncodingList :: [UnitId] -> Encoding

FromJSON UnitId

Methods

parseJSON :: Value -> Parser UnitId

parseJSONList :: Value -> Parser [UnitId]

newtype Sha256

SHA-256 hash

As an invariant, the wrapped ByteString is exactly 32 bytes long.

Constructors

Sha256 ByteString

Instances

Eq Sha256

Methods

(==) :: Sha256 -> Sha256 -> Bool

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

Ord Sha256

Methods

compare :: Sha256 -> Sha256 -> Ordering

(<) :: Sha256 -> Sha256 -> Bool

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

(>) :: Sha256 -> Sha256 -> Bool

(>=) :: Sha256 -> Sha256 -> Bool

max :: Sha256 -> Sha256 -> Sha256

min :: Sha256 -> Sha256 -> Sha256

Show Sha256

Methods

showsPrec :: Int -> Sha256 -> ShowS

show :: Sha256 -> String

showList :: [Sha256] -> ShowS

ToJSON Sha256

Methods

toJSON :: Sha256 -> Value

toEncoding :: Sha256 -> Encoding

toJSONList :: [Sha256] -> Value

toEncodingList :: [Sha256] -> Encoding

FromJSON Sha256

Methods

parseJSON :: Value -> Parser Sha256

parseJSONList :: Value -> Parser [Sha256]

dispSha256 :: Sha256 -> Text

Pretty print Sha256 as base-16

Utilities

planJsonIdGraph :: PlanJson -> Map UnitId (Set UnitId)

Extract directed UnitId dependency graph edges from pjUnits

This graph contains both, library and executable dependencies edges

planJsonIdRoots :: PlanJson -> Set UnitId

Extract UnitId root nodes from dependency graph computed by planJsonIdGraph

Convenience functions

findAndDecodePlanJson :: IO (PlanJson, FilePath)

Locates and decodes plan.json for cabal project being in scope for current working directory

The folder assumed to be the project-root is returned as well.

Throws IO exceptions on errors.

decodePlanJson :: FilePath -> IO PlanJson

Decodes plan.json file location provided as FilePath

This is a trivial convenience function so that the caller doesn't have to depend on aeson directly

Throws IO exceptions on errors.