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.

Represents a build-plan unit uniquely identified by its UnitId

Component name inside a build-plan unit

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

Pretty print CompName

Describes component-specific information inside a Unit

Describes kind of build unit and its provenance

Equivalent to Cabal's Distribution.Package.Version

Pretty print Ver

Equivalent to Cabal's Distribution.Package.PackageName

Equivalent to Cabal's Distribution.Package.PackageIdentifier

Pretty print PkgId

Equivalent to Cabal's Distribution.Package.UnitId

Equivalent to Cabal's Distribution.PackageDescription.FlagName

Since: cabal-plan-0.3.0.0

SHA-256 hash

Pretty print Sha256 as base-16.

Parse base-16 encoded Sha256.

Returns Nothing in case of parsing failure.

Since: cabal-plan-0.3.0.0

Export the Sha256 digest to a 32-byte ByteString.

Since: cabal-plan-0.3.0.0

Import the Sha256 digest from a 32-byte ByteString.

Returns Nothing if input ByteString has incorrect length.

Since: cabal-plan-0.3.0.0

Extract directed UnitId dependency graph edges from pjUnits

This graph contains both, library and executable dependencies edges

Extract UnitId root nodes from dependency graph computed by planJsonIdGraph

Where/how to search for the plan.json file.

Locates the project root for cabal project relative to specified directory.

plan.json is located from either the optional build dir argument, or in the default directory (dist-newstyle) relative to the project root.

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

This function determines the project root in a slightly more liberal manner than cabal-install. If no cabal.project is found, cabal-install assumes an implicit cabal.project if the current directory contains any *.cabal files.

This function looks for any *.cabal files in directories above the current one and behaves as if there is an implicit cabal.project in that directory when looking for a plan.json.

Throws IO exceptions on errors.

Find project root relative to a directory, this emulates cabal's current heuristic, but is slightly more liberal. If no cabal.project is found, cabal-install looks for *.cabal files in the specified directory only. This function also considers *.cabal files in directories higher up in the hierarchy.

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.