@step-forge/step-forge 0.0.20 → 0.0.21

package/dist/vitest.d.ts

@@ -1,74 +0,0 @@
-//#region src/runtime/vitest.d.ts
-interface StepForgeOptions {
-  /**
-   * Globs (relative to the Vite root) for step-definition modules.
-   * Defaults to `**​/*.steps.ts`.
-   */
-  steps?: string | string[];
-  /**
-   * Module that default-exports a world factory `() => world`, resolved
-   * relative to the Vite root. When omitted, each scenario gets a fresh
-   * `BasicWorld`.
-   */
-  world?: string;
-  /**
-   * Feature-file glob(s) to register as test files. Defaults to
-   * `**​/*.feature`. Accepts an array to scope several exact files or patterns
-   * (e.g. running real features while excluding analyzer fixtures).
-   */
-  features?: string | string[];
-  /**
-   * Advanced: module specifier the generated tests import the runtime from.
-   * Defaults to the published `@step-forge/step-forge/runtime` entry; override
-   * only when consuming the library from source (e.g. this repo's own tests).
-   */
-  runtimeModule?: string;
-  /**
-   * Advanced: module specifier for the library core (used for the default
-   * `BasicWorld`). Defaults to `@step-forge/step-forge`.
-   */
-  coreModule?: string;
-}
-/** Minimal Vite plugin shape (avoids a hard dependency on vite's types). */
-interface VitePlugin {
-  name: string;
-  enforce?: "pre" | "post";
-  config?: () => unknown;
-  configResolved?: (config: {
-    root: string;
-  }) => void;
-  transform?: (code: string, id: string) => Promise<{
-    code: string;
-    map: null;
-  } | undefined>;
-}
-/**
- * Vite/Vitest plugin: compiles each `.feature` file into a test module so
- * scenarios show up as native Vitest tests (watch mode, --ui, per-scenario
- * tasks, the lot). The transform injects imports of the step modules so that
- * (a) steps self-register into the same registry the engine reads, and
- * (b) Vite's HMR graph invalidates the feature test when a step file changes.
- */
-declare function stepForge(options?: StepForgeOptions): VitePlugin;
-/**
- * One-line Vitest config preset. Drop this in `vitest.config.ts`:
- *
- * ```ts
- * import { defineStepForgeConfig } from "@step-forge/step-forge/vitest";
- * export default defineStepForgeConfig({ world: "./support/world.ts" });
- * ```
- *
- * Runs `**​/*.feature` as native tests, auto-discovers `**​/*.steps.ts`, and
- * defaults the world to `BasicWorld`. Override any Vitest option via `test`.
- */
-declare function defineStepForgeConfig(options?: StepForgeOptions & {
-  test?: Record<string, unknown>;
-}): {
-  plugins: VitePlugin[];
-  test: {
-    include: string[];
-  };
-};
-//#endregion
-export { StepForgeOptions, defineStepForgeConfig, stepForge };
-//# sourceMappingURL=vitest.d.ts.map

package/dist/vitest.js

