Struct ShowcaseRunner 

pub struct ShowcaseRunner { /* private fields */ }

Main entry point for running showcases.

Implementations

impl ShowcaseRunner

pub fn new(title: impl Into<String>) -> Self

Create a new showcase runner with the given title.

The filter can be set via the SHOWCASE_FILTER environment variable. Only scenarios whose names contain the filter string (case-insensitive) will be shown.

pub fn filter(self, filter: impl Into<String>) -> Self

Set a filter for scenario names (case-insensitive contains).

Only scenarios whose names contain this string will be displayed.

pub fn slug(self, slug: impl Into<String>) -> Self

Set the URL slug for Zola (overrides the default derived from filename).

pub fn language(self, lang: Language) -> Self

Set the primary language for this showcase.

pub fn with_kdl_syntaxes(self, syntax_dir: &str) -> Self

Add KDL syntax support from a directory.

pub fn header(&self)

Print the showcase header.

pub fn intro(&self, text: &str)

Print an intro paragraph after the header.

This should be called immediately after header() to add context about what this showcase demonstrates.

pub fn scenario(&mut self, name: impl Into<String>) -> Scenario<'_>

Start a new scenario.

If a filter is set, scenarios that don’t match are skipped (all methods become no-ops).

pub fn section(&mut self, name: &str)

Start a new section (h2 heading).

When sections are used, scenarios within them become h3 headings. This creates a nice hierarchy in the table of contents.

pub fn footer(&self)

Finish the showcase and print footer.

pub fn highlighter(&self) -> &Highlighter

Get a reference to the highlighter.

pub fn mode(&self) -> OutputMode

Get the output mode.

pub fn primary_language(&self) -> Language

Get the primary language.