package alcotest

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package alcotest

alcotest
- CHANGES
- LICENSE
- README
- Library alcotest
  - Alcotest
    
    TESTABLE
    
    Source_code_position
    
    Unix
    
    Core
    
    Make
    
    Cli
    
    Make
- Library alcotest.engine
  - Alcotest_engine
    
    Test
    
    TESTABLE
    
    Source_code_position
    
    Core
    
    S
    
    MAKER
    
    Make
    
    Cli
    
    S
    
    MAKER
    
    Make
    
    Monad
    
    S
    
    EXTENDED
    
    Infix
    
    List
    
    Identity
    
    Extend
    
    Infix
    
    List
    
    Platform
    
    S
    
    MAKER
    
    Private
    
    Utils
    
    String
    
    Sub
    
    Ascii
    
    Set
    
    Map
    
    List
    
    Result
    
    Option
    
    Pp
    
    Make
- Sources
  - alcotest
    
    alcotest.ml
    
    alcotest__.ml
    
    terminal.ml
  - alcotest.engine
    
    alcotest_engine.ml
    
    alcotest_engine__.ml
    
    cli.ml
    
    config.ml
    
    core.ml
    
    core_intf.ml
    
    model.ml
    
    monad.ml
    
    monad_intf.ml
    
    platform.ml
    
    pp.ml
    
    pp_intf.ml
    
    test.ml
    
    utils.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Pp.Make`Source

Parameters

module X : sig ... end

Signature

Source

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

Source

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

Source

val event_line : 
  margins:int ->
  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

Source

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

Source

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

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

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

Sourceval 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.

Sourceval horizontal_rule : _ Fmt.t

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

Sourceval 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

Sourceval user_error : string -> _

Raise a user error, then fail.

package alcotest

Module Pp.MakeSource

Parameters

Signature

Module `Pp.Make`Source