Module `Expect_test_matcher.Cst`Source

Concrete syntax tree of expectations and actual outputs

These types represent the contents of an %expect node or of the actual output. We keep information about the original layout so that we can give an corrected expectation that follows the original formatting.

In the following names, blank means ' ' or '\t', while space means blank or newline.

Sourcemodule Line : sig ... end

Sourcetype 'a single_line = {

leading_blanks : string;
(*
regexp: " \t*"
*)
trailing_spaces : string;
(*
regexp: " \t\n*"
*)
orig : string;
(*
regexp: "^ \t\n(^\n*^ \t\n)?"
*)
data : 'a;

}

Single line represent %expect nodes with data on the first line but not on the subsequent ones.

For instance:

  [%expect "  blah "];
  [%expect {|  blah
           |}]

Source

val sexp_of_single_line : 
  ('a -> Sexplib0.Sexp.t) ->
  'a single_line ->
  Sexplib0.Sexp.t

Source

val compare_single_line : 
  ('a -> 'a -> int) ->
  'a single_line ->
  'a single_line ->
  int

Source

val equal_single_line : 
  ('a -> 'a -> bool) ->
  'a single_line ->
  'a single_line ->
  bool

Sourcetype 'a multi_lines = {

leading_spaces : string;
(*
regexp: "\( \t*\n\)*"
*)
trailing_spaces : string;
(*
regexp: " \t*" or "\(\n \t*\)*"
*)
indentation : string;
(*
regexp: " \t*"
*)
lines : 'a Line.t list;
(*
regexp: not_blank (.* not_blank)?
*)

}

Any %expect node with one or more newlines and at least one non-blank line.

This also include the case with exactly one non-blank line such as:

  [%expect {|
    blah
  |}]

This is to preserve this formatting in case the correction is multi-line.

leading_spaces contains everything until the first non-blank line, while trailing_spaces is either:

trailing blanks on the last line if of the form:

  [%expect {|
             abc
             def |}]

all trailing spaces from the newline character (inclusive) on the last non-blank line to the end if of the form:

  [%expect {|
             abc
             def
  |}]

Source

val sexp_of_multi_lines : 
  ('a -> Sexplib0.Sexp.t) ->
  'a multi_lines ->
  Sexplib0.Sexp.t

Source

val compare_multi_lines : 
  ('a -> 'a -> int) ->
  'a multi_lines ->
  'a multi_lines ->
  int

Source

val equal_multi_lines : 
  ('a -> 'a -> bool) ->
  'a multi_lines ->
  'a multi_lines ->
  bool

Sourcetype 'a t =

| Empty of string
(*
regexp: " \t\n*"
*)
| Single_line of 'a single_line
| Multi_lines of 'a multi_lines

Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t

Sourceval compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int

Sourceval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool

Sourceval invariant : ('a -> unit) -> 'a t -> unit

Sourceval empty : 'a t

Sourceval map : 'a t -> f:(string -> 'a -> 'b) -> 'b t

Sourceval data : 'a t -> blank:'a -> conflict_marker:(string -> 'a) -> 'a list

Sourceval strip : 'a t -> 'a t

Sourceval to_string : _ t -> string

Sourceval to_lines : 'a t -> 'a Line.t list

For single line expectation, leading blanks and trailing spaces are dropped.

Sourceval trim_lines : 'a Line.t list -> 'a Line.t list

Remove blank lines at the beginning and end of the list.

Source

val reconcile : 
  'a t ->
  lines:'a Line.t list ->
  default_indentation:int ->
  pad_single_line:bool ->
  'a t

Given a contents t and a list of lines, try to produce a new contents containing lines but with the same formatting as t.

default_indentation is the indentation to use in case we ignore t's indentation (for instance if t is Single_line or Empty).

Sourceval extract_indentation : 'a Line.t list -> string * 'a Line.t list

Compute the longest indentation of a list of lines and trim it from every line. It returns the found indentation and the list of trimmed lines.

Sourceval stripped_original_lines : _ t -> string list

All the .orig fields of Line.t or single_line values, using "" for blank lines.

Install

Dune Dependency

Authors

Maintainers

Sources

doc/ppx_expect_nobase.matcher/Expect_test_matcher/Cst/index.html

Module `Expect_test_matcher.Cst`Source

package ppx_expect_nobase

Install

Dune Dependency

Authors

Maintainers

Sources

doc/ppx_expect_nobase.matcher/Expect_test_matcher/Cst/index.html

Module Expect_test_matcher.CstSource

Module `Expect_test_matcher.Cst`Source