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.29.0.tbz
sha256=dac77f0a957ae782bb4b869b07b9803a872a34f8c1eae8901b42d21b623c9db5
sha512=b4ae6fda3c28e91dc12411b577df7b216e9b1afe5887bcb9e89c158e1313dc92183c29ffb256f47f5c9384af3ac8c505ec76849b26ae950b82c9b4c21a460819

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.

Added to opam-repository:

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.29.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"

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. 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. awskit >= "0.2.0"
  12. awsm-codegen
  13. bastet < "2.0.0"
  14. bitpack_serializer
  15. brisk-reconciler
  16. CamelCase
  17. canary >= "0.0.4"
  18. cdp
  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. 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. fromager
  40. giflib
  41. guardian != "0.1.0"
  42. header-check
  43. hedgehog
  44. hegel
  45. highway
  46. hpke
  47. html_of_jsx >= "0.0.6"
  48. js_of_ocaml-webgpu >= "0.2"
  49. letters >= "0.2.0" & != "0.3.1"
  50. lunar
  51. melange-fest
  52. melange-fetch >= "0.2.0"
  53. melange-json >= "1.2.0"
  54. melange-radix-icons >= "0.1.0"
  55. melange-str
  56. mlx
  57. module-graph
  58. mqtt
  59. nel
  60. noCanren
  61. object
  62. ocaml-lsp-server < "1.9.0" | >= "1.28.0-506~preview"
  63. ocamlmerlin-mlx >= "0.11"
  64. ochre
  65. ocp-search
  66. ocplib_stuff >= "0.3.0"
  67. oktree
  68. opam-bin >= "0.9.5"
  69. opam_bin_lib >= "0.9.5"
  70. owi >= "0.2"
  71. parseff
  72. pgn_to_tex
  73. pidgin
  74. polars
  75. polars_async
  76. ppx_deriving_jsonschema
  77. ppx_deriving_melange
  78. ppx_mixins
  79. prelude >= "0.4"
  80. primavera
  81. psmt2-frontend >= "0.3.0"
  82. query-json
  83. quickjs >= "0.2.0" & < "0.5.0"
  84. raylib >= "2.0.0"
  85. rea < "0.2.0"
  86. react-rules-of-hooks-ppx
  87. red-black-tree
  88. scope
  89. signal
  90. sihl < "0.1.0"
  91. slugline
  92. smtml >= "0.10.0"
  93. solidity-alcotest
  94. solidity-common
  95. solidity-parser
  96. solidity-test
  97. solidity-typechecker
  98. soteria
  99. spectrum >= "0.7.0"
  100. sqids
  101. styled-ppx
  102. symex
  103. synchronizer
  104. tabr
  105. virtfs
  106. yamlx >= "0.4.0"
  107. yocaml >= "2.0.0"
  108. zanuda < "1.1.0"

Conflicts

None