You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-45Lines changed: 3 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ Whilst this extension is powered by the Haskell Language Server by default, it a
30
30
31
31
-[Haskell Language Server](https://github.com/haskell/haskell-language-server#installation): This is the default language server which will automatically be downloaded, so it does not need manual installation. It builds upon ghcide by providing extra plugins and features.
32
32
-[ghcide](https://github.com/digital-asset/ghcide#install-ghcide): A fast and reliable LSP server with support for [basic features](https://github.com/digital-asset/ghcide#features).
33
-
-[Haskell IDE Engine](https://github.com/haskell/haskell-ide-engine#installation): A stable and mature language server, but note that development has moved from this to the Haskell Language Server.
33
+
-[Haskell IDE Engine](https://github.com/haskell/haskell-ide-engine#installation): A legacy language server, you probably shouldn't use this one. Haskell Language Server replaces it instead.
34
34
35
35
You can choose which language server to use from the "Haskell > Language Server Variant" configuration option.
36
36
@@ -100,48 +100,6 @@ These are the versions of GHC that there are binaries of `haskell-language-serve
100
100
| 8.6.5 | ✓ | ✓ | ✓ |
101
101
| 8.6.4 | ✓ | ✓ | ✓ |
102
102
103
-
## Haskell IDE Engine specifics
104
-
105
-
If you are using Haskell IDE Engine as your language server, there are a number of additional configuration options.
106
-
107
-
### Local documentation
108
-
109
-
Haskell Language Server can display Haddock documentation on hover and in code completion for your code if you have built your project with haddock enabled.
110
-
111
-
For Stack projects, in your project directory run
112
-
113
-
```bash
114
-
$ stack haddock --keep-going
115
-
```
116
-
117
-
For Cabal projects, run
118
-
119
-
```bash
120
-
$ cabal build --haddock
121
-
```
122
-
123
-
Or alternatively add the following to your `~/.cabal/config` or `cabal.config[.local]`
124
-
125
-
```json
126
-
documentation: True
127
-
```
128
-
129
-
### Liquid Haskell
130
-
131
-
If Liquid Haskell is installed, haskell-ide-engine can be configured to run the `liquidhaskell` executable on save and display diagnostics:
132
-
133
-
```json
134
-
"haskell.liquidOn": true,
135
-
```
136
-
137
-
### Hoogle
138
-
139
-
HIE pulls in documentation via Hoogle. After installing Hoogle via `cabal install hoogle` or `stack install hoogle`, generate the database with:
140
-
141
-
```bash
142
-
$ hoogle generate
143
-
```
144
-
145
103
## Using multi-root workspaces
146
104
147
105
First, check out [what multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces) are. The idea of using multi-root workspaces, is to be able to work on several different Haskell projects, where the GHC version or stackage LTS could differ, and have it work smoothly.
@@ -161,11 +119,11 @@ Please include the output when filing any issues on the relevant language server
161
119
### Troubleshooting
162
120
163
121
- Sometimes the language server might get stuck in a rut and stop responding to your latest changes.
164
-
Should this occur you can try restarting the language server with <kbd>Ctrl</kbd> <kbd>shift</kbd> <kbd>P</kbd>/<kbd>⌘</kbd> <kbd>shift</kbd> <kbd>P</kbd> > Restart Haskell LSP Server.
122
+
Should this occur you can try restarting the language server with <kbd>Ctrl</kbd> <kbd>shift</kbd> <kbd>P</kbd>/<kbd>⌘</kbd> <kbd>shift</kbd> <kbd>P</kbd> > Restart Haskell LSP Server.
165
123
- Usually the error or unexpected behaviour is already reported in the haskell language server [used by the extension](#hie-variant). Finding the issue in its issue tracker could be useful to help resolve it. Sometimes even it includes a workaround for the issue.
166
124
- Haskell language servers issue trackers:
167
-
- haskell-ide-engine (the default haskell language server): https://github.com/haskell/haskell-ide-engine/issues
- For now, the extension is not able to open a single haskell source file. You need to open a workspace or folder, configured to be built with cabal, stack or other hie-bios compatible program.
171
129
- Check you don't have other haskell extensions active, they can interfere with each other.
0 commit comments