Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 871 Bytes

bp_07_ocamlformat.md

File metadata and controls

25 lines (19 loc) · 871 Bytes
id title short_title description category
formatting-your-code
Formatting Your Code With OCamlFormat
Formatting Your Code
How to set up OCamlFormat to automatically format your code
Best Practices

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