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

   1 ===============================================================================
   2 ALE OCaml Integration                                       *ale-ocaml-options*
   3
   4
   5 ===============================================================================
   6 dune                                                           *ale-ocaml-dune*
   7
   8   Dune is a build system for OCaml projects. The `dune format` command is
   9   supported for automatically formatting `dune` and `dune-project` files.
  10
  11                                             *ale-options.ocaml_dune_executable*
  12                                                   *g:ale_ocaml_dune_executable*
  13                                                   *b:ale_ocaml_dune_executable*
  14 ocaml_dune_executable
  15 g:ale_ocaml_dune_executable
  16   Type: |String|
  17   Default: `'dune'`
  18
  19   This variable can be set to pass the path to dune.
  20
  21                                                *ale-options.ocaml_dune_options*
  22                                                      *g:ale_ocaml_dune_options*
  23                                                      *b:ale_ocaml_dune_options*
  24 ocaml_dune_options
  25 g:ale_ocaml_dune_options
  26   Type: |String|
  27   Default: `''`
  28
  29   This variable can be set to pass additional options to the dune fixer.
  30
  31
  32 ===============================================================================
  33 merlin                                                       *ale-ocaml-merlin*
  34
  35   To use merlin linter for OCaml source code you need to make sure Merlin for
  36   Vim is correctly configured. See the corresponding Merlin wiki page for
  37   detailed instructions
  38   (https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch).
  39
  40
  41 ===============================================================================
  42 ocamllsp                                                   *ale-ocaml-ocamllsp*
  43
  44   The `ocaml-lsp-server` is the official OCaml implementation of the Language
  45   Server Protocol. See the installation instructions:
  46   https://github.com/ocaml/ocaml-lsp#installation
  47
  48                                           *ale-options.ocaml_ocamllsp_use_opam*
  49                                                 *g:ale_ocaml_ocamllsp_use_opam*
  50                                                 *b:ale_ocaml_ocamllsp_use_opam*
  51 ocaml_ocamllsp_use_opam
  52 g:ale_ocaml_ocamllsp_use_opam
  53   Type: |Number|
  54   Default: `get(g:, 'ale_ocaml_ocamllsp_use_opam', 1)`
  55
  56   This variable can be set to change whether or not opam is used to execute
  57   the language server.
  58
  59 ===============================================================================
  60 ols                                                             *ale-ocaml-ols*
  61
  62   The `ocaml-language-server` is the engine that powers OCaml and ReasonML
  63   editor support using the Language Server Protocol. See the installation
  64   instructions:
  65   https://github.com/freebroccolo/ocaml-language-server#installation
  66
  67                                              *ale-options.ocaml_ols_executable*
  68                                                    *g:ale_ocaml_ols_executable*
  69                                                    *b:ale_ocaml_ols_executable*
  70 ocaml_ols_executable
  71 g:ale_ocaml_ols_executable
  72   Type: |String|
  73   Default: `'ocaml-language-server'`
  74
  75   This variable can be set to change the executable path for `ols`.
  76
  77                                              *ale-options.ocaml_ols_use_global*
  78                                                    *g:ale_ocaml_ols_use_global*
  79                                                    *b:ale_ocaml_ols_use_global*
  80 ocaml_ols_use_global
  81 g:ale_ocaml_ols_use_global
  82   Type: |String|
  83   Default: `get(g:, 'ale_use_global_executables', 0)`
  84
  85   This variable can be set to `1` to always use the globally installed
  86   executable. See also |ale-integrations-local-executables|.
  87
  88
  89 ===============================================================================
  90 ocamlformat                                             *ale-ocaml-ocamlformat*
  91
  92                                      *ale-options.ocaml_ocamlformat_executable*
  93                                            *g:ale_ocaml_ocamlformat_executable*
  94                                            *b:ale_ocaml_ocamlformat_executable*
  95 ocaml_ocamlformat_executable
  96 g:ale_ocaml_ocamlformat_executable
  97   Type: |String|
  98   Default: `'ocamlformat'`
  99
 100   This variable can be set to pass the path of the ocamlformat fixer.
 101
 102                                         *ale-options.ocaml_ocamlformat_options*
 103                                               *g:ale_ocaml_ocamlformat_options*
 104                                               *b:ale_ocaml_ocamlformat_options*
 105 ocaml_ocamlformat_options
 106 g:ale_ocaml_ocamlformat_options
 107   Type: |String|
 108   Default: `''`
 109
 110   This variable can be set to pass additional options to the ocamlformat fixer.
 111
 112
 113 ===============================================================================
 114 ocp-indent                                               *ale-ocaml-ocp-indent*
 115
 116                                       *ale-options.ocaml_ocp_indent_executable*
 117                                             *g:ale_ocaml_ocp_indent_executable*
 118                                             *b:ale_ocaml_ocp_indent_executable*
 119 ocaml_ocp_indent_executable
 120 g:ale_ocaml_ocp_indent_executable
 121   Type: |String|
 122   Default: `ocp-indent`
 123
 124   This variable can be set to pass the path of the ocp-indent.
 125
 126                                          *ale-options.ocaml_ocp_indent_options*
 127                                                *g:ale_ocaml_ocp_indent_options*
 128                                                *b:ale_ocaml_ocp_indent_options*
 129 ocaml_ocp_indent_options
 130 g:ale_ocaml_ocp_indent_options
 131   Type: |String|
 132   Default: `''`
 133
 134   This variable can be set to pass additional options to the ocp-indent.
 135
 136                                           *ale-options.ocaml_ocp_indent_config*
 137                                                 *g:ale_ocaml_ocp_indent_config*
 138                                                 *b:ale_ocaml_ocp_indent_config*
 139 ocaml_ocp_indent_config
 140 g:ale_ocaml_ocp_indent_config
 141   Type: |String|
 142   Default: `''`
 143
 144   This variable can be set to pass additional config to the ocp-indent.
 145   Expand after "--config=".
 146
 147   "ocp-indent" can also be enabled from ocamlformat config.
 148
 149
 150 ===============================================================================
 151   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: