History

Henrik Lissner ad6a3d0f33 refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.		2022-08-14 20:43:35 +02:00
..
autoload.el	Revert `3bb384f95` & improve ocaml comment continuation	2020-02-25 22:35:50 -05:00
config.el	refactor: deprecate featurep! for modulep!	2022-08-14 20:43:35 +02:00
doctor.el	refactor: deprecate featurep! for modulep!	2022-08-14 20:43:35 +02:00
packages.el	refactor: deprecate featurep! for modulep!	2022-08-14 20:43:35 +02:00
README.org	revert: fix(docs): set mode in file-local vars	2022-08-07 19:08:07 +02:00

:lang ocaml

Description unfold

This module adds OCaml support to Doom Emacs, powered by tuareg-mode.

Code completion, documentation look-up, code navigation and refactoring (merlin)
Type, documentation and function argument display on idle (merlin-eldoc)
REPL (utop)
Syntax-checking (merlin with flycheck-ocaml)
Auto-indentation (ocp-indent)
Code formatting (ocamlformat)
Dune file format (dune)

This module needs a maintainer. Become a maintainer?

+lsp: Enable LSP support for tuareg-mode. Requires :tools lsp and a langserver (supports ocaml-language-server).
+tree-sitter: Leverages tree-sitter for better syntax highlighting and structural text editing. Requires :tools tree-sitter.

set-ligatures! is called with the full tuareg prettify symbol list, this can cause columns to change as certain keywords are shortened (e.g. fun becomes λ).
tuareg-opam-update-env is called the first time tuareg is loaded

This module does not have a changelog yet.

This module requires the following packages available through opam:

🔨 This module's usage documentation is incomplete. Complete it?

The following files should have syntax highlighting support: .ml{i,p,y,}, .eliom{i,}, jbuild, dune, opam
merlin-mode is activated whenever a .merlin file is found (including in a parent directory) and ocamlmerlin executable is present
Line-based auto-indentation is provided by ocp-indent, if it is available.

Command	Key	Description
`merlin-type-enclosing`	<localleader> t	display type under point
`tuareg-find-alternate-file`	<localleader> a	switch between `.ml` and `.mli`
`merlin-locate`	g d	lookup definition
`merlin-occurences`	SPC c D	lookup references
`merlin-document`	K	lookup documentation
`merlin-imenu`	SPC s i	symbol lookup in file
`merlin-iedit-occurrences`	v R	visual refactor identifier under point (multiple cursors)
`utop`	SPC o r	open `utop` as REPL
`utop-eval-region`	SPC c e	evaluate selected region in `utop`

🔨 This module's configuration documentation is incomplete. Complete it?

If :completion company is enabled then autocomplete is provided by merlin
When :checkers syntax is enabled then flycheck-ocaml is activated to do on-the-fly syntax/type checking via merlin, otherwise this is only done when the file is saved.
Spell checking is activated in comments if :checkers spell is active
A REPL is provided if utop is installed and :tools eval is active
If :editor format is enabled, the ocamlformat executable is available and there is an .ocamlformat file present then format-all-buffer is bound to ocamlformat, otherwise to ocp-indent
If :editor multiple-cursors is enabled then identifiers can be refactored with v R and multiple cursors (this correctly matches identifier occurrences according to scope, it is not purely a textual match)

Run $ doom sync to install all packages and $ doom doctor to diagnose missing tools.

There are no known problems with this module. Report one?

This module has no FAQs yet. Ask one?

🔨 This module has no appendix yet. Write one?