hexpm/ltest0.14.0ldoc

ltest-formatter

Format EUnit events and write or return the text and iodata used by the ltest report.

--loaded-ltest-records--/0function

--loaded-ltest-records--/0

Return ok. This dummy function marks the end of the include so the REPL prints its name as the last function loaded.

display-all/1function

display-all/1

Write only the aggregate Tests count from STATE, including cancellations; return the io:format/2 result.

display-errors/1function

display-errors/1

Write the Erred label and STATE's EUnit error count; return the io:format/2 result.

display-failures/1function

display-failures/1

Write the Failed label and STATE's assertion-failure count; return the IO result.

display-no-results/2function

display-no-results/2

Write the no-tests message using STATE's test type, then write the final blank lines. This function does not inspect counters; DATA is unused.

display-pending/1function

display-pending/1

Write STATE with the diagnostic label Pending; return the IO result.

display-profile/1function

display-profile/1

Write STATE with the diagnostic label Profile; return the IO result.

display-results/2function

display-results/2

Write the summary heading, total and category counts, timing, and final blank lines. DATA is unused; return the final IO result.

display-skips/1function

display-skips/1

Write the Skipped label and STATE's skip count; return the IO result.

display-successes/1function

display-successes/1

Write the Passed label and STATE's success count; return the IO result.

display-test-cancel/1function

display-test-cancel/1

Write format-cancel/1 reason text and return the IO result.

display-timing/1function

display-timing/1

Write STATE's total elapsed time, formatted as milliseconds; return the IO result.

err/3function

err/3

Write the EUnit error label and ERROR term using STATE color; WHERE is unused. Return the final formatting IO result.

fail/3function

fail/3

Write the assertion-failure label and ERROR term using STATE color; WHERE is unused. Return the final formatting IO result.

finish-section/0function

finish-section/0

Write two newline characters to the current IO device and return the second io:nl/0 result.

format-cancel/1function

format-cancel/1

Return branch-specific EUnit cancellation text or formatter output; some returned iodata contains format directives for a later formatter.

func-line/2function

func-line/2

Write one test line using DESC unless it is undefined, in which case use the suffix-stripped name from atom RAW-FUNC. Append zero-clamped codepoint padding and return the IO result. DESC may be flat Unicode text or a valid Unicode binary.

get-elision/1function

get-elision/1

Return dots for the available report width after FUNC-INDENT and the failure marker; clamp the count at zero and never truncate text. Accept a flat Unicode list or valid Unicode binary.

get-err-report/1function

get-err-report/1

Return Erred at zero; otherwise call the yellow color helper with STATE's color flag.

get-fail-report/1function

get-fail-report/1

Return Failed at zero; otherwise call the red color helper with STATE's color flag.

get-func-name/1function

get-func-name/1

Return an EUnit function name without terminal _test or _test_, or preserve other atom-name text, as a character list.

get-no-results-report/2function

get-no-results-report/2

Return a formatted no-tests message using STATE's test type; DATA is unused and no test-counter check is performed.

get-ok-report/1function

get-ok-report/1

Return Passed at zero; otherwise call the green bold color helper with STATE's color flag.

get-report/4function

get-report/4

Return TEXT when COUNT is zero; otherwise call COLOR-FUNC(TEXT, COLOR?) even when COLOR? is false.

get-skip-func-name/1function

get-skip-func-name/1

Return FUNC-NAME without a terminal _skip, or its unchanged atom name, as a character list.

get-skip-report/1function

get-skip-report/1

Return Skipped at zero; otherwise call the blue color helper with STATE's color flag.

get-suite-footer/1function

get-suite-footer/1

Return the colored closing rule and two newlines as iodata without writing it.

get-suite-header/1function

get-suite-header/1

Return the outer heading as colored iodata without writing it.

indent/1function

indent/1

Return a string containing COUNT spaces.

mod-line-begin/2function

mod-line-begin/2

Write a recognized module line and return the IO result; return skipping when MOD-LINE-CHECK returns an empty string.

mod-line-check/2function

mod-line-check/2

Return module-line iodata for a recognized descriptor without writing. A file descriptor must be the quoted EUnit form for a readable BEAM; descriptor and BEAM errors propagate. Other prefixes return an empty string.

mod-line-end/4function

mod-line-end/4

Write manual skip rows and module elapsed time. DATA is included in the debug log but does not determine these visible rows; no group category summary is printed.

mod-time/2function

mod-time/2

Write TIME in milliseconds using STATE color; return the io:format/2 result.

ok/1function

ok/1

Write the successful-test marker to the current IO device and return the io:format/1 result.

skip/1function

skip/1

Return the skipped-test marker iodata using STATE color; perform no IO.

skip-line/2function

skip-line/2

Write one skipped-test line for {Function, Arity} and return the io:put_chars/1 result.

skip-lines/2function

skip-lines/2

Write one line for each skipped entry and return the list of each skip-line/2 IO result.

stats-heading/1function

stats-heading/1

Write summary: and a newline to the current IO device; return the io:format/1 result.

test-header/2function

test-header/2

Return centered heading iodata. TITLE is a character list whose surrounding spaces fit the configured width; CHAR is a one-character string used for the rule and as the fill character when needed.

test-suite-footer/1function

test-suite-footer/1

Write the closing rule and two trailing newlines to the current IO device; return the io:format/1 result.

test-suite-header/1function

test-suite-header/1

Write the outer report heading to the current IO device and return the io:format/1 result.

test-type-header/2function

test-type-header/2

Write the colored group heading to the current IO device and return the io:format/1 result.