aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc/ale-haskell.txt
blob: 030d15b36c6c38d1cffbb75e44601bad63a99a38 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
===============================================================================
ALE Haskell Integration                                   *ale-haskell-options*


===============================================================================
brittany                                                 *ale-haskell-brittany*

                                      *ale-options.haskell_brittany_executable*
                                            *g:ale_haskell_brittany_executable*
                                            *b:ale_haskell_brittany_executable*
haskell_brittany_executable
g:ale_haskell_brittany_executable
  Type: |String|
  Default: `'brittany'`

  This variable can be changed to use a different executable for brittany.


===============================================================================
cspell                                                     *ale-haskell-cspell*

See |ale-cspell-options|


===============================================================================
floskell                                                 *ale-haskell-floskell*

                                      *ale-options.haskell_floskell_executable*
                                            *g:ale_haskell_floskell_executable*
                                            *b:ale_haskell_floskell_executable*
haskell_floskell_executable
g:ale_haskell_floskell_executable
  Type: |String|
  Default: `'floskell'`

  This variable can be changed to use a different executable for floskell.


===============================================================================
ghc                                                           *ale-haskell-ghc*

                                              *ale-options.haskell_ghc_options*
                                                    *g:ale_haskell_ghc_options*
                                                    *b:ale_haskell_ghc_options*
haskell_ghc_options
g:ale_haskell_ghc_options
  Type: |String|
  Default: `'-fno-code -v0'`

  This variable can be changed to modify flags given to ghc.


===============================================================================
ghc-mod                                                   *ale-haskell-ghc-mod*

                                       *ale-options.haskell_ghc_mod_executable*
                                             *g:ale_haskell_ghc_mod_executable*
                                             *b:ale_haskell_ghc_mod_executable*
haskell_ghc_mod_executable
g:ale_haskell_ghc_mod_executable
  Type: |String|
  Default: `'ghc-mod'`

  This variable can be changed to use a different executable for ghc-mod.


===============================================================================
cabal-ghc                                               *ale-haskell-cabal-ghc*

                                        *ale-options.haskell_cabal_ghc_options*
                                              *g:ale_haskell_cabal_ghc_options*
                                              *b:ale_haskell_cabal_ghc_options*
haskell_cabal_ghc_options
g:ale_haskell_cabal_ghc_options
  Type: |String|
  Default: `'-fno-code -v0'`

  This variable can be changed to modify flags given to ghc through cabal
  exec.


===============================================================================
hdevtools                                               *ale-haskell-hdevtools*

                                     *ale-options.haskell_hdevtools_executable*
                                           *g:ale_haskell_hdevtools_executable*
                                           *b:ale_haskell_hdevtools_executable*
haskell_hdevtools_executable
g:ale_haskell_hdevtools_executable
  Type: |String|
  Default: `'hdevtools'`

  This variable can be changed to use a different executable for hdevtools.

                                        *ale-options.haskell_hdevtools_options*
                                              *g:ale_haskell_hdevtools_options*
                                              *b:ale_haskell_hdevtools_options*
haskell_hdevtools_options
g:ale_haskell_hdevtools_options
  Type: |String|
  Default: `get(g:, 'hdevtools_options', '-g -Wall')`

  This variable can be changed to modify flags given to hdevtools.

  The hdevtools documentation recommends setting GHC options for `hdevtools`
  with `g:hdevtools_options`. ALE will use the value of `g:hdevtools_options`
  for the value of `g:ale_haskell_hdevtools_options` by default, so this
  option can be respected and overridden specifically for ALE.


===============================================================================
hfmt                                                         *ale-haskell-hfmt*

                                          *ale-options.haskell_hfmt_executable*
                                                *g:ale_haskell_hfmt_executable*
                                                *b:ale_haskell_hfmt_executable*
haskell_hfmt_executable
g:ale_haskell_hfmt_executable
  Type: |String|
  Default: `'hfmt'`

  This variable can be changed to use a different executable for hfmt.


===============================================================================
hindent                                                   *ale-haskell-hindent*

                                       *ale-options.haskell_hindent_executable*
                                             *g:ale_haskell_hindent_executable*
                                             *b:ale_haskell_hindent_executable*
haskell_hindent_executable
g:ale_haskell_hindent_executable
  Type: |String|
  Default: `'hindent'`

  This variable can be changed to use a different executable for hindent.


===============================================================================
hlint                                                       *ale-haskell-hlint*

                                         *ale-options.haskell_hlint_executable*
                                               *g:ale_haskell_hlint_executable*
                                               *b:ale_haskell_hlint_executable*
haskell_hlint_executable
g:ale_haskell_hlint_executable
  Type: |String|
  Default: `'hlint'`

  This variable can be changed to use a different executable for hlint.

                                            *ale-options.haskell_hlint_options*
                                                  *g:ale_haskell_hlint_options*
                                                  *b:ale_haskell_hlint_options*
