.vim/bundle/ale/doc/ale-reasonml.txt

   1 ===============================================================================
   2 ALE ReasonML Integration                                 *ale-reasonml-options*
   3
   4
   5 ===============================================================================
   6 merlin                                                    *ale-reasonml-merlin*
   7
   8 To use merlin linter for ReasonML source code you need to make sure Merlin for
   9 Vim is correctly configured. See the corresponding Merlin wiki page for
  10 detailed instructions:
  11 https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch
  12
  13 ===============================================================================
  14 ols                                                          *ale-reasonml-ols*
  15
  16 The `ocaml-language-server` is the engine that powers OCaml and ReasonML
  17 editor support using the Language Server Protocol. See the installation
  18 instructions:
  19 https://github.com/freebroccolo/ocaml-language-server#installation
  20
  21
  22 -------------------------------------------------------------------------------
  23 Options
  24                                             *ale-options.reason_ols_executable*
  25                                                   *g:ale_reason_ols_executable*
  26                                                   *b:ale_reason_ols_executable*
  27 reason_ols_executable
  28 g:ale_reason_ols_executable
  29   Type: |String|
  30   Default: `'ocaml-language-server'`
  31
  32   This variable can be set to change the executable path for `ols`.
  33
  34                                             *ale-options.reason_ols_use_global*
  35                                                   *g:ale_reason_ols_use_global*
  36                                                   *b:ale_reason_ols_use_global*
  37 reason_ols_use_global
  38 g:ale_reason_ols_use_global
  39   Type: |String|
  40   Default: `get(g:, 'ale_use_global_executables', 0)`
  41
  42   This variable can be set to `1` to always use the globally installed
  43   executable. See also |ale-integrations-local-executables|.
  44
  45
  46 ===============================================================================
  47 reason-language-server                           *ale-reasonml-language-server*
  48
  49 Note: You must set an executable - there is no 'default' install location.
  50 Go to https://github.com/jaredly/reason-language-server and download the
  51 latest release. You can place it anywhere, but ensure you set the executable
  52 path.
  53
  54                                              *ale-options.reason_ls_executable*
  55                                                    *g:ale_reason_ls_executable*
  56                                                    *b:ale_reason_ls_executable*
  57 reason_ls_executable
  58 g:ale_reason_ls_executable
  59   Type: |String|
  60
  61   This variable defines the standard location of the language server
  62   executable. This must be set.
  63
  64
  65 ===============================================================================
  66 refmt                                                      *ale-reasonml-refmt*
  67
  68                                         *ale-options.reasonml_refmt_executable*
  69                                               *g:ale_reasonml_refmt_executable*
  70                                               *b:ale_reasonml_refmt_executable*
  71 reasonml_refmt_executable
  72 g:ale_reasonml_refmt_executable
  73   Type: |String|
  74   Default: `'refmt'`
  75
  76   This variable can be set to pass the path of the refmt fixer.
  77
  78                                            *ale-options.reasonml_refmt_options*
  79                                                  *g:ale_reasonml_refmt_options*
  80                                                  *b:ale_reasonml_refmt_options*
  81 reasonml_refmt_options
  82 g:ale_reasonml_refmt_options
  83   Type: |String|
  84   Default: `''`
  85
  86   This variable can be set to pass additional options to the refmt fixer.
  87
  88
  89 ===============================================================================
  90   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: