vimrc/sources_non_forked/ale/doc/ale-haskell.txt

229 lines
8.7 KiB
Text
Raw Normal View History

===============================================================================
ALE Haskell Integration *ale-haskell-options*
===============================================================================
brittany *ale-haskell-brittany*
g:ale_haskell_brittany_executable *g:ale_haskell_brittany_executable*
*b:ale_haskell_brittany_executable*
Type: |String|
Default: `'brittany'`
This variable can be changed to use a different executable for brittany.
2019-08-22 15:36:17 +00:00
2022-08-08 13:45:56 +00:00
===============================================================================
cspell *ale-haskell-cspell*
See |ale-cspell-options|
2019-05-17 14:09:13 +00:00
===============================================================================
floskell *ale-haskell-floskell*
g:ale_haskell_floskell_executable *g:ale_haskell_floskell_executable*
*b:ale_haskell_floskell_executable*
Type: |String|
Default: `'floskell'`
This variable can be changed to use a different executable for floskell.
2019-08-22 15:36:17 +00:00
===============================================================================
ghc *ale-haskell-ghc*
g:ale_haskell_ghc_options *g:ale_haskell_ghc_options*
*b:ale_haskell_ghc_options*
Type: |String|
Default: `'-fno-code -v0'`
This variable can be changed to modify flags given to ghc.
2019-08-22 15:36:17 +00:00
2018-09-30 20:58:57 +00:00
===============================================================================
ghc-mod *ale-haskell-ghc-mod*
g:ale_haskell_ghc_mod_executable *g:ale_haskell_ghc_mod_executable*
*b:ale_haskell_ghc_mod_executable*
Type: |String|
Default: `'ghc-mod'`
This variable can be changed to use a different executable for ghc-mod.
2019-08-22 15:36:17 +00:00
===============================================================================
2018-07-30 21:18:16 +00:00
cabal-ghc *ale-haskell-cabal-ghc*
g:ale_haskell_cabal_ghc_options *g:ale_haskell_cabal_ghc_options*
*b: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.
2019-08-22 15:36:17 +00:00
2018-07-30 21:18:16 +00:00
===============================================================================
hdevtools *ale-haskell-hdevtools*
g:ale_haskell_hdevtools_executable *g:ale_haskell_hdevtools_executable*
*b:ale_haskell_hdevtools_executable*
Type: |String|
Default: `'hdevtools'`
This variable can be changed to use a different executable for hdevtools.
g:ale_haskell_hdevtools_options *g:ale_haskell_hdevtools_options*
*b:ale_haskell_hdevtools_options*
Type: |String|
2018-06-14 10:31:12 +00:00
Default: `get(g:, 'hdevtools_options', '-g -Wall')`
This variable can be changed to modify flags given to hdevtools.
2018-06-14 10:31:12 +00:00
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*
g:ale_haskell_hfmt_executable *g:ale_haskell_hfmt_executable*
*b:ale_haskell_hfmt_executable*
Type: |String|
Default: `'hfmt'`
This variable can be changed to use a different executable for hfmt.
2019-08-22 15:36:17 +00:00
===============================================================================
hindent *ale-haskell-hindent*
g:ale_haskell_hindent_executable *g:ale_haskell_hindent_executable*
*b:ale_haskell_hindent_executable*
Type: |String|
Default: `'hindent'`
This variable can be changed to use a different executable for hindent.
2018-08-25 16:13:42 +00:00
===============================================================================
hlint *ale-haskell-hlint*
g:ale_haskell_hlint_executable *g:ale_haskell_hlint_executable*
*b:ale_haskell_hlint_executable*
Type: |String|
Default: `'hlint'`
This variable can be changed to use a different executable for hlint.
2018-09-30 20:58:57 +00:00
g:ale_haskell_hlint_options g:ale_haskell_hlint_options
b:ale_haskell_hlint_options
2022-11-20 11:21:23 +00:00
Type: |String|
Default: `''`
2018-09-30 20:58:57 +00:00
This variable can be used to pass extra options to the underlying hlint
executable.
2019-08-22 15:36:17 +00:00
2021-05-05 08:25:00 +00:00
===============================================================================
hls *ale-haskell-hls*
g:ale_haskell_hls_executable *g:ale_haskell_hls_executable*
2022-08-08 13:45:56 +00:00
*b:ale_haskell_hls_executable*
2021-05-05 08:25:00 +00:00
Type: |String|
Default: `'haskell-language-server-wrapper'`
This variable can be changed to use a different executable for the haskell
language server.
2022-08-08 13:45:56 +00:00
g:ale_haskell_hls_config *g:ale_haskell_hls_config*
*b: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*
g:ale_haskell_stack_build_options *g:ale_haskell_stack_build_options*
*b: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.
2019-08-22 15:36:17 +00:00
2018-08-25 16:13:42 +00:00
===============================================================================
2019-03-08 11:04:56 +00:00
stack-ghc *ale-haskell-stack-ghc*
g:ale_haskell_stack_ghc_options *g:ale_haskell_stack_ghc_options*
*b: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`
2019-08-22 15:36:17 +00:00
2019-03-08 11:04:56 +00:00
===============================================================================
2018-08-25 16:13:42 +00:00
stylish-haskell *ale-haskell-stylish-haskell*
g:ale_haskell_stylish_haskell_executable
*g:ale_haskell_stylish_haskell_executable*
*b:ale_haskell_stylish_haskell_executable*
Type: |String|
Default: `'stylish-haskell'`
This variable can be changed to use a different executable for stylish-haskell.
2019-08-22 15:36:17 +00:00
2018-08-25 16:13:42 +00:00
===============================================================================
hie *ale-haskell-hie*
g:ale_haskell_hie_executable *g:ale_haskell_hie_executable*
*b: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'`
2019-08-22 15:36:17 +00:00
2020-12-04 21:15:32 +00:00
===============================================================================
ormolu *ale-haskell-ormolu*
g:ale_haskell_ormolu_executable *g:ale_haskell_ormolu_executable*
*b:ale_haskell_ormolu_executable*
Type: |String|
Default: `'ormolu'`
This variable can be changed to use a different executable for ormolu.
g:ale_haskell_ormolu_options *g:ale_haskell_ormolu_options*
*b:ale_haskell_ormolu_options*
2022-11-20 11:21:23 +00:00
Type: |String|
Default: `''`
2020-12-04 21:15:32 +00:00
This variable can be used to pass extra options to the underlying ormolu
executable.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: