A Shake database plus persistent store. Can be thought of as storing mappings from (FilePath, k) to RuleResult k.

Get the client config stored in the ide state

This is useful for rules to convert rules that can only produce errors or a result into the more general IdeResult type that supports producing warnings while also producing a result.

A rule that wires per-file rules together

Parse the contents of a haskell file.

Parse the contents of a haskell file, ensuring comments are preserved in annotations

Returns the client configuration, creating a build dependency. You should always use this function when accessing client configuration from build rules.

Get HieFile for haskell file on NormalizedFilePath

Tracks which linkables are current, so we don't need to unload them

WARNING: We currently parse the module both with and without Opt_Haddock, and return the one with Haddocks if it -- succeeds. However, this may not work for hlint or any client code that might need the parsed source with all annotations, including comments. For that use case you might want to use getParsedModuleWithCommentsRule See https://github.com/haskell/ghcide/pull/350#discussion_r370878197 and https://github.com/mpickering/ghcide/pull/22#issuecomment-625070490 GHC wiki about: https://gitlab.haskell.org/ghc/ghc/-/wikis/api-annotations

This rule provides a ParsedModule preserving all annotations, including keywords, punctuation and comments. So it is suitable for use cases where you need a perfect edit.

Typechecks a module.

Load a iface from disk, or generate it if there isn't one or it is out of date This rule also ensures that the `.hie` and `.o` (if needed) files are written out.

How should we compile this module? (assuming we do in fact need to compile it). Depends on whether it uses unboxed tuples or sums

Also generates and indexes the `.hie` file, along with the `.o` file if needed Invariant maintained is that if the `.hi` file was successfully written, then the `.hie` and `.o` file (if needed) were also successfully written

Note [GhcSessionDeps] For a file Foo, GhcSessionDeps "Foo.hs" results in an HscEnv which includes 1. HomeModInfo's (in the HUG/HPT) for all modules in the transitive closure of Foo, **NOT** including Foo itself. 2. ModSummary's (in the ModuleGraph) for all modules in the transitive closure of Foo, including Foo itself. 3. ModLocation's (in the FinderCache) all modules in the transitive closure of Foo, including Foo itself.

Get all the linkables stored in the graph, i.e. the ones we *do not* need to unload. Doesn't actually contain the code, since we don't need it to unload