package pplumbing

  1. Overview
  2. Docs
Utility libraries to use with [pp]

Install 

dune-project
 Dependency

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

Authors

  1. M
    Mathieu Barbin

Maintainers

  1. M
    Mathieu Barbin <opensource@mbarbin.org>

Sources

pplumbing-0.0.16.tbz
sha256=8ae0c09fec9088bc7af60582717a9e9d8bb7703e2fbf0a1b90b82e5962ed7039
sha512=ddd1d5a3d47e7c5ebfb2898f0810156dfca4e10df500ce8f39238cfe02b51fd12ea6d7796914bd02e9ad8e615da1ed7067c9f712bdbbfb884cab08d57bba3564

doc/pplumbing.pp-tty/Pp_tty/index.html

Module Pp_ttySource

include module type of struct include Pplumbing_pp_tty.Pp_tty end

Symbolic styles that can be used inside messages. These styles are later converted to actual concrete styles depending on the output device. For instance, when printed to the terminal they are converted to ansi terminal styles (Ansi_color.Style.t list values).

Styled document that can be printed to the console or in the log file.

Sourceval print : ?config:Print_config.t -> t -> unit

Print to stdout (not thread safe)

Sourceval prerr : ?config:Print_config.t -> t -> unit

Print to stderr (not thread safe)

Sourceval tag : Style.t -> t -> t

An alias for Pp.tag dedicated to the expected Style.t type. Using this function allows to write the Style.t constructor without qualifying them, which may be more ergonomic.

Basic helpers

Sourceval parens : 'a Pp.t -> 'a Pp.t
Sourceval brackets : 'a Pp.t -> 'a Pp.t
Sourceval braces : 'a Pp.t -> 'a Pp.t
Sourceval simple_quotes : 'a Pp.t -> 'a Pp.t
Sourceval double_quotes : 'a Pp.t -> 'a Pp.t

Opinionated helpers

Sourceval loc : Loc.t -> t

A pretty printer for code locations. The uses a common syntax that is usually configured by editors to allow jumping to locations. If the file listed by the location is available, this will render a small quotation for the location, such as in:

  File "my-file", line 42, character 6-11:
  42 | Hello World
             ^^^^^
Sourceval id : (module To_string with type t = 'a) -> 'a -> t

A modular-explicit helper that uses brackets and the Id symbolic style to format a stringable identifier.

Sourceval kwd : (module To_string with type t = 'a) -> 'a -> t

A modular-explicit helper that uses brackets and the Kwd symbolic style to format a stringable keyword.

Sourceval path : (module To_string with type t = 'a) -> 'a -> t

A modular-explicit helper that uses double_quotes and the Bold ansi style to format a stringable path.

Sourceval ansi : (module To_string with type t = 'a) -> 'a -> Ansi_color.Style.t list -> t

A modular-explicit helper that uses the ansi style to format a stringable variable.