aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc/ale-ocaml.txt
blob: 97feb35fcd90a8be98e3582d4414bc311180031c (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
===============================================================================
ALE OCaml Integration                                       *ale-ocaml-options*


===============================================================================
dune                                                           *ale-ocaml-dune*

  Dune is a build system for OCaml projects. The `dune format` command is
  supported for automatically formatting `dune` and `dune-project` files.

                                            *ale-options.ocaml_dune_executable*
                                                  *g:ale_ocaml_dune_executable*
                                                  *b:ale_ocaml_dune_executable*
ocaml_dune_executable
g:ale_ocaml_dune_executable
  Type: |String|
  Default: `'dune'`

  This variable can be set to pass the path to dune.

                                               *ale-options.ocaml_dune_options*
                                                     *g:ale_ocaml_dune_options*
                                                     *b:ale_ocaml_dune_options*
ocaml_dune_options
g:ale_ocaml_dune_options
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to the dune fixer.


===============================================================================
merlin                                                       *ale-ocaml-merlin*

  To use merlin linter for OCaml source code you need to make sure Merlin for
  Vim is correctly configured. See the corresponding Merlin wiki page for
  detailed instructions
  (https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch).


===============================================================================
ocamllsp                                                   *ale-ocaml-ocamllsp*

  The `ocaml-lsp-server` is the official OCaml implementation of the Language
  Server Protocol. See the installation instructions:
  https://github.com/ocaml/ocaml-lsp#installation

                                          *ale-options.ocaml_ocamllsp_use_opam*
                                                *g:ale_ocaml_ocamllsp_use_opam*
                                                *b:ale_ocaml_ocamllsp_use_opam*
ocaml_ocamllsp_use_opam
g:ale_ocaml_ocamllsp_use_opam
  Type: |Number|
  Default: `get(g:, 'ale_ocaml_ocamllsp_use_opam', 1)`

  This variable can be set to change whether or not opam is used to execute
  the language server.

===============================================================================
ols                                                             *ale-ocaml-ols*

  The `ocaml-language-server` is the engine that powers OCaml and ReasonML
  editor support using the Language Server Protocol. See the installation
  instructions:
  https://github.com/freebroccolo/ocaml-language-server#installation

                                             *ale-options.ocaml_ols_executable*
                                                   *g:ale_ocaml_ols_executable*
                                                   *b:ale_ocaml_ols_executable*
ocaml_ols_executable
g:ale_ocaml_ols_executable
  Type: |String|
  Default: `'ocaml-language-server'`

  This variable can be set to change the executable path for `ols`.

                                             *ale-options.ocaml_ols_use_global*
                                                   *g:ale_ocaml_ols_use_global*
                                                   *b:ale_ocaml_ols_use_global*
ocaml_ols_use_global
g:ale_ocaml_ols_use_global
  Type: |String|
  Default: `get(g:, 'ale_use_global_executables', 0)`

  This variable can be set to `1` to always use the globally installed
  executable. See also |ale-integrations-local-executables|.


===============================================================================
ocamlformat                                             *ale-ocaml-ocamlformat*

                                     *ale-options.ocaml_ocamlformat_executable*
                                           *g:ale_ocaml_ocamlformat_executable*
                                           *b:ale_ocaml_ocamlformat_executable*
ocaml_ocamlformat_executable
g:ale_ocaml_ocamlformat_executable
  Type: |String|
  Default: `'ocamlformat'`

  This variable can be set to pass the path of the ocamlformat fixer.

                                        *ale-options.ocaml_ocamlformat_options*
                                              *g:ale_ocaml_ocamlformat_options*
                                              *b:ale_ocaml_ocamlformat_options*
ocaml_ocamlformat_options
g:ale_ocaml_ocamlformat_options
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to the ocamlformat fixer.


===============================================================================
ocp-indent                                               *ale-ocaml-ocp-indent*

                                      *ale-options.ocaml_ocp_indent_executable*
                                            *g:ale_ocaml_ocp_indent_executable*
                                            *b:ale_ocaml_ocp_indent_executable*
ocaml_ocp_indent_executable
g:ale_ocaml_ocp_indent_executable
  Type: |String|
  Default: `ocp-indent`

  This variable can be set to pass the path of the ocp-indent.

                                         *ale-options.ocaml_ocp_indent_options*
                                               *g:ale_ocaml_ocp_indent_options*
                                               *b:ale_ocaml_ocp_indent_options*
ocaml_ocp_indent_options
g:ale_ocaml_ocp_indent_options
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to the ocp-indent.

                                          *ale-options.ocaml_ocp_indent_config*
                                                *g:ale_ocaml_ocp_indent_config*
                                                *b:ale_ocaml_ocp_indent_config*
ocaml_ocp_indent_config
g:ale_ocaml_ocp_indent_config
  Type: |String|
  Default: `''`

  This variable can be set to pass additional config to the ocp-indent.
  Expand after "--config=".

  "ocp-indent" can also be enabled from ocamlformat config.


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