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.24.1.tbz
sha256=023425e9818f80ea50537b2371a4a766c149a9957d05807e88a004d2d5f441ce
sha512=753b6128be68042895202f99959b360ce954db6f82b19b83b4bb346761a8e9cfdfc2b4b25e2070e60601b555562e78f9ebb02760ff127464e0b66cedbddca304

Description

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

Published: 18 Jul 2022

README

README.md

OCamlFormat

Hello, new user! Welcome! :wave:

If you are here, you are probably interested in using a formatting tool for your code base, so that you do not have to worry about formatting it by hand, and to speed up code review by focusing on the important parts.

OCamlFormat is probably what you are after!

OCamlFormat works by parsing then outputting again the same OCaml source file in a consistent style.

Read the documentation to learn more about OCamlFormat!

Getting started

Installation

OCamlFormat can be installed with opam:

opam install ocamlformat

Alternatively, see ocamlformat.opam for manual build instructions.

Formatting code!

Setting up your project to use the default profile and the OCamlFormat version you installed (hopefully the last one) in this .ocamlformat file is considered good practice:

profile = default
version = 0.24.1

To manually invoke OCamlformat the general command is:

ocamlformat [OPTION]... [SRC]...

See ocamlformat --help or man ocamlformat for the detail about options.

You can also view it online.

The most common usecase involves using the dune build system, once your project is correctly setup (see Dune's manual) you can reformat your project using:

dune build @fmt

Community

See CONTRIBUTING for how to help out.

License

OCamlFormat is MIT-licensed.

Dependencies (19)

  1. csexp >= "1.4.0"
  2. uutf >= "1.0.1"
  3. uuseg >= "10.0.0"
  4. stdio
  5. re >= "1.7.2"
  6. odoc-parser >= "2.0.0" & < "2.3.0"
  7. ocp-indent
  8. ocaml-version >= "3.3.0" & < "3.6.0"
  9. menhirSdk >= "20201216"
  10. menhirLib >= "20201216"
  11. menhir >= "20201216"
  12. fpath
  13. fix
  14. either
  15. dune-build-info
  16. dune >= "2.8"
  17. cmdliner >= "1.1.0"
  18. base >= "v0.12.0"
  19. ocaml >= "4.08" & < "5.2"

Dev Dependencies (3)

  1. odoc with-doc
  2. ocamlformat-rpc-lib with-test & = version
  3. alcotest with-test

Used by (61)

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

Conflicts

None