License	BSD-3-Clause
Safe Haskell	None
Language	GHC2024

Stack.Ghci

Description

Types and functions related to Stack's ghci and repl commands.

Synopsis

data GhciOpts = GhciOpts {
- targets :: ![Text]
- args :: ![String]
- ghcOptions :: ![String]
- flags :: !(Map ApplyCLIFlag (Map FlagName Bool))
- ghcCommand :: !(Maybe FilePath)
- noLoadModules :: !Bool
- additionalPackages :: ![String]
- mainIs :: !(Maybe Text)
- loadLocalDeps :: !Bool
- hidePackages :: !(Maybe Bool)
- noBuild :: !Bool
- onlyMain :: !Bool
}
data GhciPkgInfo = GhciPkgInfo {
- name :: !PackageName
- opts :: ![(NamedComponent, BuildInfoOpts)]
- dir :: !(Path Abs Dir)
- modules :: !ModuleMap
- cFiles :: ![Path Abs File]
- mainIs :: !(Map NamedComponent [Path Abs File])
- targetFiles :: !(Maybe [Path Abs File])
- package :: !Package
}
data GhciPrettyException
type ModuleMap = Map ModuleName (Map (Path Abs File) (Set (PackageName, NamedComponent)))
ghciCmd :: GhciOpts -> RIO Runner ()
ghci :: HasEnvConfig env => GhciOpts -> RIO env ()

Documentation

data GhciOpts Source #

Type respresenting command line options for Stack's ghci and repl commands.

Constructors

GhciOpts
Fields targets :: ![Text] args :: ![String] ghcOptions :: ![String] flags :: !(Map ApplyCLIFlag (Map FlagName Bool)) ghcCommand :: !(Maybe FilePath) noLoadModules :: !Bool additionalPackages :: ![String] mainIs :: !(Maybe Text) loadLocalDeps :: !Bool hidePackages :: !(Maybe Bool) noBuild :: !Bool onlyMain :: !Bool

Instances

Instances details

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

data GhciPkgInfo Source #

Type representing information required 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 name :: !PackageName opts :: ![(NamedComponent, BuildInfoOpts)] dir :: !(Path Abs Dir) modules :: !ModuleMap cFiles :: ![Path Abs File] C files. mainIs :: !(Map NamedComponent [Path Abs File]) targetFiles :: !(Maybe [Path Abs File]) package :: !Package

Instances

Instances details

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

data GhciPrettyException Source #

Type representing 'pretty' exceptions thrown by functions exported by the Stack.Ghci module.

Constructors

GhciTargetParseException ![StyleDoc]
CandidatesIndexOutOfRangeBug
InvalidPackageOption !String
FileTargetIsInvalidAbsFile !String
Can'tSpecifyFilesAndTargets
Can'tSpecifyFilesAndMainIs

Instances

Instances details

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

type ModuleMap = Map ModuleName (Map (Path Abs File) (Set (PackageName, NamedComponent))) Source #

Type synonym representing maps from a module name to a map with all of the paths that use that name. Each of those paths is associated with a set of components that contain it.

ghciCmd :: GhciOpts -> RIO Runner () Source #

Function underlying the stack ghci and stack repl commands. Run GHCi in the context of a project.

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

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