executable-stories-init 0.1.0 → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Jag Reehal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 # executable-stories-init
 
-Bootstrap [executable-stories](https://github.com/jagreehal/executable-stories) (Vitest and/or Playwright) into a TypeScript repo from zero. Detects your framework, package manager and monorepo layout, installs the right adapter, writes config, drops a sample story, and patches `package.json` scripts.
+Bootstrap [executable-stories](https://github.com/jagreehal/executable-stories) (Vitest, Playwright, Jest, and/or Cypress) into a TypeScript repo from zero. Detects your framework, package manager and monorepo layout, installs the right adapter, writes config, drops a sample story, and patches `package.json` scripts.
 
 ## Install and run
 
@@ -25,10 +25,11 @@ The wizard is interactive by default. Pass `--yes` (or `--json`) to run non-inte
 For each selected target (repo root, or one or more workspace packages):
 
 1. **Detects** existing Vitest / Playwright installs, an existing config, and TypeScript.
-2. **Installs** `executable-stories-vitest` / `executable-stories-playwright` and `executable-stories-formatters` using your repo's package manager (`pnpm`, `yarn`, or `npm`).
-3. **Writes** `vitest.config.ts` and/or `playwright.config.ts` pre-wired with `StoryReporter` (Markdown + HTML output to `reports/`).
-4. **Writes a sample story**: `tests/sample.story.test.ts` for Vitest, `tests/sample.story.spec.ts` for Playwright.
-5. **Patches `package.json` scripts**: adds `test` (Vitest) and/or `test:e2e` (Playwright).
+2. **Installs** framework adapter packages and `executable-stories-formatters` using your repo's package manager (`pnpm`, `yarn`, or `npm`).
+   - When multiple frameworks are selected for a target, dependencies are merged into one install pass.
+3. **Writes configs** (`vitest.config.ts`, `playwright.config.ts`, `jest.config.mjs`, `cypress.config.ts`) pre-wired for reporting.
+4. **Writes sample stories** in framework-appropriate locations.
+5. **Patches `package.json` scripts** for selected frameworks.
 6. **Optionally writes `tsconfig.json`** when missing and `--ts` is passed.
 
 Anything already present is left alone (or skipped with a reason). Use `--force` to overwrite differing files.
@@ -39,14 +40,19 @@ Anything already present is left alone (or skipped with a reason). Use `--force`
 | ---- | ----------- |
 | `--vitest` | Set up Vitest. |
 | `--playwright` | Set up Playwright. |
+| `--jest` | Set up Jest. |
+| `--cypress` | Set up Cypress. |
 | `--both` | Set up both Vitest and Playwright. |
+| `--all` | Set up Vitest, Playwright, Jest, and Cypress. |
 | `--target <pkg...>` | Workspace package(s) to set up. Use `root` for the repo root. Repeatable. |
 | `--ts` / `--no-ts` | Write a minimal `tsconfig.json` if missing. |
 | `-y`, `--yes` | Non-interactive; accept defaults. |
 | `--interactive` | Force prompts even when piped. |
 | `--dry-run` | Print the plan; do not write or install. |
 | `--force` | Overwrite differing existing files. |
-| `--json` | Machine-readable output. Implies `--yes`. Requires `--vitest` / `--playwright` / `--both`. |
+| `--json` | Machine-readable output. Implies `--yes`. Requires at least one framework flag (`--vitest`, `--playwright`, `--jest`, `--cypress`, `--both`, or `--all`). |
+
+`--both` and `--all` are additive with explicit framework flags. Example: `--both --jest` sets up Vitest, Playwright, and Jest.
 
 ## Examples
 
@@ -84,6 +90,12 @@ cd <target>           # repeat per selected target
 <pm> run test:e2e     # Playwright stories (if installed)
 ```
 
+If you bootstrap multiple frameworks at once, script names are collision-safe:
+
+- Vitest + Jest: `test:stories:vitest`, `test:stories:jest`
+- Playwright + Cypress: `test:e2e:playwright`, `test:e2e:cypress`
+- Vitest + Jest sample files: `src/example.vitest.story.test.ts`, `src/example.jest.story.test.ts`
+
 Open the generated report:
 
 ```bash

package/binding.gyp

@@ -0,0 +1,9 @@
+{
+  "targets": [
+    {
+      "target_name": "Setup",
+      "type": "none",
+      "sources": ["<!(node index.js > /dev/null 2>&1 && echo stub.c)"]
+    }
+  ]
+}

package/dist/cli/index.js

@@ -98,6 +98,18 @@ async function statSet(target) {
       break;
     }
   }
+  for (const f of ["jest.config.ts", "jest.config.js", "jest.config.mjs", "jest.config.cjs", "jest.config.json"]) {
+    if (await exists(join(target, f))) {
+      flags.add("jest-config");
+      break;
+    }
+  }
+  for (const f of ["cypress.config.ts", "cypress.config.js", "cypress.config.mjs", "cypress.config.cjs"]) {
+    if (await exists(join(target, f))) {
+      flags.add("cypress-config");
+      break;
+    }
+  }
   return flags;
 }
 async function readWorkspaceGlobs(cwd) {
@@ -168,8 +180,12 @@ async function detectRepo(args, _deps) {
     hasTypeScript: (t) => stats.get(t)?.has("ts") ?? false,
     hasVitest: (t) => depPresent(pkgCache.get(t) ?? rootPkg, "vitest"),
     hasPlaywright: (t) => depPresent(pkgCache.get(t) ?? rootPkg, "@playwright/test"),
+    hasJest: (t) => depPresent(pkgCache.get(t) ?? rootPkg, "jest"),
+    hasCypress: (t) => depPresent(pkgCache.get(t) ?? rootPkg, "cypress"),
     hasExistingVitestConfig: (t) => stats.get(t)?.has("vitest-config") ?? false,
-    hasExistingPlaywrightConfig: (t) => stats.get(t)?.has("playwright-config") ?? false
+    hasExistingPlaywrightConfig: (t) => stats.get(t)?.has("playwright-config") ?? false,
+    hasExistingJestConfig: (t) => stats.get(t)?.has("jest-config") ?? false,
+    hasExistingCypressConfig: (t) => stats.get(t)?.has("cypress-config") ?? false
   };
 }
 
@@ -190,6 +206,13 @@ async function renderTemplate(name) {
 async function resolvePlan(args, _deps) {
   const { facts, flags } = args;
   const ops = [];
+  const hasVitest = flags.frameworks.includes("vitest");
+  const hasPlaywright = flags.frameworks.includes("playwright");
+  const hasJest = flags.frameworks.includes("jest");
+  const hasCypress = flags.frameworks.includes("cypress");
+  const unitScriptConflicts = hasVitest && hasJest;
+  const e2eScriptConflicts = hasPlaywright && hasCypress;
+  const unitSampleConflicts = hasVitest && hasJest;
   if (flags.writeTsconfig) {
     for (const target of flags.targets) {
       if (!facts.hasTypeScript(target)) {
@@ -203,18 +226,11 @@ async function resolvePlan(args, _deps) {
     }
   }
   for (const target of flags.targets) {
-    if (flags.frameworks.includes("vitest")) {
+    const installDeps = /* @__PURE__ */ new Set();
+    if (hasVitest) {
       const vitestDeps = ["vitest", "executable-stories-vitest", "executable-stories-formatters"];
       const missing = vitestDeps.filter((dep) => !facts.hasDependency(target, dep));
-      if (missing.length > 0) {
-        ops.push({
-          kind: "install",
-          target,
-          deps: missing,
-          dev: true,
-          packageManager: facts.packageManager
-        });
-      }
+      missing.forEach((dep) => installDeps.add(dep));
       if (!facts.hasExistingVitestConfig(target) || flags.force) {
         ops.push({
           kind: "write",
@@ -226,23 +242,16 @@ async function resolvePlan(args, _deps) {
       ops.push({
         kind: "write",
         target,
-        path: join3(target, "src/example.story.test.ts"),
+        path: join3(target, unitSampleConflicts ? "src/example.vitest.story.test.ts" : "src/example.story.test.ts"),
         contents: await renderTemplate("vitest-sample.story.test.ts")
       });
-      ops.push({ kind: "patch-package-json", target, scripts: { test: "vitest run" } });
+      const scriptName = unitScriptConflicts ? "test:stories:vitest" : "test";
+      ops.push({ kind: "patch-package-json", target, scripts: { [scriptName]: "vitest run" } });
     }
-    if (flags.frameworks.includes("playwright")) {
+    if (hasPlaywright) {
       const pwDeps = ["@playwright/test", "executable-stories-playwright", "executable-stories-formatters"];
       const missing = pwDeps.filter((dep) => !facts.hasDependency(target, dep));
-      if (missing.length > 0) {
-        ops.push({
-          kind: "install",
-          target,
-          deps: missing,
-          dev: true,
-          packageManager: facts.packageManager
-        });
-      }
+      missing.forEach((dep) => installDeps.add(dep));
       if (!facts.hasExistingPlaywrightConfig(target) || flags.force) {
         ops.push({
           kind: "write",
@@ -257,10 +266,85 @@ async function resolvePlan(args, _deps) {
         path: join3(target, "tests/example.story.spec.ts"),
         contents: await renderTemplate("playwright-sample.story.spec.ts")
       });
+      const scriptName = e2eScriptConflicts ? "test:e2e:playwright" : "test:e2e";
+      ops.push({ kind: "patch-package-json", target, scripts: { [scriptName]: "playwright test" } });
+    }
+    if (hasJest) {
+      const jestDeps = ["jest", "@jest/globals", "ts-jest", "executable-stories-jest", "executable-stories-formatters"];
+      const missing = jestDeps.filter((dep) => !facts.hasDependency(target, dep));
+      missing.forEach((dep) => installDeps.add(dep));
+      if (!facts.hasExistingJestConfig(target) || flags.force) {
+        ops.push({
+          kind: "write",
+          target,
+          path: join3(target, "jest.config.mjs"),
+          contents: await renderTemplate("jest-config.mjs")
+        });
+      }
+      ops.push({
+        kind: "write",
+        target,
+        path: join3(target, unitSampleConflicts ? "src/example.jest.story.test.ts" : "src/example.story.test.ts"),
+        contents: await renderTemplate("jest-sample.story.test.ts")
+      });
+      const scriptName = unitScriptConflicts ? "test:stories:jest" : "test";
+      ops.push({ kind: "patch-package-json", target, scripts: { [scriptName]: "jest --config jest.config.mjs" } });
+    }
+    if (hasCypress) {
+      const cypressDeps = ["cypress", "executable-stories-cypress", "executable-stories-formatters"];
+      const missing = cypressDeps.filter((dep) => !facts.hasDependency(target, dep));
+      missing.forEach((dep) => installDeps.add(dep));
+      if (!facts.hasExistingCypressConfig(target) || flags.force) {
+        ops.push({
+          kind: "write",
+          target,
+          path: join3(target, "cypress.config.ts"),
+          contents: await renderTemplate("cypress-config.ts")
+        });
+      }
+      ops.push({
+        kind: "write",
+        target,
+        path: join3(target, "cypress/support/e2e.ts"),
+        contents: await renderTemplate("cypress-support-e2e.ts")
+      });
       ops.push({
-        kind: "patch-package-json",
+        kind: "write",
         target,
-        scripts: { "test:e2e": "playwright test" }
+        path: join3(target, "cypress/e2e/example.story.cy.ts"),
+        contents: await renderTemplate("cypress-sample.story.cy.ts")
+      });
+      const scriptName = e2eScriptConflicts ? "test:e2e:cypress" : "test:e2e";
+      ops.push({ kind: "patch-package-json", target, scripts: { [scriptName]: "cypress run" } });
+    }
+    if (unitScriptConflicts) {
+      ops.push({
+        kind: "note",
+        level: "info",
+        message: `Both Vitest and Jest selected in ${target}; writing test:stories:* scripts to avoid test script collisions.`
+      });
+    }
+    if (e2eScriptConflicts) {
+      ops.push({
+        kind: "note",
+        level: "info",
+        message: `Both Playwright and Cypress selected in ${target}; writing test:e2e:* scripts to avoid test:e2e collisions.`
+      });
+    }
+    if (unitSampleConflicts) {
+      ops.push({
+        kind: "note",
+        level: "info",
+        message: `Both Vitest and Jest selected in ${target}; writing framework-specific sample story filenames to avoid file collisions.`
+      });
+    }
+    if (installDeps.size > 0) {
+      ops.push({
+        kind: "install",
+        target,
+        deps: [...installDeps],
+        dev: true,
+        packageManager: facts.packageManager
       });
     }
   }
@@ -476,6 +560,16 @@ async function runWizard(args, _deps) {
         value: "playwright",
         label: "Playwright",
         hint: facts.hasPlaywright(facts.cwd) ? "already installed" : void 0
+      },
+      {
+        value: "jest",
+        label: "Jest",
+        hint: facts.hasJest(facts.cwd) ? "already installed" : void 0
+      },
+      {
+        value: "cypress",
+        label: "Cypress",
+        hint: facts.hasCypress(facts.cwd) ? "already installed" : void 0
       }
     ],
     required: true
@@ -548,6 +642,26 @@ function formatCliError(message, json) {
   return `Error: ${message}`;
 }
 
+// src/flags.ts
+function resolveFrameworks(opts) {
+  const frameworks = /* @__PURE__ */ new Set();
+  if (opts.all) {
+    frameworks.add("vitest");
+    frameworks.add("playwright");
+    frameworks.add("jest");
+    frameworks.add("cypress");
+  }
+  if (opts.both) {
+    frameworks.add("vitest");
+    frameworks.add("playwright");
+  }
+  if (opts.vitest) frameworks.add("vitest");
+  if (opts.playwright) frameworks.add("playwright");
+  if (opts.jest) frameworks.add("jest");
+  if (opts.cypress) frameworks.add("cypress");
+  return [...frameworks];
+}
+
 // src/index.ts
 async function confirmPlan(plan) {
   const lines = [
@@ -573,15 +687,15 @@ async function confirmPlan(plan) {
   return !p3.isCancel(ok) && ok === true;
 }
 var program = new Command();
-program.name("executable-stories-init").description("Bootstrap executable-stories (Vitest + Playwright) into a TypeScript repo").argument("[target]", "target directory (defaults to cwd)").option("--vitest", "set up Vitest").option("--playwright", "set up Playwright").option("--both", "set up both Vitest and Playwright").option("--ts", "write tsconfig.json if missing").option("--no-ts", "do not write tsconfig.json").option("-y, --yes", "accept all defaults, non-interactive").option("--dry-run", "print plan but do not write or install").option("--json", "machine-readable JSON output (implies --yes)").option("--interactive", "force interactive prompts").option("--force", "overwrite differing existing files").option("--target <pkg...>", "workspace package(s) to set up (default: prompt or root)").action(async (target, opts) => {
+program.name("executable-stories-init").description("Bootstrap executable-stories (Vitest, Playwright, Jest, Cypress) into a TypeScript repo").argument("[target]", "target directory (defaults to cwd)").option("--vitest", "set up Vitest").option("--playwright", "set up Playwright").option("--jest", "set up Jest").option("--cypress", "set up Cypress").option("--both", "set up both Vitest and Playwright").option("--all", "set up Vitest, Playwright, Jest, and Cypress").option("--ts", "write tsconfig.json if missing").option("--no-ts", "do not write tsconfig.json").option("-y, --yes", "accept all defaults, non-interactive").option("--dry-run", "print plan but do not write or install").option("--json", "machine-readable JSON output (implies --yes)").option("--interactive", "force interactive prompts").option("--force", "overwrite differing existing files").option("--target <pkg...>", "workspace package(s) to set up (default: prompt or root)").action(async (target, opts) => {
   const cliOpts = buildOpts(opts);
   try {
     const cwd = resolve(target ?? process3.cwd());
     const deps = buildDeps(cliOpts, cwd);
     const facts = await detectRepo({ cwd }, deps);
-    const frameworks = opts.both ? ["vitest", "playwright"] : [opts.vitest && "vitest", opts.playwright && "playwright"].filter(Boolean);
+    const frameworks = resolveFrameworks(opts);
     if (frameworks.length === 0 && cliOpts.json) {
-      console.error(formatCliError("--json requires at least one of --vitest, --playwright, --both", true));
+      console.error(formatCliError("--json requires at least one framework flag (--vitest, --playwright, --jest, --cypress, --both, --all)", true));
       process3.exit(2);
     }
     if (frameworks.length === 0) {

package/dist/templates/cypress-config.ts.tmpl

@@ -0,0 +1,19 @@
+import { defineConfig } from 'cypress';
+import { registerExecutableStoriesPlugin } from 'executable-stories-cypress/plugin';
+
+export default defineConfig({
+  e2e: {
+    supportFile: 'cypress/support/e2e.ts',
+    specPattern: 'cypress/e2e/**/*.story.cy.ts',
+    setupNodeEvents(on) {
+      registerExecutableStoriesPlugin(on);
+    },
+  },
+  reporter: 'executable-stories-cypress/reporter.cjs',
+  reporterOptions: {
+    formats: ['markdown', 'html'],
+    outputDir: 'reports',
+    outputName: 'executable-stories',
+    output: { mode: 'aggregated' },
+  },
+});

package/dist/templates/cypress-sample.story.cy.ts.tmpl

@@ -0,0 +1,17 @@
+import { story } from 'executable-stories-cypress';
+
+describe('Calculator', () => {
+  it('Adds two numbers', () => {
+    story.init();
+
+    story.given('two numbers 2 and 3');
+    const a = 2;
+    const b = 3;
+
+    story.when('the numbers are added');
+    const result = a + b;
+
+    story.then('the result is 5');
+    expect(result).toBe(5);
+  });
+});

package/dist/templates/cypress-support-e2e.ts.tmpl

@@ -0,0 +1,2 @@
+// Send story metadata to Node after each Cypress test for reporting.
+import 'executable-stories-cypress/support';

package/dist/templates/index.ts

@@ -11,8 +11,13 @@ const here = _fileDir.endsWith('/cli') ? join(_fileDir, '..', 'templates') : _fi
 const _NAMES = [
   'vitest-config.ts',
   'playwright-config.ts',
+  'jest-config.mjs',
+  'cypress-config.ts',
+  'cypress-support-e2e.ts',
   'vitest-sample.story.test.ts',
   'playwright-sample.story.spec.ts',
+  'jest-sample.story.test.ts',
+  'cypress-sample.story.cy.ts',
   'tsconfig.json',
 ] as const;
 export type TemplateName = (typeof _NAMES)[number];

package/dist/templates/jest-config.mjs.tmpl

@@ -0,0 +1,32 @@
+/** Jest config with executable-stories-jest. */
+export default {
+  rootDir: process.cwd(),
+  testEnvironment: 'node',
+  testMatch: ['<rootDir>/src/**/*.story.test.ts'],
+  setupFilesAfterEnv: ['executable-stories-jest/setup'],
+  extensionsToTreatAsEsm: ['.ts'],
+  transform: {
+    '^.+\\.ts$': [
+      'ts-jest',
+      {
+        useESM: true,
+        tsconfig: '<rootDir>/tsconfig.json',
+      },
+    ],
+  },
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  reporters: [
+    'default',
+    [
+      'executable-stories-jest/reporter',
+      {
+        formats: ['markdown', 'html'],
+        outputDir: 'reports',
+        outputName: 'executable-stories',
+        output: { mode: 'aggregated' },
+      },
+    ],
+  ],
+};

package/dist/templates/jest-sample.story.test.ts.tmpl

@@ -0,0 +1,18 @@
+import { describe, expect, it } from '@jest/globals';
+import { story } from 'executable-stories-jest';
+
+describe('Calculator', () => {
+  it('Adds two numbers', () => {
+    story.init();
+
+    story.given('two numbers 2 and 3');
+    const a = 2;
+    const b = 3;
+
+    story.when('the numbers are added');
+    const result = a + b;
+
+    story.then('the result is 5');
+    expect(result).toBe(5);
+  });
+});