Safe Haskell	None
Language	Haskell2010

Stack.Ghci

Description

Run a GHCi configured with the user's package(s).

Synopsis

data GhciOpts = GhciOpts {
- ghciTargets :: ![Text]
- ghciArgs :: ![String]
- ghciGhcOptions :: ![String]
- ghciFlags :: !(Map ApplyCLIFlag (Map FlagName Bool))
- ghciGhcCommand :: !(Maybe FilePath)
- ghciNoLoadModules :: !Bool
- ghciAdditionalPackages :: ![String]
- ghciMainIs :: !(Maybe Text)
- ghciLoadLocalDeps :: !Bool
- ghciSkipIntermediate :: !Bool
- ghciHidePackages :: !(Maybe Bool)
- ghciNoBuild :: !Bool
- ghciOnlyMain :: !Bool
}
data GhciPkgInfo = GhciPkgInfo {
- ghciPkgName :: !PackageName
- ghciPkgOpts :: ![(NamedComponent, BuildInfoOpts)]
- ghciPkgDir :: !(Path Abs Dir)
- ghciPkgModules :: !ModuleMap
- ghciPkgCFiles :: ![Path Abs File]
- ghciPkgMainIs :: !(Map NamedComponent [Path Abs File])
- ghciPkgTargetFiles :: !(Maybe [Path Abs File])
- ghciPkgPackage :: !Package
}
data GhciException
ghci :: HasEnvConfig env => GhciOpts -> RIO env ()

Documentation

data GhciOpts Source #

Command-line options for GHC.

Constructors

GhciOpts

Fields

ghciTargets :: ![Text]
ghciArgs :: ![String]
ghciGhcOptions :: ![String]
ghciFlags :: !(Map ApplyCLIFlag (Map FlagName Bool))
ghciGhcCommand :: !(Maybe FilePath)
ghciNoLoadModules :: !Bool
ghciAdditionalPackages :: ![String]
ghciMainIs :: !(Maybe Text)
ghciLoadLocalDeps :: !Bool
ghciSkipIntermediate :: !Bool
ghciHidePackages :: !(Maybe Bool)
ghciNoBuild :: !Bool
ghciOnlyMain :: !Bool

Instances

Show GhciOpts Source #
Instance details Defined in Stack.Ghci Methods showsPrec :: Int -> GhciOpts -> ShowS # show :: GhciOpts -> String # showList :: [GhciOpts] -> ShowS #

data GhciPkgInfo Source #

Necessary information to load a package or its components.

NOTE: GhciPkgInfo has paths as list instead of a Set to preserve files order as a workaround for bug https://ghc.haskell.org/trac/ghc/ticket/13786

Constructors

GhciPkgInfo
Fields ghciPkgName :: !PackageName ghciPkgOpts :: ![(NamedComponent, BuildInfoOpts)] ghciPkgDir :: !(Path Abs Dir) ghciPkgModules :: !ModuleMap ghciPkgCFiles :: ![Path Abs File] C files. ghciPkgMainIs :: !(Map NamedComponent [Path Abs File]) ghciPkgTargetFiles :: !(Maybe [Path Abs File]) ghciPkgPackage :: !Package

Instances

Show GhciPkgInfo Source #
Instance details Defined in Stack.Ghci Methods showsPrec :: Int -> GhciPkgInfo -> ShowS # show :: GhciPkgInfo -> String # showList :: [GhciPkgInfo] -> ShowS #

data GhciException Source #

Constructors

InvalidPackageOption String
LoadingDuplicateModules
MissingFileTarget String
Can'tSpecifyFilesAndTargets
Can'tSpecifyFilesAndMainIs
GhciTargetParseException [Text]

Instances

Show GhciException Source #
Instance details Defined in Stack.Ghci Methods showsPrec :: Int -> GhciException -> ShowS # show :: GhciException -> String # showList :: [GhciException] -> ShowS #
Exception GhciException Source #
Instance details Defined in Stack.Ghci Methods toException :: GhciException -> SomeException # fromException :: SomeException -> Maybe GhciException # displayException :: GhciException -> String #

ghci :: HasEnvConfig env => GhciOpts -> RIO env () Source #

Launch a GHCi session for the given local package targets with the given options and configure it with the load paths and extensions of those targets.