Stack.Package

Dealing with Cabal.

Documentation

readPackageDir

Arguments

:: HasConfig env

=> PackageConfig

-> Path Abs Dir

-> Bool

print warnings from cabal file parsing?

-> RIO env (Package, Path Abs File)

Reads and exposes the package information

readPackageUnresolvedDir

Arguments

:: HasConfig env

=> Path Abs Dir

directory holding the cabal file

-> Bool

print warnings?

-> RIO env (GenericPackageDescription, Path Abs File)

Read the raw, unresolved package information from a file.

readPackageUnresolvedIndex :: forall env. HasCabalLoader env => PackageIdentifierRevision -> RIO env GenericPackageDescription

Read the GenericPackageDescription from the given PackageIdentifierRevision.

readPackageDescriptionDir

Arguments

:: HasConfig env

=> PackageConfig

-> Path Abs Dir

-> Bool

print warnings?

-> RIO env (GenericPackageDescription, PackageDescriptionPair)

Get GenericPackageDescription and PackageDescription reading info from given directory.

readDotBuildinfo :: MonadIO m => Path Abs File -> m HookedBuildInfo

Read package.buildinfo ancillary files produced by some Setup.hs hooks. The file includes Cabal file syntax to be merged into the package description derived from the package's .cabal file.

NOTE: not to be confused with BuildInfo, an Stack-internal datatype.

resolvePackage :: PackageConfig -> GenericPackageDescription -> Package

Resolve a parsed cabal file into a Package, which contains all of the info needed for stack to build the Package given the current configuration.

packageFromPackageDescription :: PackageConfig -> [Flag] -> PackageDescriptionPair -> Package

data Package

Some package info.

Constructors

Package

Fields

• packageName :: !PackageName

  Name of the package.

• packageVersion :: !Version

  Version of the package

• packageLicense :: !(Either License License)

  The license the package was released under.

• packageFiles :: !GetPackageFiles

  Get all files of the package.

• packageDeps :: !(Map PackageName DepValue)

  Packages that the package depends on, both as libraries and build tools.

• packageUnknownTools :: !(Set ExeName)

  Build tools specified in the legacy manner (build-tools:) that failed the hard-coded lookup.

• packageAllDeps :: !(Set PackageName)

  Original dependencies (not sieved).

• packageGhcOptions :: ![Text]

  Ghc options used on package.

• packageFlags :: !(Map FlagName Bool)

  Flags used on package.

• packageDefaultFlags :: !(Map FlagName Bool)

  Defaults for unspecified flags.

• packageLibraries :: !PackageLibraries

  does the package have a buildable library stanza?

• packageInternalLibraries :: !(Set Text)

  names of internal libraries

• packageTests :: !(Map Text TestSuiteInterface)

  names and interfaces of test suites

• packageBenchmarks :: !(Set Text)

  names of benchmarks

• packageExes :: !(Set Text)

  names of executables

• packageOpts :: !GetPackageOpts

  Args to pass to GHC.

• packageHasExposedModules :: !Bool

  Does the package have exposed modules?

• packageBuildType :: !BuildType

  Package build-type.

• packageSetupDeps :: !(Maybe (Map PackageName VersionRange))

  If present: custom-setup dependencies

Instances

Eq Package

Compares the package name.

Defined in Stack.Types.Package

Methods

(==) :: Package -> Package -> Bool

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

Ord Package

Compares the package name.

Defined in Stack.Types.Package

Methods

compare :: Package -> Package -> Ordering

(<) :: Package -> Package -> Bool

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

(>) :: Package -> Package -> Bool

(>=) :: Package -> Package -> Bool

max :: Package -> Package -> Package

min :: Package -> Package -> Package

Show Package

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> Package -> ShowS

show :: Package -> String

showList :: [Package] -> ShowS

data PackageDescriptionPair

A pair of package descriptions: one which modified the buildable values of test suites and benchmarks depending on whether they are enabled, and one which does not.

Fields are intentionally lazy, we may only need one or the other value.

MSS 2017-08-29: The very presence of this data type is terribly ugly, it represents the fact that the Cabal 2.0 upgrade did _not_ go well. Specifically, we used to have a field to indicate whether a component was enabled in addition to buildable, but that's gone now, and this is an ugly proxy. We should at some point clean up the mess of Package, LocalPackage, etc, and probably pull in the definition of PackageDescription from Cabal with our additionally needed metadata. But this is a good enough hack for the moment. Odds are, you're reading this in the year 2024 and thinking "wtf?"

