@swedevtools/livedoc-vitest 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -1,291 +0,0 @@
-import { R as Rule, S as Specification, T as Table, F as Feature, B as Background, a as Scenario, b as ScenarioOutline, c as StepDefinition } from './index-Blmp569T.cjs';
-export { C as ColorTheme, D as DefaultColorTheme, E as Exception, d as ExecutionResults, H as HeaderType, I as IPostReporter, J as JsonReporter, L as LiveDocReporter, e as LiveDocReporterOptions, f as LiveDocRuleViolation, g as LiveDocServerReporter, h as LiveDocSpec, g as LiveDocSpecReporter, i as LiveDocSuite, j as LiveDocTest, k as LiveDocViewerOptions, l as LiveDocViewerReporter, m as LiveDocVitestReporter, n as ReporterOptions, o as RuleViolations, p as ScenarioExample, q as ScenarioOutlineContext, r as SilentReporter, s as SpecStatus, t as Statistics, u as SuiteBase, V as VitestSuite } from './index-Blmp569T.cjs';
-import { D as DataTableRow, R as RuleContext } from './RuleContext-BZhuy-zS.cjs';
-export { B as BackgroundContext, F as FeatureContext, S as ScenarioContext, b as SpecificationContext, a as StepContext } from './RuleContext-BZhuy-zS.cjs';
-import * as vitest from 'vitest';
-import 'vitest/reporters';
-import '@vitest/runner';
-import 'vitest/node';
-import '@swedevtools/livedoc-schema';
-
-declare class TextBlockReader {
-    private arrayOfLines;
-    private currentIndex;
-    constructor(text: string);
-    get count(): number;
-    get line(): string | null;
-    next(): boolean;
-    reset(): void;
-}
-
-/**
- * Thrown when invalid syntax is encountered
- */
-declare class ParserException extends Error {
-    description: string;
-    title: string;
-    filename: string;
-    constructor(description: string, title: string, filename: string);
-}
-
-/**
- * Extended context for rule outlines including example data
- */
-interface RuleOutlineContext extends RuleContext {
-    example: DataTableRow;
-    exampleRaw: DataTableRow;
-}
-/**
- * RuleExample represents a single data row execution of a RuleOutline.
- * Similar to ScenarioExample but for the Specification pattern.
- */
-declare class RuleExample extends Rule {
-    example: DataTableRow;
-    exampleRaw: DataTableRow;
-    ruleOutline: RuleOutline;
-    constructor(parent: Specification, ruleOutline: RuleOutline);
-    getRuleContext(): RuleOutlineContext;
-    bind(content: string, model: DataTableRow): string;
-    private sanitizeName;
-    toJSON(): object;
-}
-
-/**
- * RuleOutline is a data-driven rule with Examples table.
- * Similar to ScenarioOutline but for the Specification pattern.
- */
-declare class RuleOutline extends Rule {
-    tables: Table[];
-    examples: RuleExample[];
-    constructor(parent: Specification);
-    toJSON(): object;
-}
-
-declare class LiveDocGrammarParser {
-    private formatDisplayTitle;
-    private formatStepDisplayTitle;
-    createFeature(description: string, filename: string): Feature;
-    addBackground(feature: Feature, description: string): Background;
-    addScenario(feature: Feature, description: string): Scenario;
-    addScenarioOutline(feature: Feature, description: string): ScenarioOutline;
-    private addExamplesAsScenarios;
-    private addExample;
-    createStep(type: string, description: string, passedParam?: object | (() => object)): StepDefinition;
-    applyPassedParams(step: StepDefinition): void;
-    createSpecification(description: string, filename: string): Specification;
-    addRule(specification: Specification, description: string): Rule;
-    addRuleOutline(specification: Specification, description: string): RuleOutline;
-    private addRuleExamples;
-    private addRuleExample;
-}
-declare class DescriptionParser {
-    title: string;
-    description: string;
-    text: string;
-    tags: string[];
-    tables: Table[];
-    dataTable: DataTableRow[];
-    docString: string;
-    quotedValues: string[];
-    namedValues: Record<string, string>;
-    parseDescription(text: string): void;
-    getTableRowAsEntity(headerRow: DataTableRow, dataRow: DataTableRow, shouldCoerce?: boolean): DataTableRow;
-    coerceValues(values: string[]): any[];
-    coerceNamedValues(namedValues: Record<string, string>): Record<string, any>;
-    coerceValue(valueString: string): any;
-    private convertToDateIfPossible;
-    private isCommentedLine;
-    private parseTable;
-    parseDataTable(textReader: TextBlockReader): DataTableRow[];
-    parseDocString(textReader: TextBlockReader): string;
-    private parseQuotedValues;
-    private parseNamedValues;
-    private getFirstNonBlankIndex;
-    private trimStart;
-    applyIndenting(text: string, spacing: number): string;
-    bind(content: string, model: any): string;
-    secondaryBind(content: string, model: any): string;
-    private applyBinding;
-    sanitizeName(name: string): string;
-}
-
-declare enum LiveDocRuleOption {
-    enabled = "enabled",
-    disabled = "disabled",
-    warning = "warning"
-}
-
-declare class LiveDocRules {
-    /**
-     * Is triggered when more than 1 given, when or then is used within a single scenario, scenarioOutline or background
-     */
-    singleGivenWhenThen: LiveDocRuleOption;
-    /**
-     * Is triggered if no given is part of the test
-     */
-    mustIncludeGiven: LiveDocRuleOption;
-    /**
-     * Is triggered if no when is part of the test
-     */
-    mustIncludeWhen: LiveDocRuleOption;
-    /**
-     * Is triggered if no then is part of the test
-     */
-    mustIncludeThen: LiveDocRuleOption;
-    /**
-     * Is triggered if a background uses when or then
-     */
-    backgroundMustOnlyIncludeGiven: LiveDocRuleOption;
-    /**
-     * Using the before hook has the same affect as the given step definition but with the ability to convey meaning.
-     * It is therefore encouraged to use a given over the before hook.
-     */
-    enforceUsingGivenOverBefore: LiveDocRuleOption;
-    /**
-     * Ensures that a title is specified for keywords that require it
-     */
-    enforceTitle: LiveDocRuleOption;
-}
-
-declare class FilterOptions {
-    include?: string[];
-    exclude?: string[];
-    showFilterConflicts?: boolean;
-}
-
-declare class PublishOptions {
-    /** Server URL, e.g., 'http://localhost:3100' */
-    server: string;
-    /** Project name (defaults to 'default') */
-    project: string;
-    /** Environment name (defaults to 'local') */
-    environment: string;
-    /** Whether publishing is enabled */
-    enabled: boolean;
-}
-
-declare class LiveDocOptions {
-    rules: LiveDocRules;
-    filters: FilterOptions;
-    publish: PublishOptions;
-    postReporters: any[];
-    isolatedMode: boolean;
-}
-
-declare const livedoc: {
-    options: LiveDocOptions;
-};
-/**
- * Feature keyword - creates a new Gherkin feature
- */
-declare const feature: ((title: string, fn: (ctx: any) => void) => void) & {
-    skip: (title: string, fn: (ctx: any) => void) => void;
-    only: (title: string, fn: (ctx: any) => void) => void;
-};
-/**
- * Scenario keyword - creates a new test scenario
- */
-declare const scenario: ((title: string, fn: (ctx: any) => void | Promise<void>) => void) & {
-    skip: (title: string, fn: (ctx: any) => void | Promise<void>) => void;
-    only: (title: string, fn: (ctx: any) => void | Promise<void>) => void;
-};
-/**
- * Background keyword - defines steps to run before each scenario
- */
-declare const background: ((title: string, fn: (ctx: any) => void) => void) & {
-    skip: (title: string, fn: (ctx: any) => void) => void;
-    only: (title: string, fn: (ctx: any) => void) => void;
-};
-/**
- * Register a hook that runs at the START of each scenario/example.
- * Used by plugins like the Playwright integration to create fresh browser contexts.
- */
-declare function onScenarioStart(fn: () => Promise<void>): void;
-/**
- * Register a hook that runs at the END of each scenario/example.
- * Used by plugins like the Playwright integration to clean up browser contexts.
- */
-declare function onScenarioEnd(fn: () => Promise<void>): void;
-/**
- * Scenario Outline keyword - creates data-driven scenarios
- */
-declare const scenarioOutline: ((title: string, fn: (ctx: any) => void) => void) & {
-    skip: (title: string, fn: (ctx: any) => void) => void;
-    only: (title: string, fn: (ctx: any) => void) => void;
-};
-/**
- * Specification keyword - creates a new specification container
- */
-declare const specification: ((title: string, fn: (ctx: any) => void) => void) & {
-    skip: (title: string, fn: (ctx: any) => void) => void;
-    only: (title: string, fn: (ctx: any) => void) => void;
-};
-/**
- * Rule keyword - creates a simple specification rule
- */
-declare const rule: ((title: string, fn: (ctx: any) => void | Promise<void>) => void) & {
-    skip: (title: string, fn: (ctx: any) => void | Promise<void>) => void;
-    only: (title: string, fn: (ctx: any) => void | Promise<void>) => void;
-};
-/**
- * Rule Outline keyword - creates data-driven rules
- */
-declare const ruleOutline: ((title: string, fn: (ctx: any) => void | Promise<void>) => void) & {
-    skip: (title: string, fn: (ctx: any) => void | Promise<void>) => void;
-    only: (title: string, fn: (ctx: any) => void | Promise<void>) => void;
-};
-/**
- * given keyword - preconditions
- */
-declare const given: (title: string, fn?: (ctx: any) => void | Promise<void>, passedParam?: object | Function, internalOptions?: {
-    docStringRaw?: string;
-    dataTable?: any[];
-}) => void;
-/**
- * when keyword - actions
- */
-declare const when: (title: string, fn?: (ctx: any) => void | Promise<void>, passedParam?: object | Function, internalOptions?: {
-    docStringRaw?: string;
-    dataTable?: any[];
-}) => void;
-/**
- * Then keyword - assertions
- * NOTE: Uppercase 'Then' is required due to ESM thenable detection.
- * If a module exports 'then', Node.js treats it as a Promise-like object.
- * Users who prefer lowercase can use: import { Then as then } from '@swedevtools/livedoc-vitest'
- * Or use globals mode where lowercase 'then' is available.
- */
-declare const Then: (title: string, fn?: (ctx: any) => void | Promise<void>, passedParam?: object | Function, internalOptions?: {
-    docStringRaw?: string;
-    dataTable?: any[];
-}) => void;
-/**
- * and keyword - continuation
- */
-declare const and: (title: string, fn?: (ctx: any) => void | Promise<void>, passedParam?: object | Function, internalOptions?: {
-    docStringRaw?: string;
-    dataTable?: any[];
-}) => void;
-/**
- * but keyword - continuation with contrast
- */
-declare const but: (title: string, fn?: (ctx: any) => void | Promise<void>, passedParam?: object | Function, internalOptions?: {
-    docStringRaw?: string;
-    dataTable?: any[];
-}) => void;
-/**
- * Exported 'it' function with .skip and .only support
- */
-declare const livedocIt: ((title: string, fn?: Function) => void) & {
-    skip: (title: string, fn?: Function) => void;
-    only: (title: string, fn?: Function) => void;
-};
-/**
- * Exported 'describe' function with .skip and .only support
- */
-declare const livedocDescribe: ((title: string, fn?: Function) => vitest.SuiteCollector<object>) & {
-    skip: (title: string, fn?: Function) => vitest.SuiteCollector<object>;
-    only: (title: string, fn?: Function) => vitest.SuiteCollector<object>;
-};
-
-export { Background, DataTableRow, DescriptionParser, Feature, FilterOptions, LiveDocGrammarParser, LiveDocOptions, LiveDocRuleOption, LiveDocRules, ParserException, Rule, RuleContext, RuleExample, RuleOutline, type RuleOutlineContext, Scenario, ScenarioOutline, Specification, StepDefinition, Table, TextBlockReader, Then, and, background, but, livedocDescribe as describe, feature, given, livedocIt as it, livedoc, onScenarioEnd, onScenarioStart, rule, ruleOutline, scenario, scenarioOutline, specification, when };

