Name	Name	Last commit message	Last commit date
parent directory ..
_docs	_docs
_src	_src
docs	docs
examples	examples
tools	tools
.gitignore	.gitignore
DYNAMIC_TEST_FAILURES.md	DYNAMIC_TEST_FAILURES.md
LICENSE	LICENSE
MIGRATION_AUDIT_REPORT.md	MIGRATION_AUDIT_REPORT.md
README.md	README.md
TODO-test-parity.md	TODO-test-parity.md
discovery.json	discovery.json
fix-case.ps1	fix-case.ps1
fix-imports.ps1	fix-imports.ps1
full-test-results.txt	full-test-results.txt
livedoc.vitest.ts	livedoc.vitest.ts
package-lock.json	package-lock.json
package.json	package.json
test-one-file.ps1	test-one-file.ps1
test-reporter.js	test-reporter.js
tsconfig.json	tsconfig.json
tsconfig.test.json	tsconfig.test.json
tsup.config.ts	tsup.config.ts
validate-all-tests.ps1	validate-all-tests.ps1
validate-output.ps1	validate-output.ps1
validate-patterns.ps1	validate-patterns.ps1
validate-test-parity.ps1	validate-test-parity.ps1
viewer-debug.json	viewer-debug.json
viewer-output.txt	viewer-output.txt
vitest-brd.md	vitest-brd.md
vitest.config.ci.ts	vitest.config.ci.ts
vitest.config.file.ts	vitest.config.file.ts
vitest.config.json.ts	vitest.config.json.ts
vitest.config.list.ts	vitest.config.list.ts
vitest.config.nodynamic.ts	vitest.config.nodynamic.ts
vitest.config.publish.ts	vitest.config.publish.ts
vitest.config.silent.ts	vitest.config.silent.ts
vitest.config.summary.ts	vitest.config.summary.ts
vitest.config.ts	vitest.config.ts
vitest.config.viewer.ts	vitest.config.viewer.ts
vitest.config.vscode.ts	vitest.config.vscode.ts

Name

Last commit message

Last commit date

DYNAMIC_TEST_FAILURES.md

LICENSE

MIGRATION_AUDIT_REPORT.md

full-test-results.txt

validate-all-tests.ps1

validate-output.ps1

validate-patterns.ps1

validate-test-parity.ps1

vitest.config.file.ts

vitest.config.json.ts

vitest.config.list.ts

vitest.config.nodynamic.ts

vitest.config.publish.ts

vitest.config.silent.ts

vitest.config.summary.ts

vitest.config.ts

vitest.config.viewer.ts

vitest.config.vscode.ts

@swedevtools/livedoc-vitest

Turn your tests into living documentation

Write tests in Gherkin. Get documentation that never goes stale.

📖 Full Documentation →

What is LiveDoc?

LiveDoc brings Behavior-Driven Development to Vitest with full Gherkin syntax — Feature / Scenario / Given / When / Then, Specification / Rule, Scenario Outlines, Tags & Filtering, and beautiful reports.

Quick Start

Install

npm install --save-dev vitest @swedevtools/livedoc-vitest

Create a spec

// tests/Calculator.Spec.ts
import { feature, scenario, given, when, Then as then, and } from '@swedevtools/livedoc-vitest';

feature("Calculator", () => {
  scenario("Adding two numbers", () => {
    let result = 0;

    given("I have entered '50' into the calculator", (ctx) => {
      result = ctx.step.values[0];
    });

    and("I have entered '70' into the calculator", (ctx) => {
      result += ctx.step.values[0];
    });

    when("I press add", () => {
      // Addition already happened above
    });

    then("the result should be '120'", (ctx) => {
      expect(result).toBe(ctx.step.values[0]);
    });
  });
});

Why Then as then? ES modules treat then as a thenable indicator. We export Then (uppercase) and you alias it.

Configure Vitest

// vitest.config.ts
import { defineConfig } from 'vitest/config';
import { LiveDocSpecReporter } from '@swedevtools/livedoc-vitest/reporter';

export default defineConfig({
  test: {
    globals: true,
    include: ['**/*.Spec.ts'],
    reporters: [new LiveDocSpecReporter()],
  },
});

Run

npx vitest run

Documentation

📖 Full documentation at livedoc.swedevtools.com →

Covers getting started, BDD & Specification patterns, data extraction, scenario outlines, tags & filtering, reporters, viewer integration, CI/CD, troubleshooting, and more.

License

MIT

FilesExpand file tree

vitest

Directory actions

More options