package ocamlformat-rpc-lib

Build not checked
  1. Overview
  2. Docs
Auto-formatter for OCaml code (RPC mode)

Install

dune-project
 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. This package defines a RPC interface to OCamlFormat

Added to opam-repository:

README

Build Status

🎨 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 (3)

  1. csexp >= "1.4.0"
  2. ocaml >= "4.08"
  3. dune >= "2.8"

Dev Dependencies (1)

  1. odoc with-doc

Optional Dependencies

None

Used by (6)

  1. menhir-lsp >= "0.3.0" & < "0.5.0"
  2. menhirformat
  3. ocaml-lsp-server >= "1.10.5"
  4. ocamlformat = "0.25.1"
  5. ocamlformat-lib < "0.26.0"
  6. ocamlformat-rpc < "0.19.0"

Conflicts

None

Build status

Results of building ocamlformat-rpc-lib with each compiler on check.ci.ocaml.org, run of against opam-repository 7cdc698. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to β€œAuthorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

This version is not in the latest run; the versions below are.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.29.0 good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure