package ocamlformat

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

Install

Dune Dependency

github.com Readme Changelog MIT; LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (34)

Authors

  1. J
    Josh Berdine <jjb@fb.com>

Maintainers

  1. O
    OCamlFormat Team <ocamlformat-dev@lists.ocaml.org>

Sources

ocamlformat-0.26.0.tbz
sha256=031494ab770cef10a8f6aa1cbeb5660e46c3aa6c0cd457b110fec859a75e877d
sha512=35c0131f04c2c8ceb94f0f400e4b56690405ddebb482aec0c9962163001d9fd5b593455df08b508394949f2740ba28f1714dff9e1f17b618bdec62fd26fae281

Description

OCamlFormat is a tool to automatically format OCaml code in a uniform style.

Published: 20 Jul 2023

README

README.md

🎨 ocamlformat

ocamlformat is a tool for formatting OCaml code. It automatically adjusts the layout of your code to follow the recommended style guidelines, making it easier to read and understand.

🚀 Installation

To use ocamlformat, you will need to have OCaml and opam (the OCaml package manager) installed on your system.

Once you have these dependencies, installation is a breeze! Just run the following command:

opam install ocamlformat

💻 Usage

Formatting your code with ocamlformat is super simple! Just run the following command:

ocamlformat file.ml

You can also specify a configuration file to customize the formatting behavior of ocamlformat. To set up your project to use the default profile and the ocamlformat version you installed let's create a configuration file named .ocamlformat containing:

profile = default
version = 0.26.0

For more information on configuration options, check out the documentation or run ocamlformat --help.

The most convenient way to format your code is through the dune build system. Just run the following command:

dune fmt

🤝 Contributing

We welcome contributions to ocamlformat! If you find a bug or want to suggest a feature, please open an issue on the GitHub repository. If you want to contribute code, please follow the contributing guidelines and open a pull request.

📜 License

ocamlformat is released under the MIT License.

Dependencies (4)

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

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

  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. catala >= "0.9.0"
  15. diff
  16. diskuvbox < "0.1.2"
  17. drom
  18. drom_lib
  19. drom_toml
  20. dump_ocamlformat
  21. ez_cmdliner >= "0.2.0"
  22. ez_config >= "0.2.0"
  23. ez_file >= "0.2.0"
  24. ez_hash < "0.5.3"
  25. ez_opam_file
  26. ez_search
  27. ez_subst
  28. fromager
  29. guardian < "0.1.0"
  30. header-check
  31. js_of_ocaml-webgpu >= "0.2"
  32. letters >= "0.2.0" & != "0.3.1"
  33. melange-fest
  34. melange-radix-icons >= "0.1.0"
  35. module-graph
  36. noCanren >= "0.3.0~alpha1"
  37. OCanren-ppx = "0.3.0~alpha1"
  38. ocaml-lsp-server < "1.8.0"
  39. ocp-search
  40. ocplib_stuff >= "0.3.0"
  41. opam-bin >= "0.9.5"
  42. opam_bin_lib >= "0.9.5"
  43. owi >= "0.2"
  44. polars
  45. polars_async
  46. psmt2-frontend >= "0.3.0"
  47. rea < "0.2.0"
  48. scaml >= "1.2.0"
  49. sihl < "0.1.0"
  50. solidity-alcotest
  51. solidity-common
  52. solidity-parser
  53. solidity-test
  54. solidity-typechecker
  55. styled-ppx
  56. tabr
  57. zanuda

Conflicts

None