@@ -1,136 +0,0 @@
-import { t as parseFeatureContent } from "./gherkinParser-Dp2d7JNr.js";
-import { glob } from "node:fs/promises";
-import * as path from "node:path";
-//#region src/runtime/vitest.ts
-const DEFAULT_STEPS = "**/*.steps.ts";
-const DEFAULT_FEATURES = "**/*.feature";
-const DEFAULT_RUNTIME_MODULE = "@step-forge/step-forge/runtime";
-const DEFAULT_CORE_MODULE = "@step-forge/step-forge";
-function toArray(value) {
-	return Array.isArray(value) ? value : [value];
-}
-/**
-* Map a scenario's Gherkin tags onto the Vitest test variant. `@skip` wins over
-* `@only` (a scenario explicitly skipped stays skipped even if also `@only`ed),
-* and everything else is a plain `test`.
-*/
-function testFn(tags) {
-	if (tags.includes("@skip")) return "test.skip";
-	if (tags.includes("@only")) return "test.only";
-	return "test";
-}
-/** One `runScenario` test line for the scenario at `__scenarios[index]`. */
-function testLine(scenario, index, indent) {
-	return `${indent}${testFn(scenario.tags)}(${JSON.stringify(scenario.name)}, () => runScenario(__scenarios[${index}], globalRegistry, __makeWorld));`;
-}
-/**
-* Emit the test bodies for a feature. Plain scenarios become one `test` each;
-* consecutive rows expanded from the same `Scenario Outline` are wrapped in a
-* `describe` named after the outline, so they read as one labelled group with a
-* `test` per example row (and each row keeps its own `@skip`/`@only`).
-*/
-function generateTests(scenarios) {
-	const lines = [];
-	let i = 0;
-	while (i < scenarios.length) {
-		const outlineName = scenarios[i].outline?.name;
-		if (outlineName === void 0) {
-			lines.push(testLine(scenarios[i], i, "  "));
-			i += 1;
-			continue;
-		}
-		lines.push(`  describe(${JSON.stringify(outlineName)}, () => {`);
-		while (i < scenarios.length && scenarios[i].outline?.name === outlineName) {
-			lines.push(testLine(scenarios[i], i, "    "));
-			i += 1;
-		}
-		lines.push(`  });`);
-	}
-	return lines.join("\n");
-}
-function toSpecifier(p) {
-	return path.isAbsolute(p) ? p.split(path.sep).join("/") : p;
-}
-async function resolveSteps(steps, root) {
-	const patterns = Array.isArray(steps) ? steps : [steps];
-	const files = /* @__PURE__ */ new Set();
-	for (const pattern of patterns) for await (const file of glob(pattern, { cwd: root })) files.add(path.resolve(root, file));
-	return [...files];
-}
-/**
-* Vite/Vitest plugin: compiles each `.feature` file into a test module so
-* scenarios show up as native Vitest tests (watch mode, --ui, per-scenario
-* tasks, the lot). The transform injects imports of the step modules so that
-* (a) steps self-register into the same registry the engine reads, and
-* (b) Vite's HMR graph invalidates the feature test when a step file changes.
-*/
-function stepForge(options = {}) {
-	const featuresGlobs = toArray(options.features ?? DEFAULT_FEATURES);
-	const stepsGlob = options.steps ?? DEFAULT_STEPS;
-	const runtimeModule = options.runtimeModule ?? DEFAULT_RUNTIME_MODULE;
-	const coreModule = options.coreModule ?? DEFAULT_CORE_MODULE;
-	let root = process.cwd();
-	return {
-		name: "step-forge",
-		enforce: "pre",
-		config() {
-			return { test: { include: featuresGlobs } };
-		},
-		configResolved(config) {
-			root = config.root;
-		},
-		async transform(code, id) {
-			if (!id.endsWith(".feature")) return;
-			const scenarios = parseFeatureContent(code, id);
-			const featureName = /^\s*Feature:\s*(.+)$/m.exec(code)?.[1]?.trim() ?? path.basename(id);
-			const stepImports = (await resolveSteps(stepsGlob, root)).map((f) => `import ${JSON.stringify(toSpecifier(f))};`).join("\n");
-			const worldImport = options.world ? `import __makeWorld from ${JSON.stringify(toSpecifier(path.resolve(root, options.world)))};` : `import { BasicWorld } from ${JSON.stringify(coreModule)};\nconst __makeWorld = () => new BasicWorld();`;
-			const tests = generateTests(scenarios);
-			return {
-				code: `
-import { describe, test, beforeAll, afterAll } from "vitest";
-import { runScenario, globalRegistry, runHooks, ensureGlobalHooks } from ${JSON.stringify(runtimeModule)};
-${worldImport}
-${stepImports}
-
-const __scenarios = ${JSON.stringify(scenarios)};
-
-describe(${JSON.stringify(featureName)}, () => {
-  // Global before-hooks fire once per worker, ahead of feature hooks.
-  beforeAll(() => ensureGlobalHooks());
-  beforeAll(() => runHooks("feature", "before"));
-  afterAll(() => runHooks("feature", "after"));
-${tests}
-});
-`,
-				map: null
-			};
-		}
-	};
-}
-/**
-* One-line Vitest config preset. Drop this in `vitest.config.ts`:
-*
-* ```ts
-* import { defineStepForgeConfig } from "@step-forge/step-forge/vitest";
-* export default defineStepForgeConfig({ world: "./support/world.ts" });
-* ```
-*
-* Runs `**​/*.feature` as native tests, auto-discovers `**​/*.steps.ts`, and
-* defaults the world to `BasicWorld`. Override any Vitest option via `test`.
-*/
-function defineStepForgeConfig(options = {}) {
-	const { test, ...pluginOptions } = options;
-	const featuresGlobs = toArray(pluginOptions.features ?? DEFAULT_FEATURES);
-	return {
-		plugins: [stepForge(pluginOptions)],
-		test: {
-			include: featuresGlobs,
-			...test
-		}
-	};
-}
-//#endregion
-export { defineStepForgeConfig, stepForge };
-
-//# sourceMappingURL=vitest.js.map

