Safe Haskell	Safe-Inferred
Language	GHC2021

Stack.Unpack

Description

Functions related to Stack's unpack command.

Synopsis

data UnpackOpts = UnpackOpts {
- targets :: [UnpackTarget]
- areCandidates :: Bool
- dest :: Maybe (SomeBase Dir)
}
type UnpackTarget = Either PackageName PackageIdentifierRevision
unpackCmd :: UnpackOpts -> RIO Runner ()
unpackPackages :: forall env. (HasConfig env, HasPantryConfig env, HasProcessContext env, HasTerm env) => Maybe RawSnapshot -> Path Abs Dir -> [UnpackTarget] -> Bool -> RIO env ()

Documentation

data UnpackOpts Source #

Type representing options for the stack unpack command.

Constructors

UnpackOpts
Fields targets :: [UnpackTarget] The packages or package candidates to be unpacked. areCandidates :: Bool Whether the targets are Hackage package candidates. dest :: Maybe (SomeBase Dir) The optional directory into which a target will be unpacked into a subdirectory.

type UnpackTarget = Either PackageName PackageIdentifierRevision Source #

Type synonymn representing packages to be unpacked by the stack unpack command, identified either by name only or by an identifier (including Hackage revision).

unpackCmd :: UnpackOpts -> RIO Runner () Source #

Function underlying the stack unpack command. Unpack packages or package candidates to the filesystem.

unpackPackages Source #

Arguments

:: forall env. (HasConfig env, HasPantryConfig env, HasProcessContext env, HasTerm env)
=> Maybe RawSnapshot	When looking up by name, take from this build plan.
-> Path Abs Dir	Destination.
-> [UnpackTarget]
-> Bool	Whether the targets are package candidates.
-> RIO env ()

Intended to work for the command line command.