package ocamlformat

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

Install 

dune-project
 Dependency

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

Authors

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

Maintainers

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

Sources

ocamlformat-0.23.0.tbz
sha256=9bd3e3cfb0da1b2f75eccd468f27ea1b92e6e677bb6129491764957031dedfed
sha512=6da6f56cb4c605a87020dd7511c99b0114d844d7e26c727ffef521390265bc8f1e8a86e0e4ac916d27df56734941957468aa3462ae01991b522e75c42b392597

Description

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

Published: 07 Jul 2022

README

Build Status

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

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 >= "1.0.0" & < "2.0.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" & < "2.0"
  18. base >= "v0.12.0" & < "v0.17.0"
  19. ocaml >= "4.08" & < "5.2"

Dev Dependencies (4)

  1. odoc with-doc
  2. ocamlformat-rpc-lib with-test & post & = version
  3. dune with-test & < "3.0"
  4. alcotest with-test

Used by (80)

  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. brisk-reconciler
  15. CamelCase
  16. canary >= "0.0.4"
  17. diff
  18. diskuvbox < "0.2.0"
  19. dream-inertia
  20. drom
  21. drom_lib
  22. drom_toml
  23. dump_ocamlformat
  24. dune_deps_extra
  25. ephemeral
  26. ez_cmdliner >= "0.2.0"
  27. ez_config >= "0.2.0"
  28. ez_file >= "0.2.0"
  29. ez_hash < "0.5.3"
  30. ez_opam_file
  31. ez_search
  32. ez_subst
  33. fromager
  34. guardian >= "0.4.0"
  35. header-check
  36. js_of_ocaml-webgpu >= "0.2"
  37. letters >= "0.2.0" & != "0.3.1"
  38. lunar
  39. melange-fest
  40. melange-fetch >= "0.2.0"
  41. melange-json >= "1.2.0" & < "2.0.0"
  42. melange-radix-icons >= "0.1.0"
  43. melange-str
  44. mlx
  45. module-graph
  46. noCanren >= "0.3.0~alpha1"
  47. ocaml-lsp-server < "1.9.0"
  48. ocamlmerlin-mlx >= "0.11"
  49. ocp-search
  50. ocplib_stuff >= "0.3.0"
  51. oktree
  52. opam-bin >= "0.9.5"
  53. opam_bin_lib >= "0.9.5"
  54. owi >= "0.2"
  55. polars
  56. polars_async
  57. ppx_deriving_jsonschema
  58. prelude >= "0.4"
  59. primavera
  60. psmt2-frontend >= "0.3.0"
  61. pyml_bindgen >= "0.4.1"
  62. query-json
  63. quickjs >= "0.2.0"
  64. rea < "0.2.0"
  65. react-rules-of-hooks-ppx
  66. red-black-tree
  67. scope
  68. sihl < "0.1.0"
  69. smtml >= "0.10.0" & < "0.24.0"
  70. solidity-alcotest
  71. solidity-common
  72. solidity-parser
  73. solidity-test
  74. solidity-typechecker
  75. spectrum >= "0.7.0"
  76. styled-ppx
  77. synchronizer
  78. virtfs
  79. yocaml >= "2.0.0"
  80. zanuda < "1.1.0"

Conflicts

None