package/dist/playwright/index.cjs

@@ -1,103 +0,0 @@
-'use strict';
-
-var vitest = require('vitest');
-var livedocVitest = require('@swedevtools/livedoc-vitest');
-
-// _src/app/playwright/index.ts
-var playwrightModule;
-var playwrightLoaded = false;
-async function ensurePlaywright() {
-  if (playwrightLoaded) return playwrightModule;
-  try {
-    const moduleName = "playwright";
-    playwrightModule = await import(
-      /* @vite-ignore */
-      moduleName
-    );
-    playwrightLoaded = true;
-    return playwrightModule;
-  } catch {
-    throw new Error(
-      "@swedevtools/livedoc-vitest/playwright requires 'playwright' as a peer dependency.\nInstall it with:\n\n  pnpm add -D playwright\n  npx playwright install chromium\n"
-    );
-  }
-}
-var _screenshotIndex = 0;
-function slugify(text) {
-  return text.toLowerCase().replace(/['"`]/g, "").replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "");
-}
-async function screenshot(page, ctx, options) {
-  const fullPage = options?.fullPage ?? true;
-  const buffer = await page.screenshot({ fullPage });
-  const base64 = buffer.toString("base64");
-  const name = options?.name ?? `${slugify(ctx.step.title)}-${++_screenshotIndex}`;
-  ctx.step.attachScreenshot(base64, name);
-}
-function useBrowser(options) {
-  const baseUrl = options?.baseUrl ?? "http://localhost:3000";
-  const browserName = options?.browser ?? "chromium";
-  const freshContext = options?.freshContextPerScenario ?? false;
-  let _browser;
-  let _context;
-  let _page;
-  vitest.beforeAll(async () => {
-    const pw = await ensurePlaywright();
-    const launcher = pw[browserName];
-    _browser = await launcher.launch(options?.launch ?? { headless: true });
-    if (!freshContext) {
-      _context = await _browser.newContext(options?.context ?? {});
-      _page = await _context.newPage();
-    }
-    _screenshotIndex = 0;
-  });
-  if (freshContext) {
-    livedocVitest.onScenarioStart(async () => {
-      _context = await _browser.newContext(options?.context ?? {});
-      _page = await _context.newPage();
-    });
-    livedocVitest.onScenarioEnd(async () => {
-      await _context?.close().catch(() => {
-      });
-      _page = void 0;
-      _context = void 0;
-    });
-  }
-  vitest.afterAll(async () => {
-    try {
-      await _browser?.close();
-    } catch {
-    } finally {
-      _page = void 0;
-      _context = void 0;
-      _browser = void 0;
-    }
-  });
-  return {
-    page: () => {
-      if (!_page) {
-        throw new Error(
-          "Playwright page is not initialized. Ensure useBrowser() is called at module scope and page() is called inside a step."
-        );
-      }
-      return _page;
-    },
-    context: () => {
-      if (!_context) {
-        throw new Error("Playwright context is not initialized.");
-      }
-      return _context;
-    },
-    browser: () => {
-      if (!_browser) {
-        throw new Error("Playwright browser is not initialized.");
-      }
-      return _browser;
-    },
-    baseUrl
-  };
-}
-var usePlaywright = useBrowser;
-
-exports.screenshot = screenshot;
-exports.useBrowser = useBrowser;
-exports.usePlaywright = usePlaywright;

package/dist/playwright/index.d.cts

@@ -1,129 +0,0 @@
-import { StepContext } from '@swedevtools/livedoc-vitest';
-
-/**
- * @swedevtools/livedoc-vitest/playwright
- *
- * Playwright integration for LiveDoc — browser lifecycle management
- * and screenshot helpers for BDD feature specs.
- *
- * @example
- * ```typescript
- * import { feature, scenario, given, when, then } from '@swedevtools/livedoc-vitest';
- * import { useBrowser, screenshot } from '@swedevtools/livedoc-vitest/playwright';
- *
- * const { page, baseUrl } = useBrowser({ baseUrl: 'http://localhost:5174' });
- *
- * feature('Checkout Flow', () => {
- *     scenario('User adds item to cart', () => {
- *         given("user views the product page", async (ctx) => {
- *             await page().goto(`${baseUrl}/products/1`);
- *             await screenshot(page(), ctx);
- *         });
- *     });
- * });
- * ```
- */
-
-/** Minimal Page interface — the real Playwright Page has many more methods */
-interface PlaywrightPage {
-    screenshot(options?: {
-        fullPage?: boolean;
-    }): Promise<Buffer>;
-    goto(url: string, options?: Record<string, unknown>): Promise<unknown>;
-    close(): Promise<void>;
-    [key: string]: unknown;
-}
-/** Minimal BrowserContext interface */
-interface PlaywrightBrowserContext {
-    newPage(): Promise<PlaywrightPage>;
-    close(): Promise<void>;
-    [key: string]: unknown;
-}
-/** Minimal Browser interface */
-interface PlaywrightBrowser {
-    newContext(options?: Record<string, unknown>): Promise<PlaywrightBrowserContext>;
-    close(): Promise<void>;
-    [key: string]: unknown;
-}
-/** Browser engine to use */
-type BrowserName = "chromium" | "firefox" | "webkit";
-/** Options for useBrowser() / usePlaywright() */
-interface PlaywrightOptions {
-    /** Base URL for navigation (default: 'http://localhost:3000') */
-    baseUrl?: string;
-    /** Browser engine (default: 'chromium') */
-    browser?: BrowserName;
-    /** Options passed directly to browser.launch() */
-    launch?: Record<string, unknown>;
-    /** Options passed directly to browser.newContext() */
-    context?: Record<string, unknown>;
-    /** Create a fresh BrowserContext for each scenario (default: false) */
-    freshContextPerScenario?: boolean;
-}
-/** Return type of useBrowser() */
-interface PlaywrightFixture {
-    /** Get the current Page instance (call inside steps, not at module scope) */
-    page: () => PlaywrightPage;
-    /** Get the current BrowserContext */
-    context: () => PlaywrightBrowserContext;
-    /** Get the Browser instance */
-    browser: () => PlaywrightBrowser;
-    /** Configured base URL */
-    baseUrl: string;
-}
-/** Options for the screenshot() helper */
-interface ScreenshotOptions {
-    /** Override auto-generated screenshot name */
-    name?: string;
-    /** Capture full page scroll height (default: true) */
-    fullPage?: boolean;
-}
-/**
- * Capture a screenshot and attach it to the current LiveDoc step.
- *
- * Auto-generates a descriptive filename from the step title if no name is provided.
- *
- * @example
- * ```typescript
- * // Auto-named from step title
- * await screenshot(page(), ctx);
- *
- * // Custom name
- * await screenshot(page(), ctx, { name: 'login-form' });
- * ```
- */
-declare function screenshot(page: PlaywrightPage, ctx: {
-    step: StepContext;
-}, options?: ScreenshotOptions): Promise<void>;
-/**
- * Initialize Playwright browser lifecycle for a feature file.
- *
- * Call at **module scope** (outside `feature()` block) to get feature-level
- * browser sharing. The browser launches once and is shared across all
- * scenarios in the file.
- *
- * @example
- * ```typescript
- * import { useBrowser, screenshot } from '@swedevtools/livedoc-vitest/playwright';
- *
- * const { page, baseUrl } = useBrowser({
- *     baseUrl: 'http://localhost:5174',
- *     browser: 'chromium',
- *     launch: { headless: process.env.CI === 'true' },
- * });
- *
- * feature('My Feature', () => {
- *     scenario('My Scenario', () => {
- *         given("I open the app", async (ctx) => {
- *             await page().goto(baseUrl);
- *             await screenshot(page(), ctx);
- *         });
- *     });
- * });
- * ```
- */
-declare function useBrowser(options?: PlaywrightOptions): PlaywrightFixture;
-/** Alias for useBrowser() */
-declare const usePlaywright: typeof useBrowser;
-
-export { type BrowserName, type PlaywrightBrowser, type PlaywrightBrowserContext, type PlaywrightFixture, type PlaywrightOptions, type PlaywrightPage, type ScreenshotOptions, screenshot, useBrowser, usePlaywright };