package ocamlformat

  1. Overview
  2. Docs
Auto-formatter for OCaml code

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (27)

Authors

  1. J
    Josh Berdine <jjb@fb.com>
  2. H
    Hugo Heuzard <hugo.heuzard@gmail.com>
  3. E
    Etienne Millon <etienne@tarides.com>
  4. G
    Guillaume Petiot <guillaume@tarides.com>
  5. J
    Jules Aguillon <jules@j3s.fr>

Maintainers

  1. G
    Guillaume Petiot <guillaume@tarides.com>
  2. J
    Jules Aguillon <jules@j3s.fr>
  3. E
    Emile Trotignon <emile@tarides.com>

Sources

ocamlformat-0.28.1.tbz
sha256=70bda037d0bed961ed91bdb5198b2eeef542444750a8b015d80ccb94b3ff41fb
sha512=8de0517165c6f0cadcedcce66e57cb723956768a8068abd062243abb08fabf292283d0d284be230aa5647d0883a4dc7f28fcf1b70338a2b0c9b17a5bed1bbb71

Description

ocamlformat is a code formatter for OCaml. It comes with opinionated default settings but is also fully customizable to suit your coding style.

  • Profiles: ocamlformat offers profiles we predefined formatting configurations. Profiles include default, ocamlformat, janestreet.
  • Configurable: Users can change the formatting profile and configure every option in their .ocamlformat configuration file.
  • Format Comments: ocamlformat can format comments, docstrings, and even code blocks in your comments.
  • RPC: ocamlformat provides an RPC server that can be used by other tools to easily format OCaml Code.

Published: 24 Oct 2025

README

ocamlformat

OCaml Code Formatter.

OCaml-CI Build Status

ocamlformat is a code formatter for OCaml. It comes with opinionated default settings but is also fully customizable to suit your coding style.

  • Profiles: ocamlformat offers profiles we predefined formatting configurations. Profiles include default, ocamlformat, janestreet.
  • Configurable: Users can change the formatting profile and configure every option in their .ocamlformat configuration file.
  • Format Comments: ocamlformat can format comments, docstrings, and even code blocks in your comments.
  • RPC: ocamlformat provides an RPC server that can bed used by other tools to easily format OCaml Code.

ocamlformat is part of the OCaml Platform, the recommended set of tools for OCaml.

Getting Started

Installation

To use ocamlformat, you will need OCaml and opam (the OCaml package manager) installed on your system. Visit the OCaml.org installation page for instructions.

With OCaml and opam installed, you can install ocamlformat with:

opam install ocamlformat

Usage

Formatting your code is as easy as running:

ocamlformat file.ml

To configure ocamlformat to your liking, create an .ocamlformat configuration file in your project with settings like:

profile = default
version = 0.28.1

Refer to our documentation or use ocamlformat --help for a full list of configuration options.

To make formatting your code even easier, use the dune build system:

dune fmt

Documentation

The full documentation for ocamlformat, including comprehensive user and API guides, can be found on OCaml.org.

Contributing

Contributing Guide

We wholeheartedly welcome contributors! To start, please read our Contributing Guide to familiarize yourself with our development process, including how to propose and how to start hacking on ocamlformat.

Hacking Guide

In addition to the Contributing Guide, we provide a Hacking Guide for ocamlformat developers. It contains in-depth explanation of development processes, such as running tests, releasing ocamlformat, etc.

Code of Conduct

In order to foster a welcoming and respectful community, ocamlformat has adopted the OCaml Code of Conduct.

Roadmap

Interested in the future of ocamlformat? Take a look at our Roadmap to understand our vision and planned advancements for ocamlformat.

Discussions

For conversations on ongoing development, be sure to visit the ocamlformat section of the OCaml Discuss forum.

License

ocamlformat is distributed under the terms of the MIT License. See the LICENSE file for complete details.

Acknowledgments

We gratefully acknowledge the individuals and organizations that have significantly contributed to ocamlformat.

