Stackage.ShowBuildPlan

Documentation

data Settings

Settings affecting various functions in this module.

Since 0.1.0.0

data SnapshotSpec

Instances

Show SnapshotSpec

Methods

showsPrec :: Int -> SnapshotSpec -> ShowS

show :: SnapshotSpec -> String

showList :: [SnapshotSpec] -> ShowS

parseSnapshotSpec :: MonadThrow m => Text -> m SnapshotSpec

Parse a snapshot specification from the given Text.

Since 0.1.0.0

defaultSettings :: Settings

Default settings, to be tweaked via setter functions.

Since 0.1.0.0

setMirror :: Text -> Settings -> Settings

Set the mirror prefix for tarball downloads (shell script only).

Default: "https://s3.amazonaws.com/hackage.fpcomplete.com/package/"

Since 0.1.0.0

setSnapshot :: SnapshotSpec -> Settings -> Settings

Set the snapshot from which to pull the build plan.

Default: latest LTS release

Since 0.1.0.0

setFullDeps :: Bool -> Settings -> Settings

Should we trace dependencies of test suites and benchmarks?

Default: False

Since 0.1.1.0

data ShellCommands

How to generate commands for shell output.

Since 0.1.0.0

setShellCommands :: ShellCommands -> Settings -> Settings

Set the shell commands when using shell formatting.

Default: abstractCommands

Since 0.1.0.0

abstractCommands :: ShellCommands

Use abstract commands like build_plan_fetch.

See: https://github.com/fpco/stackage-server/issues/95#issuecomment-97146188

Since 0.1.0.0

simpleCommands :: ShellCommands

Use simple commands requiring no wrapper shell script

Since 0.1.0.0

data ToInstall

Constructors

ToInstall

Fields

• tiPackage :: !PackageName
• tiVersion :: !Version
• tiIsCore :: !Bool
• tiFlags :: !(Map Text Bool)

Instances

Show ToInstall

Methods

showsPrec :: Int -> ToInstall -> ShowS

show :: ToInstall -> String

showList :: [ToInstall] -> ShowS

ToJSON ToInstall

Methods

toJSON :: ToInstall -> Value

toEncoding :: ToInstall -> Encoding

toJSONList :: [ToInstall] -> Value

toEncodingList :: [ToInstall] -> Encoding

getBuildPlan :: Settings -> [PackageName] -> IO [ToInstall]

toSimpleText :: [ToInstall] -> Text

toShellScript :: Settings -> [ToInstall] -> Text

mkPackageName :: String -> PackageName

Construct a PackageName from a String

mkPackageName is the inverse to unPackageName

Note: No validations are performed to ensure that the resulting PackageName is valid

Since: 2.0