Skip to content

Commit

Permalink
doc(preprocessor): Document the preprocessor limitation
Browse files Browse the repository at this point in the history
Related to #176
  • Loading branch information
Julien Debon authored and fendor committed Jun 26, 2020
1 parent a9f9627 commit 8e8a189
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ This is *very* early stage software.
- [Emacs](#using-haskell-language-server-with-emacs)
- [Doom emacs](#using-haskell-language-server-with-doom-emacs)
- [Kakoune](#using-haskell-language-server-with-kakoune)
- [Known limitations](#known-limitations)
- [Preprocessor](#preprocessor)
- [Contributing](#contributing)
- [It's time to join the project!](#its-time-to-join-the-project)

Expand Down Expand Up @@ -485,6 +487,21 @@ command = "haskell-language-server-wrapper"
args = ["--lsp"]
```

## Known limitations

### Preprocessor
HLS is not yet able to find project preprocessors, which may result in `could not execute: <preprocessor>` errors. This problem is
tracked in https://github.com/haskell/haskell-language-server/issues/176 and originally comes from https://github.com/mpickering/hie-bios/issues/125

As a workaround, you need to ensure the preprocessor is available in the path (install globally with Stack or Cabal, provide in `shell.nix`, etc.).

Example with `tasty-discover`:
```haskell
{-# OPTIONS_GHC -F -pgmF tasty-discover #-}
```
This returns an error in HLS if 'tasty-discover' is not in the path: `could not execute: tasty-discover`.


## Contributing

### It's time to join the project
Expand Down

0 comments on commit 8e8a189

Please sign in to comment.