doc/ale-haskell.txt

   1 ===============================================================================
   2 ALE Haskell Integration                                   *ale-haskell-options*
   3
   4
   5 ===============================================================================
   6 brittany                                                 *ale-haskell-brittany*
   7
   8                                       *ale-options.haskell_brittany_executable*
   9                                             *g:ale_haskell_brittany_executable*
  10                                             *b:ale_haskell_brittany_executable*
  11 haskell_brittany_executable
  12 g:ale_haskell_brittany_executable
  13   Type: |String|
  14   Default: `'brittany'`
  15
  16   This variable can be changed to use a different executable for brittany.
  17
  18
  19 ===============================================================================
  20 cspell                                                     *ale-haskell-cspell*
  21
  22 See |ale-cspell-options|
  23
  24
  25 ===============================================================================
  26 floskell                                                 *ale-haskell-floskell*
  27
  28                                       *ale-options.haskell_floskell_executable*
  29                                             *g:ale_haskell_floskell_executable*
  30                                             *b:ale_haskell_floskell_executable*
  31 haskell_floskell_executable
  32 g:ale_haskell_floskell_executable
  33   Type: |String|
  34   Default: `'floskell'`
  35
  36   This variable can be changed to use a different executable for floskell.
  37
  38
  39 ===============================================================================
  40 ghc                                                           *ale-haskell-ghc*
  41
  42                                               *ale-options.haskell_ghc_options*
  43                                                     *g:ale_haskell_ghc_options*
  44                                                     *b:ale_haskell_ghc_options*
  45 haskell_ghc_options
  46 g:ale_haskell_ghc_options
  47   Type: |String|
  48   Default: `'-fno-code -v0'`
  49
  50   This variable can be changed to modify flags given to ghc.
  51
  52
  53 ===============================================================================
  54 ghc-mod                                                   *ale-haskell-ghc-mod*
  55
  56                                        *ale-options.haskell_ghc_mod_executable*
  57                                              *g:ale_haskell_ghc_mod_executable*
  58                                              *b:ale_haskell_ghc_mod_executable*
  59 haskell_ghc_mod_executable
  60 g:ale_haskell_ghc_mod_executable
  61   Type: |String|
  62   Default: `'ghc-mod'`
  63
  64   This variable can be changed to use a different executable for ghc-mod.
  65
  66
  67 ===============================================================================
  68 cabal-ghc                                               *ale-haskell-cabal-ghc*
  69
  70                                         *ale-options.haskell_cabal_ghc_options*
  71                                               *g:ale_haskell_cabal_ghc_options*
  72                                               *b:ale_haskell_cabal_ghc_options*
  73 haskell_cabal_ghc_options
  74 g:ale_haskell_cabal_ghc_options
  75   Type: |String|
  76   Default: `'-fno-code -v0'`
  77
  78   This variable can be changed to modify flags given to ghc through cabal
  79   exec.
  80
  81
  82 ===============================================================================
  83 hdevtools                                               *ale-haskell-hdevtools*
  84
  85                                      *ale-options.haskell_hdevtools_executable*
  86                                            *g:ale_haskell_hdevtools_executable*
  87                                            *b:ale_haskell_hdevtools_executable*
  88 haskell_hdevtools_executable
  89 g:ale_haskell_hdevtools_executable
  90   Type: |String|
  91   Default: `'hdevtools'`
  92
  93   This variable can be changed to use a different executable for hdevtools.
  94
  95                                         *ale-options.haskell_hdevtools_options*
  96                                               *g:ale_haskell_hdevtools_options*
  97                                               *b:ale_haskell_hdevtools_options*
  98 haskell_hdevtools_options
  99 g:ale_haskell_hdevtools_options
 100   Type: |String|
 101   Default: `get(g:, 'hdevtools_options', '-g -Wall')`
 102
 103   This variable can be changed to modify flags given to hdevtools.
 104
 105   The hdevtools documentation recommends setting GHC options for `hdevtools`
 106   with `g:hdevtools_options`. ALE will use the value of `g:hdevtools_options`
 107   for the value of `g:ale_haskell_hdevtools_options` by default, so this
 108   option can be respected and overridden specifically for ALE.
 109
 110
 111 ===============================================================================
 112 hfmt                                                         *ale-haskell-hfmt*
 113
 114                                           *ale-options.haskell_hfmt_executable*
 115                                                 *g:ale_haskell_hfmt_executable*
 116                                                 *b:ale_haskell_hfmt_executable*
 117 haskell_hfmt_executable
 118 g:ale_haskell_hfmt_executable
 119   Type: |String|
 120   Default: `'hfmt'`
 121
 122   This variable can be changed to use a different executable for hfmt.
 123
 124
 125 ===============================================================================
 126 hindent                                                   *ale-haskell-hindent*
 127
 128                                        *ale-options.haskell_hindent_executable*
 129                                              *g:ale_haskell_hindent_executable*
 130                                              *b:ale_haskell_hindent_executable*
 131 haskell_hindent_executable
 132 g:ale_haskell_hindent_executable
 133   Type: |String|
 134   Default: `'hindent'`
 135
 136   This variable can be changed to use a different executable for hindent.
 137
 138
 139 ===============================================================================
 140 hlint                                                       *ale-haskell-hlint*
 141
 142                                          *ale-options.haskell_hlint_executable*
 143                                                *g:ale_haskell_hlint_executable*
 144                                                *b:ale_haskell_hlint_executable*
 145 haskell_hlint_executable
 146 g:ale_haskell_hlint_executable
 147   Type: |String|
 148   Default: `'hlint'`
 149
 150   This variable can be changed to use a different executable for hlint.
 151
 152                                             *ale-options.haskell_hlint_options*
 153                                                   *g:ale_haskell_hlint_options*
 154                                                   *b:ale_haskell_hlint_options*
 155 haskell_hlint_options
 156 g:ale_haskell_hlint_options
 157   Type: |String|
 158   Default: `''`
 159
 160   This variable can be used to pass extra options to the underlying hlint
 161   executable.
 162
 163
 164 ===============================================================================
 165 hls                                                           *ale-haskell-hls*
 166
 167                                            *ale-options.haskell_hls_executable*
 168                                                  *g:ale_haskell_hls_executable*
 169                                                  *b:ale_haskell_hls_executable*
 170 haskell_hls_executable
 171 g:ale_haskell_hls_executable
 172   Type: |String|
 173   Default: `'haskell-language-server-wrapper'`
 174
 175   This variable can be changed to use a different executable for the haskell
 176   language server.
 177
 178                                                *ale-options.haskell_hls_config*
 179                                                      *g:ale_haskell_hls_config*
 180                                                      *b:ale_haskell_hls_config*
 181 haskell_hls_config
 182 g:ale_haskell_hls_config
 183   Type: |Dictionary|
 184   Default: `{}`
 185
 186   Dictionary with configuration settings for HLS. For example, to see more
 187   completions:
 188 >
 189   let g:ale_haskell_hls_config = {'haskell': {'maxCompletions': 250}}
 190 <
 191   Refer to HLS documentation for possible settings:
 192   https://haskell-language-server.readthedocs.io/en/latest/configuration.html#language-specific-server-options
 193
 194
 195 ===============================================================================
 196 stack-build                                           *ale-haskell-stack-build*
 197
 198                                       *ale-options.haskell_stack_build_options*
 199                                             *g:ale_haskell_stack_build_options*
 200                                             *b:ale_haskell_stack_build_options*
 201 haskell_stack_build_options
 202 g:ale_haskell_stack_build_options
 203   Type: |String|
 204   Default: `'--fast'`
 205
 206   We default to using `'--fast'`. Since Stack generates binaries, your
 207   programs will be slower unless you separately rebuild them outside of ALE.
 208
 209
 210 ===============================================================================
 211 stack-ghc                                               *ale-haskell-stack-ghc*
 212
 213                                         *ale-options.haskell_stack_ghc_options*
 214                                               *g:ale_haskell_stack_ghc_options*
 215                                               *b:ale_haskell_stack_ghc_options*
 216 haskell_stack_ghc_options
 217 g:ale_haskell_stack_ghc_options
 218   Type: |String|
 219   Default: `'-fno-code -v0'`
 220
 221   This variable can be changed to modify flags given to ghc through `stack
 222   ghc`
 223
 224
 225 ===============================================================================
 226 stylish-haskell                                   *ale-haskell-stylish-haskell*
 227
 228                                *ale-options.haskell_stylish_haskell_executable*
 229                                      *g:ale_haskell_stylish_haskell_executable*
 230                                      *b:ale_haskell_stylish_haskell_executable*
 231 haskell_stylish_haskell_executable
 232 g:ale_haskell_stylish_haskell_executable
 233   Type: |String|
 234   Default: `'stylish-haskell'`
 235
 236   This variable can be changed to use a different executable for stylish-haskell.
 237
 238
 239 ===============================================================================
 240 hie                                                           *ale-haskell-hie*
 241
 242                                            *ale-options.haskell_hie_executable*
 243                                                  *g:ale_haskell_hie_executable*
 244                                                  *b:ale_haskell_hie_executable*
 245 haskell_hie_executable
 246 g:ale_haskell_hie_executable
 247   Type: |String|
 248   Default: `'hie'`
 249
 250   This variable can be changed to use a different executable for the haskell
 251   ide engine. i.e. `'hie-wrapper'`
 252
 253
 254 ===============================================================================
 255 ormolu                                                     *ale-haskell-ormolu*
 256
 257                                         *ale-options.haskell_ormolu_executable*
 258                                               *g:ale_haskell_ormolu_executable*
 259                                               *b:ale_haskell_ormolu_executable*
 260 haskell_ormolu_executable
 261 g:ale_haskell_ormolu_executable
 262   Type: |String|
 263   Default: `'ormolu'`
 264
 265   This variable can be changed to use a different executable for ormolu.
 266
 267                                            *ale-options.haskell_ormolu_options*
 268                                                  *g:ale_haskell_ormolu_options*
 269                                                  *b:ale_haskell_ormolu_options*
 270 haskell_ormolu_options
 271 g:ale_haskell_ormolu_options
 272   Type: |String|
 273   Default: `''`
 274
 275   This variable can be used to pass extra options to the underlying ormolu
 276   executable.
 277
 278
 279 ===============================================================================
 280 fourmolu                                                 *ale-haskell-fourmolu*
 281
 282                                       *ale-options.haskell_fourmolu_executable*
 283                                             *g:ale_haskell_fourmolu_executable*
 284                                             *b:ale_haskell_fourmolu_executable*
 285 haskell_fourmolu_executable
 286 g:ale_haskell_fourmolu_executable
 287   Type: |String|
 288   Default: `'fourmolu'`
 289
 290   This variable can be changed to use a different executable for fourmolu.
 291
 292                                          *ale-options.haskell_fourmolu_options*
 293                                                *g:ale_haskell_fourmolu_options*
 294                                                *b:ale_haskell_fourmolu_options*
 295 haskell_fourmolu_options
 296 g:ale_haskell_fourmolu_options
 297   Type: |String|
 298   Default: `''`
 299
 300   This variable can be used to pass extra options to the underlying fourmolu
 301   executable.
 302
 303
 304 ===============================================================================
 305   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: