alcotest 1.2.3 · OCaml Package

val terminal_width : unit -> int

val info : 
  max_label:int ->
  doc_of_test_name:(Alcotest_engine__.Model.Test_name.t -> string) ->
  Alcotest_engine__.Model.Test_name.t Fmt.t

val tag : [ `Ok | `Fail | `Skip | `Todo | `Assert ] Fmt.t

type event = [

| `Result of Alcotest_engine__.Model.Test_name.t * [ `Ok | `Exn of Alcotest_engine__.Model.Test_name.t * string * unit Fmt.t | `Error of Alcotest_engine__.Model.Test_name.t * unit Fmt.t | `Skip | `Todo of string ]
| `Start of Alcotest_engine__.Model.Test_name.t

]

type result = {

success : int;
failures : int;
time : float;
errors : unit Fmt.t list;

}

val rresult_error : 
  [ `Ok
  | `Exn of Alcotest_engine__.Model.Test_name.t * string * unit Fmt.t
  | `Error of Alcotest_engine__.Model.Test_name.t * unit Fmt.t
  | `Skip
  | `Todo of string ]
    Fmt.t

val event_line : 
  max_label:int ->
  doc_of_test_name:(Alcotest_engine__.Model.Test_name.t -> string) ->
  [ `Result of
      Alcotest_engine__.Model.Test_name.t
      * [< Alcotest_engine__.Model.Run_result.t ]
  | `Start of Alcotest_engine__.Model.Test_name.t ]
    Fmt.t

val event : 
  isatty:bool ->
  compact:bool ->
  max_label:int ->
  doc_of_test_name:(Alcotest_engine__.Model.Test_name.t -> string) ->
  selector_on_failure:bool ->
  tests_so_far:int ->
  event Fmt.t

val suite_results : 
  verbose:bool ->
  show_errors:bool ->
  json:bool ->
  compact:bool ->
  log_dir:string ->
  result Fmt.t

val quoted : 'a Fmt.t -> 'a Fmt.t

Wraps a formatter with `GNU-style quotation marks'.

val with_surrounding_box : 'a Fmt.t -> 'a Fmt.t

Wraps a formatter with a Unicode box with width given by terminal_width. Uses box-drawing characters from code page 437.

val horizontal_rule : _ Fmt.t

Horizontal rule of length terminal_width. Uses box-drawing characters from code page 437.

val pp_plural : int Fmt.t

This is for adding an 's' to words that should be pluralized, e.g.

let n = List.length items in
Fmt.pr "Found %i item%a." n pp_plural n

val user_error : string -> _

Raise a user error, then fail.

package alcotest