-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Calculate and print (in different formats) Stackage build plans
--   
--   For more information, see
--   <a>https://www.stackage.org/package/stackage-build-plan</a>
@package stackage-build-plan
@version 0.1.0.0

module Stackage.BuildPlan

-- | Settings affecting various functions in this module.
--   
--   Since 0.1.0.0
data Settings
data SnapshotSpec

-- | Parse a snapshot specification from the given <tt>Text</tt>.
--   
--   Since 0.1.0.0
parseSnapshotSpec :: MonadThrow m => Text -> m SnapshotSpec

-- | Default settings, to be tweaked via setter functions.
--   
--   Since 0.1.0.0
defaultSettings :: Settings

-- | Set the mirror prefix for tarball downloads (shell script only).
--   
--   Default:
--   "<a>https://s3.amazonaws.com/hackage.fpcomplete.com/package/"</a>
--   
--   Since 0.1.0.0
setMirror :: Text -> Settings -> Settings

-- | Set the snapshot from which to pull the build plan.
--   
--   Default: latest LTS release
--   
--   Since 0.1.0.0
setSnapshot :: SnapshotSpec -> Settings -> Settings

-- | How to generate commands for shell output.
--   
--   Since 0.1.0.0
data ShellCommands

-- | Set the shell commands when using shell formatting.
--   
--   Default: <a>abstractCommands</a>
--   
--   Since 0.1.0.0
setShellCommands :: ShellCommands -> Settings -> Settings

-- | Use abstract commands like build_plan_fetch.
--   
--   See:
--   https:/<i>github.com</i>fpco<i>stackage-server</i>issues/95#issuecomment-97146188
--   
--   Since 0.1.0.0
abstractCommands :: ShellCommands

-- | Use simple commands requiring no wrapper shell script
--   
--   Since 0.1.0.0
simpleCommands :: ShellCommands
getBuildPlan :: Settings -> [PackageName] -> IO [ToInstall]
toSimpleText :: [ToInstall] -> Text
toShellScript :: Settings -> [ToInstall] -> Text
mkPackageName :: Text -> PackageName
instance Typeable BuildPlanException
instance Show IncompleteSpec
instance Show SnapshotSpec
instance Show BuildPlanException
instance Show ToInstall
instance ToJSON ToInstall
instance Exception BuildPlanException
instance Show CompleteSpec