Documentation

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)

• optShakeProfiling :: Maybe FilePath

  Set to Just to create a directory of profiling reports.

• optOTMemoryProfiling :: IdeOTMemoryProfiling

  Whether to record profiling information with OpenTelemetry. You must also enable the -l RTS flag for this to have any effect

• 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.

• optMaxDirtyAge :: Int

  Age (in # builds) at which we collect dirty keys

• 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.

• optCheckProject :: IO Bool

  Whether to typecheck the entire project on load

• optCheckParents :: IO CheckParents

  When to typecheck reverse dependencies of a file

• optHaddockParse :: OptHaddockParse

  Whether to return result of parsing module with Opt_Haddock. Otherwise, return the result of parsing without Opt_Haddock, so that the parsed module contains the result of Opt_KeepRawTokenStream, which might be necessary for hlint.

• optModifyDynFlags :: Config -> DynFlagsModifications

  Will be called right after setting up a new cradle, allowing to customize the Ghc options used

• optShakeOptions :: ShakeOptions
   
• optSkipProgress :: forall a. Typeable a => a -> Bool

  Predicate to select which rule keys to exclude from progress reporting.

• optProgressStyle :: ProgressReportingStyle
   
• optRunSubset :: Bool

  Experimental feature to re-run only the subset of the Shake graph that has changed

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.

Fields

• optLocateHieFile :: UnitState -> Module -> IO (Maybe FilePath)

  Locate the HIE file for the given module. The PackageConfig can be used to lookup settings like importDirs.

• optLocateSrcFile :: UnitState -> 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.

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