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

Authors

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

Maintainers

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

Sources

ocamlformat-0.21.0.tbz
sha256=2a1817f6bc581ff0cce9f0aa9687b897b02726e2ab75749ee98d57637057332d
sha512=db47f843bfc5a438d43f7c482cde86bd13f05a6825e2a0afa80614b651a88ae8b3805cca45da6bcf9189e741e0c79d38652b0bc47efe636c1502a66676dcb28e

Description

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

Published: 28 Feb 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.

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.21.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 (18)

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

Dev Dependencies (5)

  1. odoc with-doc
  2. ocp-indent with-test & < "1.9.0"
  3. dune with-test & < "3.0"
  4. cmdliner with-test & < "1.2.0"
  5. alcotest with-test

Used by (83)

  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. jsoo-react
  38. letters >= "0.2.0" & != "0.3.1"
  39. lunar
  40. melange-fest
  41. melange-fetch >= "0.2.0"
  42. melange-json >= "1.2.0" & < "2.0.0"
  43. melange-radix-icons >= "0.1.0"
  44. melange-str
  45. mlx
  46. module-graph
  47. noCanren
  48. OCanren
  49. ocaml-lsp-server < "1.9.0"
  50. ocamlformat-rpc = "0.21.0"
  51. ocamlmerlin-mlx >= "0.11"
  52. ocp-search
  53. ocplib_stuff >= "0.3.0"
  54. oktree
  55. opam-bin >= "0.9.5"
  56. opam_bin_lib >= "0.9.5"
  57. owi >= "0.2"
  58. polars
  59. polars_async
  60. ppx_deriving_jsonschema < "0.0.7"
  61. prelude >= "0.4"
  62. primavera
  63. psmt2-frontend >= "0.3.0"
  64. query-json
  65. quickjs >= "0.2.0"
  66. rea < "0.2.0"
  67. react-rules-of-hooks-ppx
  68. red-black-tree
  69. scope
  70. sihl < "0.1.0"
  71. slugline
  72. smtml >= "0.10.0" & < "0.24.0"
  73. solidity-alcotest
  74. solidity-common
  75. solidity-parser
  76. solidity-test
  77. solidity-typechecker
  78. spectrum >= "0.7.0"
  79. styled-ppx
  80. synchronizer
  81. tezt >= "3.1.0" & < "4.1.0"
  82. virtfs
  83. yocaml >= "2.0.0"

Conflicts

None