Formatting Your Code With OCamlFormat

Automatic formatting with OCamlFormat requires an .ocamlformat configuration file at the root of the project.

An empty file is accepted, but since different versions of OCamlFormat will vary in formatting, it is good practice to specify the version you're using. Running

$ echo "version = `ocamlformat --version`" > .ocamlformat

creates a configuration file for the currently installed version of OCamlFormat.

In addition to editor plugins that use OCamlFormat for automatic code formatting, Dune also offers a command to run OCamlFormat to automatically format all files from your codebase:

$ opam exec -- dune fmt

Help Improve Our Documentation

All OCaml docs are open source. See something that's wrong or unclear? Submit a pull request.


Innovation. Community. Security.