Skip to content

Commit 22ea3f3

Browse files
author
Julien Debon
committed
doc(preprocessor): Document the preprocessor limitation
Related to haskell#176
1 parent a9f9627 commit 22ea3f3

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

+17
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ This is *very* early stage software.
3838
- [Emacs](#using-haskell-language-server-with-emacs)
3939
- [Doom emacs](#using-haskell-language-server-with-doom-emacs)
4040
- [Kakoune](#using-haskell-language-server-with-kakoune)
41+
- [Known limitations](#known-limitations)
42+
- [Preprocessor](#preprocessor)
4143
- [Contributing](#contributing)
4244
- [It's time to join the project!](#its-time-to-join-the-project)
4345

@@ -485,6 +487,21 @@ command = "haskell-language-server-wrapper"
485487
args = ["--lsp"]
486488
```
487489

490+
## Known limitations
491+
492+
### Preprocessor
493+
HLS is not yet able to find project preprocessors, which may result in `could not execute: <preprocessor>` errors. This problem is
494+
tracked in https://github.com/haskell/haskell-language-server/issues/176 and originally comes from https://github.com/mpickering/hie-bios/issues/125
495+
496+
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.).
497+
498+
Example with `tasty-discover`:
499+
```haskell
500+
{-# OPTIONS_GHC -F -pgmF tasty-discover #-}
501+
```
502+
This returns an error in HLS if 'tasty-discover' is not in the path: `could not execute: tasty-discover`.
503+
504+
488505
## Contributing
489506

490507
### It's time to join the project

0 commit comments

Comments
 (0)