Modulehackage-revdeps-0.4.1GHC2021

Hackage.RevDeps

Functions to list Hackage reverse dependencies.

1 type
6 values

Packagehackage-revdeps-0.4.1
Exports7
LanguageGHC2021
LicenceBSD-3-Clause
SourceRevDeps.hs

valuelastVersionsOfPackagesWithNeedles

:: (PackageName -> Bool)
Which packages are we looking for? Could be const True.
-> Set ByteString
Needles to search in Cabal files.
-> FilePath
Path to 01-index.tar or 01-index.tar.gz.
-> Maybe UTCTime
Timestamp of index state at which to stop scanning.
-> IO (Map PackageName ByteString)
Map from packages with largest versions to their Cabal files.

Scan Cabal index and return Cabal files of last versions (not necessarily latest releases or revisions), which contain one of the needles as an entire word (separated by spaces or punctuation).

To avoid ambiguity: we first select the last versions, then filter them by needles.

valuelastVersionsOfPackages

:: (PackageName -> Bool)
Which packages are we looking for? Could be const True.
-> FilePath
Path to 01-index.tar or 01-index.tar.gz.
-> Maybe UTCTime
Timestamp of index state at which to stop scanning.
-> IO (Map PackageName ByteString)
Map from packages with largest versions to their Cabal files.

Scan Cabal index 01-index.tar (or 01-index.tar.gz) and return Cabal files of last versions (not necessarily latest releases or revisions).

valueextractDependencies

:: ExtractDependenciesMode
Which package components to scan?
-> Set PackageName
Needles to search.
-> ByteString
Content of a Cabal file.
-> Map PackageName VersionRange
Needles found in the Cabal file and their version bounds.

Scan Cabal file looking for package names matching needles, coalescing version bounds from all components and under all conditions.

valueextractAllDependencies

:: ExtractDependenciesMode
Which package components to scan?
-> ByteString
Content of a Cabal file.
-> Map PackageName VersionRange
All dependencies found in the Cabal file and their version bounds.

Scan Cabal file looking for all dependencies, coalescing version bounds from all components and under all conditions.

valuegetReverseDependencies

:: ExtractDependenciesMode
Which package components to scan?
-> Set PackageName
Needles to search in Cabal files.
-> FilePath
Path to 01-index.tar or 01-index.tar.gz.
-> Maybe UTCTime
Timestamp of index state at which to stop scanning.
-> IO (Map PackageName (Map PackageName VersionRange))
Outer keys are reverse dependencies, inner keys are needles, inner values are accepted version ranges.

Combination of lastVersionsOfPackagesWithNeedles and extractDependencies.

valuegetTransitiveReverseDependencies

:: ExtractDependenciesMode
Which package components to scan?
-> Set PackageName
Needles to search in Cabal files.
-> FilePath
Path to 01-index.tar or 01-index.tar.gz.
-> Maybe UTCTime
Timestamp of index state at which to stop scanning.
-> IO (Map PackageName (Map PackageName VersionRange))
Reverse dependencies, including transitive ones.

Same as getReverseDependencies, but returns not only direct, but also indirect reverse dependencies.

datadata ExtractDependenciesMode

Which package components to look inside for dependencies?

Constructors

AllComponents
All components, including tests, benchmarks, sublibraries.
OnlyMainLib
Only the main library if any.