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
{{ message }}
This repository was archived by the owner on Oct 7, 2020. It is now read-only.
- Installation with [stack](#installation-with-stack) or [Nix](#installation-with-nix)
25
-
-[ArchLinux](#archlinux)
24
+
-[stack on Linux](#installation-with-stack-on-linux)
25
+
-[stack on Windows](#installation-with-stack-on-windows)
26
+
-[macOS](#installation-on-macos)
27
+
-[Nix](#installation-with-nix)
28
+
-[ArchLinux](#installation-on-archlinux)
26
29
-[Configuration](#configuration)
27
30
-[Editor Integration](#editor-integration)
28
31
- Using HIE with [VS Code](#using-hie-with-vs-code), [Sublime Text](#using-hie-with-sublime-text), [Vim/Neovim](#using-hie-with-vim-or-neovim), [Atom](#using-hie-with-atom), [Oni](#using-hie-with-oni), [Emacs](#using-hie-with-emacs), [Spacemacs](#using-hie-with-spacemacs) or [Spacemacs+Nix](#using-hie-with-spacemacs-on-nix-based-projects)
@@ -95,52 +98,109 @@ we talk to clients.__
95
98
96
99
## Installation
97
100
98
-
Note: The version on branch `hie-0.1.0.0` supports GHC 8.0.2. This is
99
-
not supported in master.
101
+
### Installation with stack on Linux
100
102
101
-
On linux derivatives you will need to do the equivalent of before building
103
+
To install HIE, you need stack version >= 1.7.1.
104
+
105
+
HIE builds from source code, so there's a couple of extra steps.
106
+
107
+
#### Linux pre-requirements
108
+
109
+
On Linux you will need install a couple of extra libraries (for Unicode ([ICU](http://site.icu-project.org/)) and [NCURSES](https://www.gnu.org/software/ncurses/)):
110
+
111
+
**Debian/Ubuntu**:
102
112
103
113
```bash
104
114
sudo apt install libicu-dev libtinfo-dev
105
115
```
116
+
**Fedora**:
106
117
118
+
```bash
119
+
sudo dnf install libicu-devel ncurses-devel
120
+
```
121
+
**ArchLinux**: see [below](#installation-on-archlinux).
The GHC version you are going to install HIE for depends on which version of GHC you are using for your project. If you don't have a current project there are two potential options:
141
+
142
+
1. The Nightly GHC version ([currently](https://www.stackage.org/nightly) 8.6.2)
143
+
2. The LTS GHC version (which is [currently](https://www.stackage.org/lts) 8.4.4)
144
+
145
+
By default in a stack project you will get the LTS version.
146
+
147
+
You can check which version of ghc you are using in your project by running the following at the root of your project:
You can install an specific version or [all available GHC versions](#install-all-available-ghc-versions).
128
154
129
-
To install HIE, you need Stack version >= 1.7.1
155
+
#### Install a specific GHC version 8.2.1 - 8.6.2
130
156
131
-
In order to support both stack and cabal, `hie` requires `cabal-install`
132
-
as well.
157
+
We will use the `make` tools here to wrap `stack install`. The preferred installation mechanism is via `make`, as it makes sure the repo is synced, installs the required cabal libraries if missing, and makes copies of the executables with suffixes to be able to tell them apart.
133
158
134
-
If it is not already installed, install it and update its package list. One of the ways is:
159
+
Install **Nightly** (and hoogle docs):
135
160
136
161
```bash
137
-
stack install cabal-install
138
-
cabal update
162
+
make hie-8.6.2
163
+
make build-doc-8.6.2
164
+
```
165
+
166
+
Install **LTS** (and hoogle docs):
167
+
168
+
```bash
169
+
make hie-8.4.4
170
+
make build-doc-8.4.4
171
+
```
172
+
173
+
This step can take more than 30 minutes, so grab a coffee and please be patient!
174
+
175
+
The available versions depend on the `stack-*.yaml` config files in the `haskell-ide-engine` directory.
176
+
177
+
#### For GHC 8.0.2
178
+
179
+
This is no longer supported on the HIE `master` branch, so you must switch to the `hie-0.1.0.0` branch:
180
+
181
+
```bash
182
+
git checkout hie-0.1.0.0
183
+
git submodule update --init
184
+
```
185
+
Then you can run `stack install`:
186
+
187
+
```bash
188
+
stack --stack-yaml=stack-8.0.2.yaml install
139
189
```
140
190
141
-
To install all supported GHC versions, name them as expected by the VS Code
142
-
plugin, and also build a local hoogle database, you need the `make` tool (on
143
-
Windows, see the further advice below). Use the command:
191
+
#### Install *all* available GHC versions
192
+
193
+
This is the simplest approach as it will install all GHC versions to match against any project versions you might have.
194
+
195
+
*Warning*: Requires 20+ GB of space and potentially more than 2 hours to install, so please be patient!
196
+
197
+
This will:
198
+
199
+
* install all supported GHC versions (8.2.1 - 8.6.2)
200
+
* name them as expected by the VS Code plugin
201
+
* build local hoogle docs for each version
202
+
203
+
For this you need the `make` tool (on Windows, see the further advice below). Use the command:
0 commit comments