package easy-format

All checked builds pass
  1. Overview
  2. Docs
High-level and functional interface to the Format module of the OCaml standard library

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (9)

Authors

  1. M
    Martin Jambon

Maintainers

  1. M
    martin@mjambon.com
  2. R
    rudi.grinberg@gmail.com

Sources

easy-format-1.3.4.tbz
sha256=1dbf051e9f68574dde6e2e254a66b9c524ca425e80b36e99af96ed964ab610c3
sha512=90264864dde4cbf51f60fb5c21cf033e11bdeb662e76b62ce27b496c298ca9102174885ed7a6d29a6b8e43089e27d5bb5be247f88d9739c15cfd8470fec29d33

Description

This module offers a high-level and functional interface to the Format module of the OCaml standard library. It is a pretty-printing facility, i.e. it takes as input some code represented as a tree and formats this code into the most visually satisfying result, breaking and indenting lines of code where appropriate.

Input data must be first modelled and converted into a tree using 3 kinds of nodes:

  • atoms
  • lists
  • labelled nodes

Atoms represent any text that is guaranteed to be printed as-is. Lists can model any sequence of items such as arrays of data or lists of definitions that are labelled with something like "int main", "let x =" or "x:".

Added to opam-repository:

README

This project is unmaintained. Pull requests won't be reviewed. If you would like to contribute, please request a transfer to ocaml-community.

Easy-format: indentation made easy

Documentation

The documentation is at https://mjambon.github.io/mjambon2016/easy-format.html

Installation

Installation requires dune (formerly known as jbuilder) and ocamlfind.

$ make
$ make install

Uninstallation

$ make uninstall

Examples

Some examples can be run with make test before installing.

More examples that require Easy-format to be installed and possibly dependencies on other packages can be found in the examples/ subdirectory.

TODO

  • Port documentation from old website to a better place, possibly https://readthedocs.org/.
  • Switch from pure make to jbuilder for both build/install and development.
  • We're looking for an official maintainer for the library and its documentation.

Dependencies (2)

  1. ocaml >= "4.08"
  2. dune >= "3.2" & >= "1.10"

Dev Dependencies (1)

  1. odoc with-doc

Optional Dependencies

None

Conflicts

None

Build status

Results of building easy-format with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. 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.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
1.3.4 (this version) 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