package/dist/vitest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"vitest.js","names":[],"sources":["../../src/runtime/vitest.ts"],"sourcesContent":["import { glob } from \"node:fs/promises\";\nimport * as path from \"node:path\";\nimport { parseFeatureContent } from \"../analyzer/gherkinParser\";\nimport { ParsedScenario } from \"../analyzer/types\";\n\nexport interface StepForgeOptions {\n  /**\n   * Globs (relative to the Vite root) for step-definition modules.\n   * Defaults to `**​/*.steps.ts`.\n   */\n  steps?: string | string[];\n  /**\n   * Module that default-exports a world factory `() => world`, resolved\n   * relative to the Vite root. When omitted, each scenario gets a fresh\n   * `BasicWorld`.\n   */\n  world?: string;\n  /**\n   * Feature-file glob(s) to register as test files. Defaults to\n   * `**​/*.feature`. Accepts an array to scope several exact files or patterns\n   * (e.g. running real features while excluding analyzer fixtures).\n   */\n  features?: string | string[];\n  /**\n   * Advanced: module specifier the generated tests import the runtime from.\n   * Defaults to the published `@step-forge/step-forge/runtime` entry; override\n   * only when consuming the library from source (e.g. this repo's own tests).\n   */\n  runtimeModule?: string;\n  /**\n   * Advanced: module specifier for the library core (used for the default\n   * `BasicWorld`). Defaults to `@step-forge/step-forge`.\n   */\n  coreModule?: string;\n}\n\n/** Minimal Vite plugin shape (avoids a hard dependency on vite's types). */\ninterface VitePlugin {\n  name: string;\n  enforce?: \"pre\" | \"post\";\n  config?: () => unknown;\n  configResolved?: (config: { root: string }) => void;\n  transform?: (\n    code: string,\n    id: string\n  ) => Promise<{ code: string; map: null } | undefined>;\n}\n\nconst DEFAULT_STEPS = \"**/*.steps.ts\";\nconst DEFAULT_FEATURES = \"**/*.feature\";\nconst DEFAULT_RUNTIME_MODULE = \"@step-forge/step-forge/runtime\";\nconst DEFAULT_CORE_MODULE = \"@step-forge/step-forge\";\n\nfunction toArray<T>(value: T | T[]): T[] {\n  return Array.isArray(value) ? value : [value];\n}\n\n/**\n * Map a scenario's Gherkin tags onto the Vitest test variant. `@skip` wins over\n * `@only` (a scenario explicitly skipped stays skipped even if also `@only`ed),\n * and everything else is a plain `test`.\n */\nfunction testFn(tags: string[]): string {\n  if (tags.includes(\"@skip\")) return \"test.skip\";\n  if (tags.includes(\"@only\")) return \"test.only\";\n  return \"test\";\n}\n\n/** One `runScenario` test line for the scenario at `__scenarios[index]`. */\nfunction testLine(\n  scenario: ParsedScenario,\n  index: number,\n  indent: string\n): string {\n  return (\n    `${indent}${testFn(scenario.tags)}(${JSON.stringify(scenario.name)}, () => ` +\n    `runScenario(__scenarios[${index}], globalRegistry, __makeWorld));`\n  );\n}\n\n/**\n * Emit the test bodies for a feature. Plain scenarios become one `test` each;\n * consecutive rows expanded from the same `Scenario Outline` are wrapped in a\n * `describe` named after the outline, so they read as one labelled group with a\n * `test` per example row (and each row keeps its own `@skip`/`@only`).\n */\nfunction generateTests(scenarios: ParsedScenario[]): string {\n  const lines: string[] = [];\n  let i = 0;\n  while (i < scenarios.length) {\n    const outlineName = scenarios[i].outline?.name;\n    if (outlineName === undefined) {\n      lines.push(testLine(scenarios[i], i, \"  \"));\n      i += 1;\n      continue;\n    }\n    lines.push(`  describe(${JSON.stringify(outlineName)}, () => {`);\n    while (i < scenarios.length && scenarios[i].outline?.name === outlineName) {\n      lines.push(testLine(scenarios[i], i, \"    \"));\n      i += 1;\n    }\n    lines.push(`  });`);\n  }\n  return lines.join(\"\\n\");\n}\n\nfunction toSpecifier(p: string): string {\n  // Absolute filesystem paths must be POSIX-style for the generated imports;\n  // bare package specifiers are emitted verbatim.\n  return path.isAbsolute(p) ? p.split(path.sep).join(\"/\") : p;\n}\n\nasync function resolveSteps(\n  steps: string | string[],\n  root: string\n): Promise<string[]> {\n  const patterns = Array.isArray(steps) ? steps : [steps];\n  const files = new Set<string>();\n  for (const pattern of patterns) {\n    for await (const file of glob(pattern, { cwd: root })) {\n      files.add(path.resolve(root, file));\n    }\n  }\n  return [...files];\n}\n\n/**\n * Vite/Vitest plugin: compiles each `.feature` file into a test module so\n * scenarios show up as native Vitest tests (watch mode, --ui, per-scenario\n * tasks, the lot). The transform injects imports of the step modules so that\n * (a) steps self-register into the same registry the engine reads, and\n * (b) Vite's HMR graph invalidates the feature test when a step file changes.\n */\nexport function stepForge(options: StepForgeOptions = {}): VitePlugin {\n  const featuresGlobs = toArray(options.features ?? DEFAULT_FEATURES);\n  const stepsGlob = options.steps ?? DEFAULT_STEPS;\n  const runtimeModule = options.runtimeModule ?? DEFAULT_RUNTIME_MODULE;\n  const coreModule = options.coreModule ?? DEFAULT_CORE_MODULE;\n  let root = process.cwd();\n\n  return {\n    name: \"step-forge\",\n    enforce: \"pre\",\n    config() {\n      return { test: { include: featuresGlobs } };\n    },\n    configResolved(config) {\n      root = config.root;\n    },\n    async transform(code, id) {\n      if (!id.endsWith(\".feature\")) return;\n\n      const scenarios = parseFeatureContent(code, id);\n      const featureName =\n        /^\\s*Feature:\\s*(.+)$/m.exec(code)?.[1]?.trim() ?? path.basename(id);\n      const stepFiles = await resolveSteps(stepsGlob, root);\n\n      const stepImports = stepFiles\n        .map(f => `import ${JSON.stringify(toSpecifier(f))};`)\n        .join(\"\\n\");\n\n      // World factory: an explicit `world` module, or a fresh BasicWorld.\n      const worldImport = options.world\n        ? `import __makeWorld from ${JSON.stringify(\n            toSpecifier(path.resolve(root, options.world))\n          )};`\n        : `import { BasicWorld } from ${JSON.stringify(coreModule)};\\n` +\n          `const __makeWorld = () => new BasicWorld();`;\n\n      const tests = generateTests(scenarios);\n\n      const generated = `\nimport { describe, test, beforeAll, afterAll } from \"vitest\";\nimport { runScenario, globalRegistry, runHooks, ensureGlobalHooks } from ${JSON.stringify(\n        runtimeModule\n      )};\n${worldImport}\n${stepImports}\n\nconst __scenarios = ${JSON.stringify(scenarios)};\n\ndescribe(${JSON.stringify(featureName)}, () => {\n  // Global before-hooks fire once per worker, ahead of feature hooks.\n  beforeAll(() => ensureGlobalHooks());\n  beforeAll(() => runHooks(\"feature\", \"before\"));\n  afterAll(() => runHooks(\"feature\", \"after\"));\n${tests}\n});\n`;\n      return { code: generated, map: null };\n    },\n  };\n}\n\n/**\n * One-line Vitest config preset. Drop this in `vitest.config.ts`:\n *\n * ```ts\n * import { defineStepForgeConfig } from \"@step-forge/step-forge/vitest\";\n * export default defineStepForgeConfig({ world: \"./support/world.ts\" });\n * ```\n *\n * Runs `**​/*.feature` as native tests, auto-discovers `**​/*.steps.ts`, and\n * defaults the world to `BasicWorld`. Override any Vitest option via `test`.\n */\nexport function defineStepForgeConfig(\n  options: StepForgeOptions & { test?: Record<string, unknown> } = {}\n) {\n  const { test, ...pluginOptions } = options;\n  const featuresGlobs = toArray(pluginOptions.features ?? DEFAULT_FEATURES);\n  return {\n    plugins: [stepForge(pluginOptions)],\n    test: { include: featuresGlobs, ...test },\n  };\n}\n"],"mappings":";;;;AAgDA,MAAM,gBAAgB;AACtB,MAAM,mBAAmB;AACzB,MAAM,yBAAyB;AAC/B,MAAM,sBAAsB;AAE5B,SAAS,QAAW,OAAqB;CACvC,OAAO,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK;AAC9C;;;;;;AAOA,SAAS,OAAO,MAAwB;CACtC,IAAI,KAAK,SAAS,OAAO,GAAG,OAAO;CACnC,IAAI,KAAK,SAAS,OAAO,GAAG,OAAO;CACnC,OAAO;AACT;;AAGA,SAAS,SACP,UACA,OACA,QACQ;CACR,OACE,GAAG,SAAS,OAAO,SAAS,IAAI,EAAE,GAAG,KAAK,UAAU,SAAS,IAAI,EAAE,kCACxC,MAAM;AAErC;;;;;;;AAQA,SAAS,cAAc,WAAqC;CAC1D,MAAM,QAAkB,CAAC;CACzB,IAAI,IAAI;CACR,OAAO,IAAI,UAAU,QAAQ;EAC3B,MAAM,cAAc,UAAU,EAAE,CAAC,SAAS;EAC1C,IAAI,gBAAgB,KAAA,GAAW;GAC7B,MAAM,KAAK,SAAS,UAAU,IAAI,GAAG,IAAI,CAAC;GAC1C,KAAK;GACL;EACF;EACA,MAAM,KAAK,cAAc,KAAK,UAAU,WAAW,EAAE,UAAU;EAC/D,OAAO,IAAI,UAAU,UAAU,UAAU,EAAE,CAAC,SAAS,SAAS,aAAa;GACzE,MAAM,KAAK,SAAS,UAAU,IAAI,GAAG,MAAM,CAAC;GAC5C,KAAK;EACP;EACA,MAAM,KAAK,OAAO;CACpB;CACA,OAAO,MAAM,KAAK,IAAI;AACxB;AAEA,SAAS,YAAY,GAAmB;CAGtC,OAAO,KAAK,WAAW,CAAC,IAAI,EAAE,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,IAAI;AAC5D;AAEA,eAAe,aACb,OACA,MACmB;CACnB,MAAM,WAAW,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK;CACtD,MAAM,wBAAQ,IAAI,IAAY;CAC9B,KAAK,MAAM,WAAW,UACpB,WAAW,MAAM,QAAQ,KAAK,SAAS,EAAE,KAAK,KAAK,CAAC,GAClD,MAAM,IAAI,KAAK,QAAQ,MAAM,IAAI,CAAC;CAGtC,OAAO,CAAC,GAAG,KAAK;AAClB;;;;;;;;AASA,SAAgB,UAAU,UAA4B,CAAC,GAAe;CACpE,MAAM,gBAAgB,QAAQ,QAAQ,YAAY,gBAAgB;CAClE,MAAM,YAAY,QAAQ,SAAS;CACnC,MAAM,gBAAgB,QAAQ,iBAAiB;CAC/C,MAAM,aAAa,QAAQ,cAAc;CACzC,IAAI,OAAO,QAAQ,IAAI;CAEvB,OAAO;EACL,MAAM;EACN,SAAS;EACT,SAAS;GACP,OAAO,EAAE,MAAM,EAAE,SAAS,cAAc,EAAE;EAC5C;EACA,eAAe,QAAQ;GACrB,OAAO,OAAO;EAChB;EACA,MAAM,UAAU,MAAM,IAAI;GACxB,IAAI,CAAC,GAAG,SAAS,UAAU,GAAG;GAE9B,MAAM,YAAY,oBAAoB,MAAM,EAAE;GAC9C,MAAM,cACJ,wBAAwB,KAAK,IAAI,CAAC,GAAG,EAAE,EAAE,KAAK,KAAK,KAAK,SAAS,EAAE;GAGrE,MAAM,eAAc,MAFI,aAAa,WAAW,IAAI,EAAA,CAGjD,KAAI,MAAK,UAAU,KAAK,UAAU,YAAY,CAAC,CAAC,EAAE,EAAE,CAAC,CACrD,KAAK,IAAI;GAGZ,MAAM,cAAc,QAAQ,QACxB,2BAA2B,KAAK,UAC9B,YAAY,KAAK,QAAQ,MAAM,QAAQ,KAAK,CAAC,CAC/C,EAAE,KACF,8BAA8B,KAAK,UAAU,UAAU,EAAE;GAG7D,MAAM,QAAQ,cAAc,SAAS;GAoBrC,OAAO;IAAE,MAAM;;2EAhBsD,KAAK,UACxE,aACF,EAAE;EACN,YAAY;EACZ,YAAY;;sBAEQ,KAAK,UAAU,SAAS,EAAE;;WAErC,KAAK,UAAU,WAAW,EAAE;;;;;EAKrC,MAAM;;;IAGwB,KAAK;GAAK;EACtC;CACF;AACF;;;;;;;;;;;;AAaA,SAAgB,sBACd,UAAiE,CAAC,GAClE;CACA,MAAM,EAAE,MAAM,GAAG,kBAAkB;CACnC,MAAM,gBAAgB,QAAQ,cAAc,YAAY,gBAAgB;CACxE,OAAO;EACL,SAAS,CAAC,UAAU,aAAa,CAAC;EAClC,MAAM;GAAE,SAAS;GAAe,GAAG;EAAK;CAC1C;AACF"}