VimPlug/ale
1
0
Fork 0
mirror of https://github.com/dense-analysis/ale.git synced 2026-05-26 02:08:44 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Implement Lua ALE setup & overhaul documentation

Browse Source 
1. Add ale.setup and ale.setup.buffer for pure Lua configuration.
2. Update many global settings to use Booleans instead of numbers to
   make types easiert to work with in Lua.
3. Radically reformat documentation and fix errors to make
   documentation more usable for Neovim users.
This commit is contained in:
w0rp
2025-03-20 21:33:12 +00:00
parent 53f036fe9f
commit bcd1a12949
146 changed files with 5469 additions and 2642 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/ale-ocaml.txt
+44 -10
View File
@@ -8,20 +8,27 @@ 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.
g:ale_ocaml_dune_executable *g:ale_ocaml_dune_executable*
*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.
g:ale_ocaml_dune_options *g:ale_ocaml_dune_options*
*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*
@@ -30,6 +37,7 @@ merlin *ale-ocaml-merlin*
detailed instructions
(https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch).
===============================================================================
ocamllsp *ale-ocaml-ocamllsp*
@@ -37,8 +45,11 @@ ocamllsp *ale-ocaml-ocamllsp*
Server Protocol. See the installation instructions:
https://github.com/ocaml/ocaml-lsp#installation
g:ale_ocaml_ocamllsp_use_opam *g:ale_ocaml_ocamllsp_use_opam*
*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)`
@@ -53,57 +64,80 @@ ols *ale-ocaml-ols*
instructions:
https://github.com/freebroccolo/ocaml-language-server#installation
g:ale_ocaml_ols_executable *g:ale_ocaml_ols_executable*
*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`.
g:ale_ocaml_ols_use_global *g:ale_ocaml_ols_use_global*
*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*
g:ale_ocaml_ocamlformat_executable *g:ale_ocaml_ocamlformat_executable*
*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.
g:ale_ocaml_ocamlformat_options *g:ale_ocaml_ocamlformat_options*
*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*
g:ale_ocaml_ocp_indent_executable *g:ale_ocaml_ocp_indent_executable*
*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.
g:ale_ocaml_ocp_indent_options *g:ale_ocaml_ocp_indent_options*
*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.
g:ale_ocaml_ocp_indent_config *g:ale_ocaml_ocp_indent_config*
*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: `''`