@toolstackhq/create-qa-patterns 1.0.12 → 1.0.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toolstackhq/create-qa-patterns",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "description": "CLI for generating QA framework templates.",
   "license": "MIT",
   "repository": {

package/templates/cypress-template/README.md

@@ -13,6 +13,7 @@ This is a Cypress + TypeScript automation framework template for a small determi
 - [Reports and artifacts](#reports-and-artifacts)
 - [Add a new test](#add-a-new-test)
 - [Extend the framework](#extend-the-framework)
+- [Template upgrades](#template-upgrades)
 - [CI](#ci)
 
 ## Feature set
@@ -21,9 +22,11 @@ This is a Cypress + TypeScript automation framework template for a small determi
 - Cypress-native custom commands for common user actions
 - page modules that own selectors and keep spec files focused on behavior
 - generic `DataFactory` helpers for repeatable UI data
+- folder-level `README.md` guides and file-header comments for easier onboarding
 - multi-environment runtime config with `dev`, `staging`, and `prod`
 - env-based secret resolution with a replaceable `SecretProvider`
 - built-in screenshots and videos on failure
+- optional single-file Allure report
 - ESLint rules that keep selectors out of spec files
 - bundled deterministic UI demo app and GitHub Actions workflow
 
@@ -79,6 +82,12 @@ If you want to run the demo app manually for debugging:
 npm run demo:ui
 ```
 
+If you want an Allure report after a run:
+
+```bash
+npm run report:allure
+```
+
 Default local values:
 
 - UI base URL: `http://127.0.0.1:3000`
@@ -134,6 +143,7 @@ npm run demo:ui
 npm run lint
 npm run typecheck
 npm run cy:run
+npm run report:allure
 ```
 
 ## Reports and artifacts
@@ -142,9 +152,13 @@ Outputs:
 
 - Cypress videos: `reports/videos`
 - Cypress screenshots: `reports/screenshots`
+- Allure single file: `reports/allure/index.html`
+- raw Allure results: `allure-results`
 
 The default Cypress terminal output is kept as the main reporting path.
 
+If you only want Cypress's built-in output, remove the `allureCypress(...)` call in `cypress.config.ts`.
+
 ## Add a new test
 
 Create tests under `cypress/e2e/`.
@@ -184,6 +198,24 @@ Recommended rules:
 - use Cypress commands for workflows, not giant helper classes
 - keep the data layer generic until the project really needs domain-specific factories
 
+## Template upgrades
+
+This project includes a `.qa-patterns.json` metadata file so future CLI versions can compare the current project against the managed template baseline.
+
+Check for available safe updates:
+
+```bash
+npx -y @toolstackhq/create-qa-patterns upgrade check .
+```
+
+Apply only safe managed-file updates:
+
+```bash
+npx -y @toolstackhq/create-qa-patterns upgrade apply --safe .
+```
+
+The upgrade flow is conservative. It updates framework infrastructure such as config, scripts, workflows, and package metadata when those files are still unchanged from the generated baseline. If you changed a managed file yourself, the CLI reports a conflict instead of overwriting it.
+
 ## CI
 
 The included workflow lives at:

package/templates/cypress-template/allurerc.mjs

@@ -0,0 +1,10 @@
+export default {
+  name: "qa-patterns Cypress Template",
+  plugins: {
+    awesome: {
+      options: {
+        singleFile: true
+      }
+    }
+  }
+};

package/templates/cypress-template/config/README.md

@@ -0,0 +1,5 @@
+# Config
+
+This folder resolves environment-specific values for the Cypress template.
+
+- Keep defaults, secret lookup, and runtime parsing here.

package/templates/cypress-template/config/environments.ts

@@ -1,3 +1,4 @@
+// Defines the built-in environment defaults used when env vars are not provided.
 import type { TestEnvironment } from "./test-env";
 
 type EnvironmentDefaults = {

package/templates/cypress-template/config/runtime-config.ts

@@ -1,3 +1,4 @@
+// Builds the runtime configuration object that tests and fixtures consume.
 import path from "node:path";
 
 import dotenv from "dotenv";

package/templates/cypress-template/config/secret-manager.ts

@@ -1,3 +1,4 @@
+// Minimal secret abstraction so env-based secrets can later be replaced cleanly.
 import type { TestEnvironment } from "./test-env";
 
 export interface SecretProvider {

package/templates/cypress-template/cypress/e2e/README.md

@@ -0,0 +1,6 @@
+# E2E Specs
+
+This folder holds Cypress scenarios.
+
+- Keep specs focused on workflow validation.
+- Use custom commands and page modules instead of raw selectors.

package/templates/cypress-template/cypress/e2e/ui-journey.cy.ts

@@ -1,3 +1,4 @@
+// Starter Cypress scenario that demonstrates the preferred spec style for this template.
 import { DataFactory } from "../support/data/data-factory";
 import { loadAppConfig } from "../support/app-config";
 import { peoplePage } from "../support/pages/people-page";

package/templates/cypress-template/cypress/support/README.md

@@ -0,0 +1,5 @@
+# Support
+
+This folder contains the reusable Cypress support layer.
+
+- Put custom commands, shared config, page modules, and test data helpers here.

package/templates/cypress-template/cypress/support/app-config.ts

@@ -1,3 +1,4 @@
+// Reads runtime values from Cypress env so specs stay clean and framework-aware.
 type Credentials = {
   username: string;
   password: string;

package/templates/cypress-template/cypress/support/commands.ts

@@ -1,3 +1,4 @@
+// Registers the custom Cypress commands that the starter specs rely on.
 import type { PersonRecord } from "./data/data-factory";
 import { loginPage } from "./pages/login-page";
 import { peoplePage } from "./pages/people-page";

package/templates/cypress-template/cypress/support/data/README.md

@@ -0,0 +1,5 @@
+# Data
+
+This folder holds generic test data builders and generators.
+
+- Keep data simple and readable for starter projects.

package/templates/cypress-template/cypress/support/data/data-factory.ts

@@ -1,3 +1,4 @@
+// Generic data builders that keep tests readable and deterministic.
 import { createSeededFaker } from "./seeded-faker";
 import { IdGenerator } from "./id-generator";
 

package/templates/cypress-template/cypress/support/data/id-generator.ts

@@ -1,3 +1,4 @@
+// Deterministic id generator for repeatable local and CI runs.
 export class IdGenerator {
   private readonly counters = new Map<string, number>();
 

package/templates/cypress-template/cypress/support/data/seeded-faker.ts

@@ -1,3 +1,4 @@
+// Seeded faker wrapper so generated values stay stable for a given run id.
 import { Faker, en } from "@faker-js/faker";
 
 function hashSeed(value: string): number {

package/templates/cypress-template/cypress/support/e2e.ts

@@ -1 +1,2 @@
+import "allure-cypress";
 import "./commands";

package/templates/cypress-template/cypress/support/pages/README.md

@@ -0,0 +1,5 @@
+# Pages
+
+This folder holds Cypress page modules.
+
+- Keep selectors and reusable UI actions here instead of in spec files.

package/templates/cypress-template/cypress/support/pages/login-page.ts

@@ -1,3 +1,4 @@
+// Page module for the login screen used by custom Cypress commands.
 export const loginPage = {
   visit(): Cypress.Chainable {
     return cy.visit("/login");

package/templates/cypress-template/cypress/support/pages/people-page.ts

@@ -1,3 +1,4 @@
+// Page module for the people screen used in the starter Cypress journey.
 import type { PersonRecord } from "../data/data-factory";
 
 export const peoplePage = {

package/templates/cypress-template/cypress.config.ts

@@ -1,3 +1,7 @@
+// Central Cypress configuration for specs, retries, artifacts, and runtime env values.
+import * as os from "node:os";
+
+import { allureCypress } from "allure-cypress/reporter";
 import { defineConfig } from "cypress";
 
 import { loadRuntimeConfig } from "./config/runtime-config";
@@ -9,7 +13,19 @@ export default defineConfig({
     baseUrl: runtimeConfig.uiBaseUrl,
     specPattern: "cypress/e2e/**/*.cy.ts",
     supportFile: "cypress/support/e2e.ts",
-    setupNodeEvents(_on, config) {
+    setupNodeEvents(on, config) {
+      // Keep Cypress terminal output as the default path most users expect.
+      // Remove the Allure line below if you prefer to stay with Cypress output only.
+      allureCypress(on, config, {
+        resultsDir: "allure-results",
+        environmentInfo: {
+          os_platform: os.platform(),
+          os_release: os.release(),
+          os_version: os.version(),
+          node_version: process.version
+        }
+      });
+
       config.env = {
         ...config.env,
         testEnv: runtimeConfig.testEnv,

package/templates/cypress-template/eslint.config.mjs

@@ -22,7 +22,7 @@ const nodeGlobals = {
 
 export default [
   {
-    ignores: ["demo-apps/**", "node_modules/**", "reports/**"]
+    ignores: ["demo-apps/**", "node_modules/**", "reports/**", "allure-results/**", "allure-report/**"]
   },
   js.configs.recommended,
   {