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 (86)

  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. catala >= "1.1.0"
  17. claudius
  18. coap
  19. coap-core
  20. coap-server-lwt
  21. diff
  22. diskuvbox < "0.1.2"
  23. dream-inertia
  24. drom
  25. drom_lib
  26. drom_toml
  27. dump_ocamlformat
  28. dune_deps_extra
  29. ez_cmdliner >= "0.2.0"
  30. ez_config >= "0.2.0"
  31. ez_file >= "0.2.0"
  32. ez_hash < "0.5.3"
  33. ez_opam_file
  34. ez_search
  35. ez_subst
  36. fromager
  37. giflib
  38. guardian < "0.1.0"
  39. header-check
  40. html_of_jsx >= "0.0.6"
  41. js_of_ocaml-webgpu >= "0.2"
  42. letters >= "0.2.0" & != "0.3.1"
  43. melange-fest
  44. melange-fetch >= "0.2.0"
  45. melange-json >= "1.2.0"
  46. melange-radix-icons >= "0.1.0"
  47. mlx
  48. module-graph
  49. mqtt
  50. noCanren >= "0.3.0~alpha1"
  51. ocaml-lsp-server < "1.9.0" | >= "1.25.0"
  52. ocamlmerlin-mlx >= "0.11"
  53. ocp-search
  54. ocplib_stuff >= "0.3.0"
  55. opam-bin >= "0.9.5"
  56. opam_bin_lib >= "0.9.5"
  57. owi >= "0.2"
  58. passage >= "0.3.2"
  59. polars
  60. polars_async
  61. ppx_deriving_jsonschema
  62. prelude >= "0.4"
  63. primavera
  64. psmt2-frontend >= "0.3.0"
  65. query-json
  66. quickjs >= "0.2.0"
  67. raylib >= "1.6.0"
  68. rea < "0.2.0"
  69. reason-react-ppx >= "0.17.0"
  70. red-black-tree
  71. scope
  72. server-reason-react >= "0.4.1"
  73. signal
  74. sihl < "0.1.0"
  75. smtml >= "0.10.0"
  76. solidity-alcotest
  77. solidity-common
  78. solidity-parser
  79. solidity-test
  80. solidity-typechecker
  81. sqids
  82. styled-ppx
  83. synchronizer
  84. tabr
  85. yocaml >= "2.0.0"
  86. zanuda < "1.1.0"

Conflicts

None