Skip to content

Commit 5b1696e

Browse files
committed
Add Windows links in requirements in README
Also clarify what exactly the extension does, and what the language servers do. Closes #178
1 parent dc6f696 commit 5b1696e

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

README.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Haskell for Visual Studio Code
22

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).
44

55
## Features
66

@@ -12,30 +12,16 @@ This is the Visual Studio Code extension for the [Haskell programming language](
1212
- Code completion
1313
- Formatting via Brittany, Floskell, Ormolu or Stylish Haskell
1414
- [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) -->
1715

1816
## Requirements
1917

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.
2220
- For Stack based projects, [stack](http://haskellstack.org) must be installed and on the PATH.
2321

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-
3622
## Language Servers
3723

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 others which can be manually installed:
3925

4026
- [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.
4127
- [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
9581
documentation: True
9682
```
9783

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.
89+
| Platform | Path |
90+
|----------|------|
91+
| macOS | `~/Library/Application\ Support/Code/User/globalStorage/alanz.vscode-hie-server/` |
92+
| 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+
98109
## Haskell IDE Engine specifics
99110

100111
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
121132

122133
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.
123134

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.
127-
| Platform | Path |
128-
|----------|------|
129-
| macOS | `~/Library/Application\ Support/Code/User/globalStorage/alanz.vscode-hie-server/` |
130-
| Windows | `%APPDATA%\Code\User\globalStorage\alanz.vscode-hie-server` |
131-
| Linux | TODO |
132-
133-
Note that if `haskell-language-server-wrapper` is already on the PATH, then the extension will launch it directly instead of downloading binaries.
134-
135135
## Investigating and reporting problems
136136

137137
1. Go to extensions and right click `Haskell` and choose `Configure Extensions Settings`

0 commit comments

Comments
 (0)