package ocamlformat

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

Install 

dune-project
 Dependency

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

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.27.0.tbz
sha256=ddbf484c076d08f99400ee84b790ec231f5c8fcbd5d3324a6400d5388e846d15
sha512=4d2a8965a7b7ad45f8f4e76c01cf38bfa68462b07dfa7bdb2db23bd3e3017b214e6780f036679fa8595dde4167a01d957e3af8837274320449014e306773f917

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: 03 Dec 2024

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.27.0

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" & < "5.4"

Dev Dependencies (4)

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

  1. ambient-context >= "0.2"
  2. ask
  3. ask-integrator
  4. autofonce
  5. autofonce_config
  6. autofonce_core
  7. autofonce_lib
  8. autofonce_m4
  9. autofonce_misc
  10. autofonce_patch
  11. autofonce_share
  12. awsm-codegen
  13. bastet < "2.0.0"
  14. bitpack_serializer
  15. brisk-reconciler
  16. CamelCase
  17. canary >= "0.0.4"
  18. claudius
  19. coap
  20. coap-core
  21. coap-server-lwt
  22. diff
  23. diskuvbox < "0.2.0"
  24. dream-inertia
  25. drom
  26. drom_lib
  27. drom_toml
  28. dump_ocamlformat
  29. dune-release >= "2.2.0"
  30. dune_deps_extra
  31. ephemeral
  32. ez_cmdliner >= "0.2.0"
  33. ez_config >= "0.2.0"
  34. ez_file >= "0.2.0" & < "0.5.0"
  35. ez_hash < "0.5.3"
  36. ez_opam_file
  37. ez_search
  38. ez_subst
  39. flux
  40. fluxt
  41. fromager
  42. giflib
  43. guardian != "0.1.0"
  44. header-check
  45. html_of_jsx >= "0.0.6"
  46. js_of_ocaml-webgpu >= "0.2"
  47. junit >= "2.2.0"
  48. junit_alcotest >= "2.2.0"
  49. junit_ounit >= "2.2.0"
  50. letters >= "0.2.0" & != "0.3.1"
  51. lunar
  52. melange-fest
  53. melange-fetch >= "0.2.0"
  54. melange-json >= "1.2.0"
  55. melange-radix-icons >= "0.1.0"
  56. melange-str
  57. merge-fmt >= "0.4"
  58. miou
  59. mlx
  60. module-graph
  61. mqtt
  62. nel
  63. noCanren
  64. ocaml-lsp-server < "1.9.0" | >= "1.21.0-4.14" & < "1.25.0"
  65. ocamlmerlin-mlx >= "0.11"
  66. ocp-search
  67. ocplib_stuff >= "0.3.0"
  68. oktree
  69. opam-bin >= "0.9.5"
  70. opam_bin_lib >= "0.9.5"
  71. opentelemetry >= "0.12"
  72. owi >= "0.2"
  73. parseff < "0.2.0"
  74. pgn_to_tex
  75. pidgin
  76. polars
  77. polars_async
  78. ppx_deriving_jsonschema < "0.0.7"
  79. prelude >= "0.4"
  80. primavera
  81. psmt2-frontend >= "0.3.0"
  82. query-json
  83. quickjs >= "0.2.0"
  84. rea < "0.2.0"
  85. react-rules-of-hooks-ppx
  86. reason-react = "0.16.0"
  87. reason-react-ppx = "0.16.0"
  88. red-black-tree
  89. runtime_events_tools = "0.5.3"
  90. scope
  91. server-reason-react = "0.4.0"
  92. signal
  93. sihl < "0.1.0"
  94. slipshow >= "0.1.1" & < "0.11.0"
  95. slugline
  96. smtml >= "0.10.0" & < "0.24.0"
  97. solidity-alcotest
  98. solidity-common
  99. solidity-parser
  100. solidity-test
  101. solidity-typechecker
  102. spectrum >= "0.7.0"
  103. sqids
  104. styled-ppx
  105. synchronizer
  106. tabr
  107. tezt >= "4.3.0"
  108. virtfs
  109. yocaml >= "2.0.0"
  110. zanuda != "1.1.0"

Conflicts

None