Skip to main content

Crate executable_stories

Crate executable_stories 

Source

Macros§

declare_feature
Declare a feature for the current test file.

Structs§

DocEntry
A flexible document entry that serializes as a flat JSON object.
Feature
Declare what a file’s scenarios are for, ahead of the examples.
GlossaryTerm
One entry in a feature’s glossary.
HtmlOptions
Options for an embedded-HTML doc entry (DocEntry::html).
RawAttachment
RawCIInfo
RawError
RawFeature
What a file’s scenarios are for, declared with [crate::feature].
RawGlossaryTerm
One entry in a feature’s glossary.
RawRun
RawStepEvent
RawTestCase
StepDoc
Inline documentation for a step. Chain after a step method: story.given("text").with_docs(vec![StepDoc::note("a note")]).
Story
A BDD story builder that captures steps and emits a RawTestCase on drop.
StoryMeta
StoryStep
Ticket

Constants§

SCHEMA_URL
Published raw-run schema, emitted as $schema so editors validate the output file as the adapter writes it. executable-stories doctor also reports its presence.

Functions§

write_raw_run_to_path
Write a RawRun to disk as pretty-printed JSON, with the $schema pointer.
write_results
Panics