package ocamlformat

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

Install 

dune-project
 Dependency

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

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.26.2.tbz
sha256=2e4f596bf7aa367a844fe83ba0f6b0bf14b2a65179ddc082363fe9793d0375c5
sha512=b03d57462e65b11aa9f78dd5c4548251e8d1c5a1c9662f7502bdb10472aeb9df33c1d407350767a5223fbff9c01d53de85bafacd0274b49abc4b43701b159bee

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: 23 Apr 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.26.2

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

  1. re >= "1.10.3"
  2. ocamlformat-lib = version
  3. dune >= "2.8"
  4. ocaml >= "4.08" & < "5.4"

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

  1. api-watch
  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. coap
  18. coap-core
  19. coap-server-lwt
  20. color >= "0.3.0"
  21. diff
  22. diskuvbox < "0.1.2"
  23. dream-inertia
  24. drom
  25. drom_lib
  26. drom_toml
  27. dump_ocamlformat
  28. dune-cargo-build
  29. dune_deps_extra
  30. ez_cmdliner >= "0.2.0"
  31. ez_config >= "0.2.0"
  32. ez_file >= "0.2.0"
  33. ez_hash < "0.5.3"
  34. ez_opam_file
  35. ez_search
  36. ez_subst
  37. fromager
  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-json >= "1.2.0" & < "2.0.0"
  45. melange-radix-icons >= "0.1.0"
  46. mlx
  47. module-graph
  48. mqtt
  49. noCanren >= "0.3.0~alpha1"
  50. ocaml-lsp-server < "1.9.0" | >= "1.18.0" & < "1.21.0-4.14"
  51. ocp-search
  52. ocplib_stuff >= "0.3.0"
  53. opam-bin >= "0.9.5"
  54. opam_bin_lib >= "0.9.5"
  55. owi >= "0.2"
  56. passage
  57. polars
  58. polars_async
  59. pp >= "2.0.0"
  60. ppx_deriving_jsonschema
  61. ppxlib >= "0.34.0"
  62. prelude >= "0.4"
  63. primavera
  64. psmt2-frontend >= "0.3.0"
  65. rea < "0.2.0"
  66. red-black-tree
  67. rust-staticlib-gen
  68. scope
  69. signal
  70. sihl < "0.1.0"
  71. slipshow = "0.0.33"
  72. smtml >= "0.10.0"
  73. solidity-alcotest
  74. solidity-common
  75. solidity-parser
  76. solidity-test
  77. solidity-typechecker
  78. spotify_ml
  79. sqids
  80. styled-ppx
  81. synchronizer
  82. tabr
  83. tezt >= "4.2.0"
  84. yocaml >= "2.0.0"
  85. zanuda < "2.0.0"

Conflicts

None