package ocamlformat-lib

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

Install

Dune Dependency

Authors

Maintainers

Sources

ocamlformat-0.25.1.tbz
sha256=dc8f2a330ca3930b36cacb2623bb360ed8bdf6e4a8acd293dbd9e2241a6fd33d
sha512=b28f545425fb5375447c90022d065dc7fd51ed2f66d8c1f65a71a6ad2465d039a8686e8f18249e5ad3a2362fee6149c855ef30eb45fb9d06d743a53d26b3e26f

Description

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

Published: 06 Mar 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.25.1

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

  1. camlp-streams
  2. result
  3. astring
  4. csexp >= "1.4.0"
  5. uutf >= "1.0.1"
  6. uuseg >= "10.0.0"
  7. stdio
  8. ocp-indent >= "1.8.0"
  9. ocaml-version >= "3.5.0"
  10. menhirSdk >= "20201216"
  11. menhirLib >= "20201216"
  12. menhir >= "20201216"
  13. fpath
  14. fix
  15. either
  16. dune-build-info
  17. dune >= "2.8"
  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 & >= "1.3.0"

Used by (1)

  1. ocamlformat = "0.25.1"

Conflicts

None

OCaml

Innovation. Community. Security.