History

Henrik Lissner d1d9cffcc8 lang/ocaml: major refactor + Load flyspell-mode a little later, to allow file/dir-local variables to customize flyspell. + Ensure setters (in merlin's config) are used as late as possible, by making merlin's (and all the other packages) config run after tuareg is loaded. + As discussed, installing packages locally is a bit unreliable, so I'm commenting out the +ocaml-site-lisp flag, and rely solely on packages from MELPA. + Add optional ocamlformat check in doctor.el and conditionally load the ocamlformat package (if editor/format is enabled). + Add docstrings to init hooks.		2018-10-16 02:49:21 -04:00
..
config.el	lang/ocaml: major refactor	2018-10-16 02:49:21 -04:00
doctor.el	lang/ocaml: major refactor	2018-10-16 02:49:21 -04:00
packages.el	lang/ocaml: major refactor	2018-10-16 02:49:21 -04:00
README.org	Improve ocaml language support	2018-10-15 20:37:58 +01:00

README.org

:lang ocaml

Table of Contents
Module Flags
Prerequisites
Features
Configuration
Appendix
- Commands
- Hacks

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

Code completion, look up documentation, and code navigation (merlin)
REPL (utop)
Syntax-checking (merlin with flycheck-ocaml)
Auto-indentation (ocp-indent)
Code formatting (ocamlformat)
Dune file format (dune)

Table of Contents TOC

Module Flags

This module provides the +opam-site-lisp flag to compile editor support .el files from opam's site-lisp directory. By default all editor plugins are installed from MELPA/GitHub even if the corresponding opam package isn't installed. If this flag is enabled then you must have all of the packages listed in package.el installed via opam.

To enable this, use:

(doom! :lang (ocaml +opam-site-lisp))

Prerequisites

It is highly recommended to install opam. To get all the features you should also install these opam packages, however they are not all required (features should be disabled gracefully when a tool is missing):

opam install merlin utop ocp-indent dune ocamlformat

Features

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 when installed

Configuration

if :completion company is enabled then autocomplete is provided by merlin
when :feature syntax-checker 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 :feature spellcheck is actived
a REPL is provided if utop is installed and :feature eval is actived
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

Run make install to install all packages, and make doctor to diagnose missing tools.

Appendix

Commands

command	key / ex command	description
`merlin-type-enclosing`	`SPC m t`	display type under point
`tuareg-find-alternate-file`	`SPC m a`	switch between `.ml` and `.mli`
`merlin-locate`	`gd`	lookup definition
`merlin-occurences`	`SPC c D`	lookup references
`merlin-document`	`K`	lookup documentation
`utop`	`SPC o r`	open `utop` as REPL
`utop-eval-region`	`SPC c e`	evaluate selected region in `utop`

Hacks

set-pretty-symbols! 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