Stack.Package

Dealing with Cabal.

Documentation

readPackage :: (MonadLogger m, MonadIO m, MonadThrow m, MonadCatch m) => PackageConfig -> Path Abs File -> m ([PWarning], Package)

Reads and exposes the package information

readPackageBS :: MonadThrow m => PackageConfig -> ByteString -> m ([PWarning], Package)

Reads and exposes the package information, from a ByteString

readPackageDir :: (MonadLogger m, MonadIO m, MonadThrow m, MonadCatch m) => PackageConfig -> Path Abs Dir -> m (Path Abs File, [PWarning], Package)

Convenience wrapper around readPackage that first finds the cabal file in the given directory.

readPackageUnresolved :: (MonadIO m, MonadThrow m) => Path Abs File -> m ([PWarning], GenericPackageDescription)

Read the raw, unresolved package information.

readPackageUnresolvedBS :: MonadThrow m => Maybe (Path Abs File) -> ByteString -> m ([PWarning], GenericPackageDescription)

Read the raw, unresolved package information from a ByteString.

resolvePackage :: PackageConfig -> GenericPackageDescription -> Package

Resolve a parsed cabal file into a Package.

getCabalFileName

Arguments

:: (MonadThrow m, MonadIO m)

=> Path Abs Dir

package directory

-> m (Path Abs File)

Get the filename for the cabal file in the given directory.

If no .cabal file is present, or more than one is present, an exception is thrown via throwM.

data Package

Some package info.

Constructors

Package

Fields

• packageName :: !PackageName

  Name of the package.

• packageVersion :: !Version

  Version of the package

• packageFiles :: !GetPackageFiles

  Get all files of the package.

• packageDeps :: !(Map PackageName VersionRange)

  Packages that the package depends on.

• packageTools :: ![Dependency]

  A build tool name.

• packageAllDeps :: !(Set PackageName)

  Original dependencies (not sieved).

• packageFlags :: !(Map FlagName Bool)

  Flags used on package.

• packageHasLibrary :: !Bool

  does the package have a buildable library stanza?

• packageTests :: !(Set Text)

  names 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?

• packageSimpleType :: !Bool

  Does the package of build-type: Simple

• packageDefinedFlags :: !(Set FlagName)

  All flags defined in the .cabal file

Instances

Eq Package

Compares the package name.

Methods

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

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

Ord Package

Compares the package name.

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

Methods

showsPrec :: Int -> Package -> ShowS

show :: Package -> String

showList :: [Package] -> ShowS

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 m env. (MonadIO m, MonadLogger m, MonadThrow m, MonadCatch m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Set (Path Abs File), [PackageWarning])

Instances

Show GetPackageFiles

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 m. (MonadIO m, HasEnvConfig env, HasPlatform env, MonadThrow m, MonadReader env m, MonadLogger m, MonadCatch m) => SourceMap -> InstalledMap -> [PackageName] -> Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Map NamedComponent [String], [String])

Instances

Show GetPackageOpts

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)

  Package config flags.

• packageConfigCompilerVersion :: !CompilerVersion

  GHC version

• packageConfigPlatform :: !Platform

  host platform

Instances

Show PackageConfig

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 (Maybe (Path Abs File)) PError

PackageNoCabalFileFound (Path Abs Dir)

PackageMultipleCabalFilesFound (Path Abs Dir) [Path Abs File]

MismatchedCabalName (Path Abs File) PackageName

Instances

Show PackageException

Methods

showsPrec :: Int -> PackageException -> ShowS

show :: PackageException -> String

showList :: [PackageException] -> ShowS

Exception PackageException

Methods

toException :: PackageException -> SomeException

fromException :: SomeException -> Maybe PackageException

displayException :: PackageException -> String

resolvePackageDescription :: PackageConfig -> GenericPackageDescription -> PackageDescription

Get all dependencies of a package, including library, executables, tests, benchmarks.

packageToolDependencies :: PackageDescription -> Map ByteString VersionRange

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

packageDependencies :: PackageDescription -> Map PackageName VersionRange

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

packageIdentifier :: Package -> PackageIdentifier

autogenDir :: Path Abs Dir -> Path Abs Dir

Make the autogen dir.

checkCabalFileName :: MonadThrow m => PackageName -> Path Abs File -> m ()

Check if the given name in the Package matches the name of the .cabal file

printCabalFileWarning :: MonadLogger m => Path Abs File -> PWarning -> m ()

Print cabal file warnings.