mdx 2.0.0 · OCaml Package

Code blocks headers.

module Header : sig ... end

Code blocks.

type cram_value = {

language : [ `Bash | `Sh ];
non_det : Label.non_det option;

}

type ocaml_value = {

env : Ocaml_env.t;
(*
env is the name given to the environment where tests are run.
*)
non_det : Label.non_det option;
errors : Output.t list;

}

type toplevel_value = {

env : Ocaml_env.t;
(*
env is the name given to the environment where tests are run.
*)
non_det : Label.non_det option;

}

type include_ocaml_file = {

part_included : string option;
(*
part_included is the part of the file to synchronize with. If lines is not specified synchronize the whole file.
*)

}

type include_other_file = {

header : Header.t option;

}

type include_file_kind =

| Fk_ocaml of include_ocaml_file
| Fk_other of include_other_file

type include_value = {

file_included : string;
(*
file_included is the name of the file to synchronize with.
*)
file_kind : include_file_kind;

}

type raw_value = {

header : Header.t option;

}

type value =

| Raw of raw_value
| OCaml of ocaml_value
| Cram of cram_value
| Toplevel of toplevel_value
| Include of include_value

The type for block values.

type section = int * string

The type for sections.

type t = {

loc : Location.t;
section : section option;
dir : string option;
labels : Label.t list;
legacy_labels : bool;
contents : string list;
skip : bool;
version_enabled : bool;
(*
Whether the current OCaml version complies with the block's version.
*)
set_variables : (string * string) list;
unset_variables : string list;
value : value;

}

The type for supported code blocks.

val mk : 
  loc:Location.t ->
  section:section option ->
  labels:Label.t list ->
  legacy_labels:bool ->
  header:Header.t option ->
  contents:string list ->
  errors:Output.t list ->
  (t, [ `Msg of string ]) Result.result

val mk_include : 
  loc:Location.t ->
  section:section option ->
  labels:Label.t list ->
  (t, [ `Msg of string ]) Result.result

mk_include builds an include block from a comment  that is not followed by a code block ``` ... ```.

Printers

val dump : t Fmt.t

dump is the printer for dumping code blocks. Useful for debugging.

val pp_header : ?syntax:Syntax.t -> t Fmt.t

pp_header pretty-prints full block headers with the labels.

val pp_contents : ?syntax:Syntax.t -> t Fmt.t

pp_contents pretty-prints block contents.

val pp_footer : ?syntax:Syntax.t -> t Fmt.t

pp_footer pretty-prints block footer.

val pp : ?syntax:Syntax.t -> t Fmt.t

pp pretty-prints blocks.

val pp_line_directive : (string * int) Fmt.t

pp_line_directive pretty-prints a line directive given as a filename and line number.

Accessors

val non_det : t -> Label.non_det option

Whether a block's command or output is non-deterministic.

val directory : t -> string option

directory t is the directory where t tests should be run.

val file : t -> string option

file t is the name of the file to synchronize t with.

val set_variables : t -> (string * string) list

set_variable t is the list of environment variable to set and their values

val unset_variables : t -> string list

unset_variable t is the list of environment variable to unset

val skip : t -> bool

skip t is true iff skip is in the labels of t.

val value : t -> value

value t is t's value.

val section : t -> section option

section t is t's section.

val executable_contents : syntax:Syntax.t -> t -> string list

executable_contents t is either t's contents if t is a raw or a cram block, or t's commands if t is a toplevel fragments (e.g. the phrase result is discarded).

val is_active : ?section:string -> t -> bool

package mdx

Printers

Accessors