ocamlformat owes its existance to its initial author, Josh Berdine. We also want to express our appreciation to Hugo Heuzard, Guillaume Petiot, and Jules Aguillon. Their significant contributions have been instrumental to the advancement of ocamlformat.

Moreover, our gratitude extends to Facebook, who fostered the inception of ocamlformat as part of their work on the ReasonML project. Jane Street and Tarides have also provided financial support and contributed to the ongoing development of the project.

Dependencies (5)

  1. re >= "1.10.3"
  2. ocamlformat-lib = version
  3. dune >= "2.8"
  4. csexp >= "1.4.0"
  5. ocaml >= "4.08"

Dev Dependencies (3)

  1. odoc with-doc
  2. ocamlformat-rpc-lib with-test & = version
  3. cmdliner with-test = "false" & >= "1.1.0" | with-test & >= "1.2.0"

Used by (94)

  1. ask
  2. ask-integrator
  3. autofonce
  4. autofonce_config
  5. autofonce_core
  6. autofonce_lib
  7. autofonce_m4
  8. autofonce_misc
  9. autofonce_patch
  10. autofonce_share
  11. awsm-codegen
  12. bastet < "2.0.0"
  13. bitpack_serializer
  14. brisk-reconciler
  15. CamelCase
  16. canary >= "0.0.4"
  17. catala >= "1.1.0"
  18. catala-lsp >= "1.1.1"
  19. claudius
  20. coap
  21. coap-core
  22. coap-server-lwt
  23. diff
  24. diskuvbox < "0.2.0"
  25. dream-inertia
  26. drom
  27. drom_lib
  28. drom_toml
  29. dump_ocamlformat
  30. dune_deps_extra
  31. ez_cmdliner >= "0.2.0"
  32. ez_config >= "0.2.0"
  33. ez_file >= "0.2.0"
  34. ez_hash < "0.5.3"
  35. ez_opam_file
  36. ez_search
  37. ez_subst
  38. fromager
  39. giflib
  40. guardian < "0.1.0"
  41. header-check
  42. html_of_jsx >= "0.0.6"
  43. js_of_ocaml-webgpu >= "0.2"
  44. letters >= "0.2.0" & != "0.3.1"
  45. melange-fest
  46. melange-fetch >= "0.2.0"
  47. melange-json >= "1.2.0"
  48. melange-radix-icons >= "0.1.0"
  49. mlx
  50. module-graph
  51. mqtt
  52. noCanren >= "0.3.0~alpha1"
  53. ocaml-lsp-server < "1.9.0" | >= "1.25.0"
  54. ocamlmerlin-mlx >= "0.11"
  55. ocp-search
  56. ocplib_stuff >= "0.3.0"
  57. oktree
  58. opam-bin >= "0.9.5"
  59. opam_bin_lib >= "0.9.5"
  60. owi >= "0.2"
  61. passage >= "0.3.2"
  62. polars
  63. polars_async
  64. ppx_deriving_jsonschema
  65. prelude >= "0.4"
  66. primavera
  67. psmt2-frontend >= "0.3.0"
  68. query-json
  69. quickjs >= "0.2.0"
  70. quickterface
  71. raylib >= "1.6.0"
  72. rea < "0.2.0"
  73. react-rules-of-hooks-ppx
  74. reason-react-ppx >= "0.17.0"
  75. red-black-tree
  76. scope
  77. server-reason-react >= "0.4.1"
  78. signal
  79. sihl < "0.1.0"
  80. smtml >= "0.10.0"
  81. solidity-alcotest
  82. solidity-common
  83. solidity-parser
  84. solidity-test
  85. solidity-typechecker
  86. spectrum >= "0.7.0"
  87. sqids
  88. styled-ppx
  89. symex
  90. synchronizer
  91. tabr
  92. virtfs
  93. yocaml >= "2.0.0"
  94. zanuda < "1.1.0"

Conflicts

None