Constructors

PackageDescriptionPair

Fields

• pdpOrigBuildable :: PackageDescription
• pdpModifiedBuildable :: PackageDescription

newtype GetPackageFiles

Files that the package depends on, relative to package directory. Argument is the location of the .cabal file

Constructors

GetPackageFiles

Fields

• getPackageFiles :: forall env. HasEnvConfig env => Path Abs File -> RIO env (Map NamedComponent (Map ModuleName (Path Abs File)), Map NamedComponent (Set DotCabalPath), Set (Path Abs File), [PackageWarning])

Instances

Show GetPackageFiles

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> GetPackageFiles -> ShowS

show :: GetPackageFiles -> String

showList :: [GetPackageFiles] -> ShowS

newtype GetPackageOpts

Files that the package depends on, relative to package directory. Argument is the location of the .cabal file

Constructors

GetPackageOpts

Fields

• getPackageOpts :: forall env. HasEnvConfig env => SourceMap -> InstalledMap -> [PackageName] -> [PackageName] -> Path Abs File -> RIO env (Map NamedComponent (Map ModuleName (Path Abs File)), Map NamedComponent (Set DotCabalPath), Map NamedComponent BuildInfoOpts)

Instances

Show GetPackageOpts

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> GetPackageOpts -> ShowS

show :: GetPackageOpts -> String

showList :: [GetPackageOpts] -> ShowS

data PackageConfig

Package build configuration

Constructors

PackageConfig

Fields

• packageConfigEnableTests :: !Bool

  Are tests enabled?

• packageConfigEnableBenchmarks :: !Bool

  Are benchmarks enabled?

• packageConfigFlags :: !(Map FlagName Bool)

  Configured flags.

• packageConfigGhcOptions :: ![Text]

  Configured ghc options.

• packageConfigCompilerVersion :: !(CompilerVersion CVActual)

  GHC version

• packageConfigPlatform :: !Platform

  host platform

Instances

Show PackageConfig

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> PackageConfig -> ShowS

show :: PackageConfig -> String

showList :: [PackageConfig] -> ShowS

buildLogPath :: (MonadReader env m, HasBuildConfig env, MonadThrow m) => Package -> Maybe String -> m (Path Abs File)

Path for the package's build log.

data PackageException

All exceptions thrown by the library.

Constructors

PackageInvalidCabalFile !(Either PackageIdentifierRevision (Path Abs File)) !(Maybe Version) ![PError] ![PWarning]

PackageNoCabalFileFound (Path Abs Dir)

PackageMultipleCabalFilesFound (Path Abs Dir) [Path Abs File]

MismatchedCabalName (Path Abs File) PackageName

MismatchedCabalIdentifier !PackageIdentifierRevision !PackageIdentifier

Instances

Show PackageException

Defined in Stack.Types.Package

Methods

showsPrec :: Int -> PackageException -> ShowS

show :: PackageException -> String

showList :: [PackageException] -> ShowS

Exception PackageException

Defined in Stack.Types.Package

Methods

toException :: PackageException -> SomeException

fromException :: SomeException -> Maybe PackageException

displayException :: PackageException -> String

resolvePackageDescription :: PackageConfig -> GenericPackageDescription -> PackageDescriptionPair

Evaluates the conditions of a GenericPackageDescription, yielding a resolved PackageDescription.

packageDependencies :: PackageConfig -> PackageDescription -> Map PackageName VersionRange

Get all dependencies of the package (buildable targets only).

Note that for Cabal versions 1.22 and earlier, there is a bug where Cabal requires dependencies for non-buildable components to be present. We're going to use GHC version as a proxy for Cabal library version in this case for simplicity, so we'll check for GHC being 7.10 or earlier. This obviously makes our function a lot more fun to write...

cabalFilePackageId :: (MonadIO m, MonadThrow m) => Path Abs File -> m PackageIdentifier

Extract the PackageIdentifier given an exploded haskell package path.

gpdPackageIdentifier :: GenericPackageDescription -> PackageIdentifier

gpdPackageName :: GenericPackageDescription -> PackageName

gpdVersion :: GenericPackageDescription -> Version