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
+29-29Lines changed: 29 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Haskell for Visual Studio Code
2
2
3
-
This is the Visual Studio Code extension for the [Haskell programming language](https://haskell.org), powered by the [Haskell Langauge Server](https://github.com/haskell/haskell-language-server).
3
+
This extension adds language support for [Haskell](https://haskell.org), powered by the [Haskell Langauge Server](https://github.com/haskell/haskell-language-server).
4
4
5
5
## Features
6
6
@@ -12,30 +12,16 @@ This is the Visual Studio Code extension for the [Haskell programming language](
12
12
- Code completion
13
13
- Formatting via Brittany, Floskell, Ormolu or Stylish Haskell
14
14
-[Multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) support
15
-
<!-- Add this back when hlint support is merged into hls
16
-
- Code actions and quick-fixes via `hlint` and [`apply-refact`](https://github.com/mpickering/apply-refact) (click the lightbulb) -->
17
15
18
16
## Requirements
19
17
20
-
- For standalone `.hs`/`.lhs` files, [ghc](https://www.haskell.org/ghc/) must be installed and on the PATH. The easiest way to install it is with [ghcup](https://www.haskell.org/ghcup/).
21
-
- For Cabal based projects, both ghc and [cabal-install](https://www.haskell.org/cabal/) must be installed and on the PATH. It can also be installed with [ghcup](https://www.haskell.org/ghcup/).
18
+
- For standalone `.hs`/`.lhs` files, [ghc](https://www.haskell.org/ghc/) must be installed and on the PATH. The easiest way to install it is with [ghcup](https://www.haskell.org/ghcup/) or [Chocolatey](https://www.haskell.org/platform/windows.html) on Windows.
19
+
- For Cabal based projects, both ghc and [cabal-install](https://www.haskell.org/cabal/) must be installed and on the PATH. It can also be installed with [ghcup](https://www.haskell.org/ghcup/) or [Chocolatey](https://www.haskell.org/platform/windows.html) on Windows.
22
20
- For Stack based projects, [stack](http://haskellstack.org) must be installed and on the PATH.
23
21
24
-
## Supported GHC versions
25
-
26
-
Note that these are the versions of GHC that there are binaries of haskell-language-server for. Building from source may support more versions!
27
-
28
-
| GHC | Linux | macOS | Windows |
29
-
| ------ | ----- | ----- | ------- |
30
-
| 8.10.1 | ✓ | ✓ | ✓ |
31
-
| 8.8.3 | ✓ | ✓ ||
32
-
| 8.8.2 | ✓ | ✓ ||
33
-
| 8.6.5 | ✓ | ✓ | ✓ |
34
-
| 8.6.4 | ✓ | ✓ | ✓ |
35
-
36
22
## Language Servers
37
23
38
-
This extension is powered by the Haskell Language Server by default, but it also supports several others, some which need to be manually installed:
24
+
Whilst this extension is powered by the Haskell Language Server by default, it also supports several otherswhich can be manually installed:
39
25
40
26
-[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.
41
27
-[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).
@@ -95,6 +81,31 @@ Or alternatively add the following to your `~/.cabal/config` or `cabal.config[.l
95
81
documentation: True
96
82
```
97
83
84
+
## Haskell Language Server specifics
85
+
86
+
### Downloaded binaries
87
+
88
+
This extension will download `haskell-language-server` binaries to a specific location depending on your system. If you find yourself running out of disk space, you can try deleting old versions of language servers in this directory. The extension will redownload them, no strings attached.
| Windows |`%APPDATA%\Code\User\globalStorage\alanz.vscode-hie-server`|
93
+
| Linux |`$HOME/.config/Code/User/settings.json`|
94
+
95
+
Note that if `haskell-language-server-wrapper`/`haskell-language-server` is already on the PATH, then the extension will launch it directly instead of downloading binaries.
96
+
97
+
### Supported GHC versions
98
+
99
+
These are the versions of GHC that there are binaries of `haskell-language-server` for. Building from source may support more versions!
100
+
101
+
| GHC | Linux | macOS | Windows |
102
+
| ------ | ----- | ----- | ------- |
103
+
| 8.10.1 | ✓ | ✓ | ✓ |
104
+
| 8.8.3 | ✓ | ✓ ||
105
+
| 8.8.2 | ✓ | ✓ ||
106
+
| 8.6.5 | ✓ | ✓ | ✓ |
107
+
| 8.6.4 | ✓ | ✓ | ✓ |
108
+
98
109
## Haskell IDE Engine specifics
99
110
100
111
If you are using Haskell IDE Engine as your language server, there are a number of additional configuration options.
@@ -121,17 +132,6 @@ First, check out [what multi-root workspaces](https://code.visualstudio.com/docs
121
132
122
133
The language server is now started for each workspace folder you have in your multi-root workspace, and several configurations are on a resource (i.e. folder) scope, instead of window (i.e. global) scope.
123
134
124
-
## Downloaded language servers
125
-
126
-
This extension will download the language server binaries to a specific location depending on your system. If you find yourself running out of disk space, you can try deleting old versions of language servers in this directory. The extension will redownload them, no strings attached.
0 commit comments