package grace

  1. Overview
  2. Docs
A fancy diagnostics library that allows your compilers to exit with grace

Install 

dune-project
 Dependency

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

Authors

  1. A
    Alistair O'Brien

Maintainers

  1. A
    alistair.obrien@trili.tech

Sources

grace-0.2.0.tbz
sha256=821df54882c9253eac69f47bcf3a71ffdc61c77fdae42587c32aada5b56cfeae
sha512=007afa83251da3ddecd874e120ea89dce0253c387a64a5fece69069d3486ec5eb6c82d6bf0febaf23dd322bd9eaadc2f7882e33f05a2e1fa18a41294e7dc3ba1

doc/grace/Grace/Diagnostic/index.html

Module Grace.DiagnosticSource

Diagnostic types and constructors.

Sourcetype ('a, 'b) format = ('a, Format.formatter, unit, 'b) Core.format4

The type of format strings associated with messages.

  1. The input is always a Format.formatter
  2. The result of %a and %t printing functions is unit.
Sourcemodule Severity : sig ... end

The type of severity.

Sourcemodule Priority : sig ... end

The type of priority. These are used to style the primary and secondary causes of a diagnostic.

Sourcemodule Message : sig ... end
Sourcemodule Label : sig ... end
Sourcetype 'code t = {
  1. severity : Severity.t;
    (*

    The overall severity of the diagnostic.

    *)
  2. message : Message.t;
    (*

    The main message associated with the diagnostic. These should not include control characters (such as the newline character \n). To support compact rendering, the message should be specific enough to make sense on its own, without the additional context provided by labels and notes.

    *)
  3. code : 'code option;
    (*

    The (optional) error code assicoated with the diagnostic

    *)
  4. labels : Label.t list;
    (*

    Labels that describe the cause of the diagnostic. The order of the labels has no meaning, Grace's rendering engine will determine the order they appear.

    *)
  5. notes : Message.t list;
    (*

    Notes that are associated with the primary cause of the diagnostic.

    *)
}

The type of diagnostics.

include Sexplib0.Sexpable.S1 with type 'code t := 'code t
Sourceval t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a t
Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
Sourceval create : ?notes:Message.t list -> ?labels:Label.t list -> ?code:'code -> Severity.t -> Message.t -> 'code t

create severity message constructs a diagnostic with the message.

  • parameter notes

    additional notes associated with the primary cause of the diagnostic.

  • parameter labels

    used to describe the cause of the diagnostic.

  • parameter code

    the error code of the diagnostic.

Sourceval createf : ?notes:Message.t list -> ?labels:Label.t list -> ?code:'code -> Severity.t -> ('a, 'code t) format -> 'a

createf severity fmt ... formats a message and constructs a diagnostic.

  • parameter notes

    additional notes associated with the primary cause of the diagnostic.

  • parameter labels

    used to describe the cause of the diagnostic.

  • parameter code

    the error code of the diagnostic.

Sourceval kcreatef : ?notes:Message.t list -> ?labels:Label.t list -> ?code:'code -> ('code t -> 'b) -> Severity.t -> ('a, 'b) format -> 'a

kcreatef kont severity fmt ... is equivalent to kont (createf severity fmt ...).

  • parameter notes

    additional notes associated with the primary cause of the diagnostic.

  • parameter labels

    used to describe the cause of the diagnostic.