package easy-format
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=eafccae911c26ca23e4ddacee3eaa54654d20f973b8680f84b708cef43adc416
sha512=611b3124f6a0ec6406b7bda8018a94c9c4a9da9d22495a5c34a6312bf7f0f0607a9529b276f7039ce3f3b15a955dac413d6d1229a55d5ac291302a3ddd5807e5
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:".
Published: 29 Apr 2022
README
README.md
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
maketojbuilderfor both build/install and development.We're looking for an official maintainer for the library and its documentation.