haskell_hlint_options
g:ale_haskell_hlint_options
  Type: |String|
  Default: `''`

  This variable can be used to pass extra options to the underlying hlint
  executable.


===============================================================================
hls                                                           *ale-haskell-hls*

                                           *ale-options.haskell_hls_executable*
                                                 *g:ale_haskell_hls_executable*
                                                 *b:ale_haskell_hls_executable*
haskell_hls_executable
g:ale_haskell_hls_executable
  Type: |String|
  Default: `'haskell-language-server-wrapper'`

  This variable can be changed to use a different executable for the haskell
  language server.

                                               *ale-options.haskell_hls_config*
                                                     *g:ale_haskell_hls_config*
                                                     *b:ale_haskell_hls_config*
haskell_hls_config
g:ale_haskell_hls_config
  Type: |Dictionary|
  Default: `{}`

  Dictionary with configuration settings for HLS. For example, to see more
  completions:
>
  let g:ale_haskell_hls_config = {'haskell': {'maxCompletions': 250}}
<
  Refer to HLS documentation for possible settings:
  https://haskell-language-server.readthedocs.io/en/latest/configuration.html#language-specific-server-options


===============================================================================
stack-build                                           *ale-haskell-stack-build*

                                      *ale-options.haskell_stack_build_options*
                                            *g:ale_haskell_stack_build_options*
                                            *b:ale_haskell_stack_build_options*
haskell_stack_build_options
g:ale_haskell_stack_build_options
  Type: |String|
  Default: `'--fast'`

  We default to using `'--fast'`. Since Stack generates binaries, your
  programs will be slower unless you separately rebuild them outside of ALE.


===============================================================================
stack-ghc                                               *ale-haskell-stack-ghc*

                                        *ale-options.haskell_stack_ghc_options*
                                              *g:ale_haskell_stack_ghc_options*
                                              *b:ale_haskell_stack_ghc_options*
haskell_stack_ghc_options
g:ale_haskell_stack_ghc_options
  Type: |String|
  Default: `'-fno-code -v0'`

  This variable can be changed to modify flags given to ghc through `stack
  ghc`


===============================================================================
stylish-haskell                                   *ale-haskell-stylish-haskell*

                               *ale-options.haskell_stylish_haskell_executable*
                                     *g:ale_haskell_stylish_haskell_executable*
                                     *b:ale_haskell_stylish_haskell_executable*
haskell_stylish_haskell_executable
g:ale_haskell_stylish_haskell_executable
  Type: |String|
  Default: `'stylish-haskell'`

  This variable can be changed to use a different executable for stylish-haskell.


===============================================================================
hie                                                           *ale-haskell-hie*

                                           *ale-options.haskell_hie_executable*
                                                 *g:ale_haskell_hie_executable*
                                                 *b:ale_haskell_hie_executable*
haskell_hie_executable
g:ale_haskell_hie_executable
  Type: |String|
  Default: `'hie'`

  This variable can be changed to use a different executable for the haskell
  ide engine. i.e. `'hie-wrapper'`


===============================================================================
ormolu                                                     *ale-haskell-ormolu*

                                        *ale-options.haskell_ormolu_executable*
                                              *g:ale_haskell_ormolu_executable*
                                              *b:ale_haskell_ormolu_executable*
haskell_ormolu_executable
g:ale_haskell_ormolu_executable
  Type: |String|
  Default: `'ormolu'`

  This variable can be changed to use a different executable for ormolu.

                                           *ale-options.haskell_ormolu_options*
                                                 *g:ale_haskell_ormolu_options*
                                                 *b:ale_haskell_ormolu_options*
haskell_ormolu_options
g:ale_haskell_ormolu_options
  Type: |String|
  Default: `''`

  This variable can be used to pass extra options to the underlying ormolu
  executable.


===============================================================================
fourmolu                                                 *ale-haskell-fourmolu*

                                      *ale-options.haskell_fourmolu_executable*
                                            *g:ale_haskell_fourmolu_executable*
                                            *b:ale_haskell_fourmolu_executable*
haskell_fourmolu_executable
g:ale_haskell_fourmolu_executable
  Type: |String|
  Default: `'fourmolu'`

  This variable can be changed to use a different executable for fourmolu.

                                         *ale-options.haskell_fourmolu_options*
                                               *g:ale_haskell_fourmolu_options*
                                               *b:ale_haskell_fourmolu_options*
haskell_fourmolu_options
g:ale_haskell_fourmolu_options
  Type: |String|
  Default: `''`

  This variable can be used to pass extra options to the underlying fourmolu
  executable.


===============================================================================
  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: