Safe Haskell	None
Language	Haskell2010

Development.IDE.Types.Options

Description

Options

Synopsis

data IdeOptions = IdeOptions {
- optPreprocessor :: ParsedSource -> IdePreprocessedSource
- optGhcSession :: Action IdeGhcSession
- optPkgLocationOpts :: IdePkgLocationOptions
- optExtensions :: [String]
- optThreads :: Int
- optShakeFiles :: Maybe FilePath
- optShakeProfiling :: Maybe FilePath
- optTesting :: IdeTesting
- optReportProgress :: IdeReportProgress
- optLanguageSyntax :: String
- optNewColonConvention :: Bool
- optKeywords :: [Text]
- optDefer :: IdeDefer
}
data IdePreprocessedSource = IdePreprocessedSource {
- preprocWarnings :: [(SrcSpan, String)]
- preprocErrors :: [(SrcSpan, String)]
- preprocSource :: ParsedSource
}
newtype IdeReportProgress = IdeReportProgress Bool
newtype IdeDefer = IdeDefer Bool
newtype IdeTesting = IdeTesting Bool
clientSupportsProgress :: ClientCapabilities -> IdeReportProgress
data IdePkgLocationOptions = IdePkgLocationOptions {
- optLocateHieFile :: PackageConfig -> Module -> IO (Maybe FilePath)
- optLocateSrcFile :: PackageConfig -> Module -> IO (Maybe FilePath)
}
defaultIdeOptions :: Action IdeGhcSession -> IdeOptions
type IdeResult v = ([FileDiagnostic], Maybe v)
data IdeGhcSession = IdeGhcSession {
- loadSessionFun :: FilePath -> IO (IdeResult HscEnvEq, [FilePath])
- sessionVersion :: !Int
}

Documentation

data IdeOptions Source #

Constructors

IdeOptions

Fields

optPreprocessor :: ParsedSource -> IdePreprocessedSource
Preprocessor to run over all parsed source trees, generating a list of warnings and a list of errors, along with a new parse tree.
optGhcSession :: Action IdeGhcSession
Setup a GHC session for a given file, e.g. Foo.hs. For the same ComponentOptions from hie-bios, the resulting function will be applied once per file. It is desirable that many files get the same HscEnvEq, so that more IDE features work.
optPkgLocationOpts :: IdePkgLocationOptions
How to locate source and .hie files given a module name.
optExtensions :: [String]
File extensions to search for code, defaults to Haskell sources (including .hs)
optThreads :: Int
Number of threads to use. Use 0 for number of threads on the machine.
optShakeFiles :: Maybe FilePath
Directory where the shake database should be stored. For ghcide this is always set to Nothing for now meaning we keep everything in memory but the daml CLI compiler uses this for incremental builds.
optShakeProfiling :: Maybe FilePath
Set to Just to create a directory of profiling reports.
optTesting :: IdeTesting
Whether to enable additional lsp messages used by the test suite for checking invariants
optReportProgress :: IdeReportProgress
Whether to report progress during long operations.
optLanguageSyntax :: String
the ```language to use
optNewColonConvention :: Bool
whether to use new colon convention
optKeywords :: [Text]
keywords used for completions. These are customizable since DAML has a different set of keywords than Haskell.
optDefer :: IdeDefer
Whether to defer type errors, typed holes and out of scope variables. Deferral allows the IDE to continue to provide features such as diagnostics and go-to-definition, in situations in which they would become unavailable because of the presence of type errors, holes or unbound variables.

data IdePreprocessedSource Source #

Constructors

IdePreprocessedSource
Fields preprocWarnings :: [(SrcSpan, String)] Warnings emitted by the preprocessor. preprocErrors :: [(SrcSpan, String)] Errors emitted by the preprocessor. preprocSource :: ParsedSource New parse tree emitted by the preprocessor.

newtype IdeReportProgress Source #

Constructors

IdeReportProgress Bool

newtype IdeDefer Source #

Constructors

IdeDefer Bool

newtype IdeTesting Source #

Constructors

IdeTesting Bool

clientSupportsProgress :: ClientCapabilities -> IdeReportProgress Source #

data IdePkgLocationOptions Source #

The set of options used to locate files belonging to external packages.

Constructors

IdePkgLocationOptions

Fields

optLocateHieFile :: PackageConfig -> Module -> IO (Maybe FilePath)
Locate the HIE file for the given module. The PackageConfig can be used to lookup settings like importDirs.
optLocateSrcFile :: PackageConfig -> Module -> IO (Maybe FilePath)
Locate the source file for the given module. The PackageConfig can be used to lookup settings like importDirs. For DAML, we place them in the package DB. For cabal this could point somewhere in ~.cabalpackages.

defaultIdeOptions :: Action IdeGhcSession -> IdeOptions Source #

type IdeResult v = ([FileDiagnostic], Maybe v) Source #

The result of an IDE operation. Warnings and errors are in the Diagnostic, and a value is in the Maybe. For operations that throw an error you expect a non-empty list of diagnostics, at least one of which is an error, and a Nothing. For operations that succeed you expect perhaps some warnings and a Just. For operations that depend on other failing operations you may get empty diagnostics and a Nothing, to indicate this phase throws no fresh errors but still failed.

A rule on a file should only return diagnostics for that given file. It should not propagate diagnostic errors through multiple phases.

data IdeGhcSession Source #

Constructors

IdeGhcSession
Fields loadSessionFun :: FilePath -> IO (IdeResult HscEnvEq, [FilePath]) Returns the Ghc session and the cradle dependencies sessionVersion :: !Int Used as Shake key, versions must be unique and not reused

Instances

Show IdeGhcSession Source #
Instance details Defined in Development.IDE.Types.Options Methods showsPrec :: Int -> IdeGhcSession -> ShowS # show :: IdeGhcSession -> String # showList :: [IdeGhcSession] -> ShowS #
NFData IdeGhcSession Source #
Instance details Defined in Development.IDE.Types.Options Methods rnf :: IdeGhcSession -> () #