package dune-private-libs

You can search for identifiers within the package.

in-package search v0.2.0

Private libraries of Dune

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (5)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street Group, LLC

Sources

dune-2.5.1.tbz

sha256=8f77d3a87f208e0d7cccaa1c48c4bb1bb87d62d07c3f25e9b8ba298e028ce52b

sha512=f209f12ced10c1abf8782bdb0143f4cec77795f7174d2cc75130afb1e01550b01f2f77b9e3ec4888efdad83d2f9878d179b39126f824f4e522f3ef4da34bf27e

doc/dune-private-libs.stdune/Stdune/User_message/index.html

Module `Stdune.User_message`

A message for the user

User messages are styled document that can be printed to the console or in the log file.

module Style : sig ... 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).

type t = {

loc : Stdune__.Loc0.t option;
paragraphs : Style.t Pp.t list;
hints : Style.t Pp.t list;

}

A user message.contents composed of an optional file location and a list of paragraphs.

The various paragraphs will be printed one after the other and will all start at the beginning of a line. They are all wrapped inside a Pp.box.

When hints are provided, they are printed as last paragraphs and prefixed with "Hint:". Hints should give indication to the user for how to fix the issue.

val pp : t -> Style.t Pp.t

module Print_config : sig ... end

val make : 
  ?loc:Stdune__.Loc0.t ->
  ?prefix:Style.t Pp.t ->
  ?hints:Style.t Pp.t list ->
  Style.t Pp.t list ->
  t

Construct a user message from a list of paragraphs.

The first paragraph is prefixed with prefix inside the box. prefix should not end with a space as a space is automatically inserted by make if necessary.

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

Print to stdout (not thread safe)

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

Print to stderr (not thread safe)

val did_you_mean : string -> candidates:string list -> Style.t Pp.t list

Produces a "Did you mean ...?" hint

val to_string : t -> string

Produces a plain text representation of the error message, without the "Error: " prefix.