@toolstackhq/create-qa-patterns 1.0.6 → 1.0.7

package/templates/cypress-template/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@toolstackhq/cypress-template",
+  "version": "1.0.0",
+  "private": true,
+  "description": "Production-ready Cypress automation framework template with a deterministic UI starter app.",
+  "scripts": {
+    "test": "node ./scripts/run-cypress.mjs run",
+    "open": "node ./scripts/run-cypress.mjs open",
+    "cy:run": "cypress run",
+    "cy:open": "cypress open",
+    "demo:ui": "node ./demo-apps/ui-demo-app/src/server.js",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "ci": "bash ./scripts/run-tests.sh"
+  },
+  "dependencies": {
+    "@faker-js/faker": "^8.4.1",
+    "dotenv": "^16.4.5",
+    "express": "^4.21.0",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.12.0",
+    "@types/node": "^22.7.4",
+    "@typescript-eslint/eslint-plugin": "^8.8.1",
+    "@typescript-eslint/parser": "^8.8.1",
+    "cypress": "^13.17.0",
+    "eslint": "^9.12.0",
+    "typescript": "^5.6.2"
+  }
+}

package/templates/cypress-template/scripts/run-cypress.mjs

@@ -0,0 +1,105 @@
+#!/usr/bin/env node
+
+import process from "node:process";
+import path from "node:path";
+import { spawn } from "node:child_process";
+
+import dotenv from "dotenv";
+
+const mode = process.argv[2] ?? "run";
+const args = process.argv.slice(3);
+const cwd = process.cwd();
+const healthUrl = "http://127.0.0.1:3000/health";
+const environment = process.env.TEST_ENV ?? "dev";
+const environmentDefaults = {
+  dev: "http://127.0.0.1:3000",
+  staging: "https://staging-ui.example.internal",
+  prod: "https://ui.example.internal"
+};
+
+dotenv.config({ path: path.resolve(cwd, ".env") });
+dotenv.config({ path: path.resolve(cwd, `.env.${environment}`), override: true });
+
+const uiBaseUrl =
+  process.env[`${environment.toUpperCase()}_UI_BASE_URL`] ??
+  process.env.UI_BASE_URL ??
+  environmentDefaults[environment] ??
+  environmentDefaults.dev;
+
+const shouldAutoStartDemoApp =
+  environment === "dev" &&
+  uiBaseUrl === environmentDefaults.dev &&
+  process.env.CY_DISABLE_LOCAL_DEMO_APP !== "true";
+
+function getCommandName(command) {
+  return process.platform === "win32" ? `${command}.cmd` : command;
+}
+
+function spawnCommand(command, commandArgs, options = {}) {
+  return spawn(getCommandName(command), commandArgs, {
+    cwd,
+    stdio: "inherit",
+    ...options
+  });
+}
+
+async function waitForHealthcheck(url, timeoutMs = 30_000) {
+  const start = Date.now();
+
+  while (Date.now() - start < timeoutMs) {
+    try {
+      const response = await globalThis.fetch(url);
+      if (response.ok) {
+        return;
+      }
+    } catch {
+      // Service is not ready yet.
+    }
+
+    await new Promise((resolve) => globalThis.setTimeout(resolve, 500));
+  }
+
+  throw new Error(`Timed out waiting for ${url}`);
+}
+
+function killChild(child) {
+  if (!child || child.killed) {
+    return;
+  }
+
+  child.kill("SIGTERM");
+}
+
+async function run() {
+  let demoAppProcess;
+
+  try {
+    if (shouldAutoStartDemoApp) {
+      demoAppProcess = spawnCommand("npm", ["run", "demo:ui"]);
+      await waitForHealthcheck(healthUrl);
+    }
+
+    const cypressCommand = mode === "open" ? "open" : "run";
+    const cypressProcess = spawnCommand("npx", ["cypress", cypressCommand, ...args]);
+
+    const exitCode = await new Promise((resolve) => {
+      cypressProcess.on("close", resolve);
+      cypressProcess.on("error", () => resolve(1));
+    });
+
+    if (exitCode !== 0) {
+      process.exit(Number(exitCode) || 1);
+    }
+  } finally {
+    killChild(demoAppProcess);
+  }
+}
+
+for (const signal of ["SIGINT", "SIGTERM"]) {
+  process.on(signal, () => process.exit(1));
+}
+
+run().catch((error) => {
+  process.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
+  process.exit(1);
+});

package/templates/cypress-template/scripts/run-tests.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+npm run lint
+npm run typecheck
+npx cypress run "$@"

package/templates/cypress-template/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022", "DOM"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "noEmit": true,
+    "types": ["cypress", "node"]
+  },
+  "include": ["cypress/**/*.ts", "cypress/**/*.d.ts", "config/**/*.ts", "cypress.config.ts"]
+}