playwright-toolbox 1.0.0

package/.changeset/README.md

@@ -0,0 +1,9 @@
+# Changesets
+
+This directory stores release notes for independent package versioning.
+
+Workflow:
+
+1. `npm run changeset`
+2. `npm run version-packages`
+3. `npm run release`

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/README.md

@@ -0,0 +1,90 @@
+# Playwright Toolbox Monorepo
+
+This repository is an npm workspaces monorepo with three independent packages:
+
+1. `@acahet/pw-standard`
+2. `@acahet/playwright-config`
+3. `@acahet/playwright-history-dashboard`
+
+## Workspace layout
+
+-   `packages/pw-standard`
+-   `packages/playwright-config`
+-   `packages/playwright-history-dashboard`
+
+## Package usage
+
+### 1) @acahet/pw-standard
+
+Use for Playwright ESLint rules, base abstractions, and tsconfig presets.
+
+```bash
+npm i -D @acahet/pw-standard
+```
+
+### 2) @acahet/playwright-config
+
+Use for extracted Playwright config presets.
+
+```bash
+npm i -D @acahet/playwright-config
+```
+
+### 3) @acahet/playwright-history-dashboard
+
+Use for local run history tracking and static dashboard visualization.
+
+```bash
+npm i -D @acahet/playwright-history-dashboard
+```
+
+See package-specific docs:
+
+-   `packages/pw-standard/README.md`
+-   `packages/playwright-config/README.md`
+-   `packages/playwright-history-dashboard/README.md`
+
+## Local development
+
+Run from monorepo root:
+
+```bash
+npm install
+npm run build
+npm test
+npm run lint
+```
+
+## Independent versioning and release
+
+Changesets is configured for independent package versioning.
+
+```bash
+npm run changeset
+npm run version-packages
+npm run release
+```
+
+## Migration notes
+
+### Import migration
+
+-   Previous: `@acahet/pw-standard/playwright`
+-   New preferred: `@acahet/playwright-config`
+-   Compatibility: `@acahet/pw-standard/playwright` is still re-exported for transition safety.
+
+### Folder migration
+
+-   Previous rules source: `playwright-rules/src`
+-   New rules source: `packages/pw-standard/src`
+
+-   Previous rules tests: `playwright-rules/tests`
+-   New rules tests: `packages/pw-standard/tests`
+
+-   Previous dashboard folder: `playwright-history-dashboard/`
+-   New dashboard folder: `packages/playwright-history-dashboard/`
+
+### Release migration
+
+-   Previous root package publish model: one publishable root package plus one nested package.
+-   New model: three independent workspace packages with Changesets-managed versioning.

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "playwright-toolbox",
+  "private": false,
+  "version": "1.0.0",
+  "description": "Workspace monorepo for Playwright packages",
+  "workspaces": [
+    "packages/*"
+  ],
+  "scripts": {
+    "build": "npm run --workspaces --if-present build",
+    "build:watch": "npm run --workspaces --if-present build:watch",
+    "test": "npm run --workspaces --if-present test",
+    "test:watch": "npm run --workspaces --if-present test:watch",
+    "test:coverage": "npm run --workspaces --if-present test:coverage",
+    "lint": "npm run --workspaces --if-present lint",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "changeset publish"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.27.8"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/packages/playwright-config/CHANGELOG.md

@@ -0,0 +1,21 @@
+# @acahet/playwright-config
+
+## 1.2.0
+
+### Minor Changes
+
+- 51cd994: feat: publish history dashboard to npm, extract playwright-config as standalone package, add missing .eslintrc.js to pw-standard
+
+## 1.1.0
+
+### Minor Changes
+
+- 4329be3: Convert repository to npm workspaces with three independent packages and introduce `@acahet/playwright-config`.
+
+  Summary:
+
+  - migrate to `packages/*` workspace structure
+  - split Playwright config into dedicated package
+  - keep a compatibility bridge export at `@acahet/pw-standard/playwright`
+  - update dashboard package metadata/docs for new workspace location
+  - add root orchestration scripts and Changesets configuration

package/packages/playwright-config/README.md

@@ -0,0 +1,22 @@
+# @acahet/playwright-config
+
+Shared Playwright config presets package.
+
+## Install
+
+```bash
+npm i -D @acahet/playwright-config
+```
+
+## Usage
+
+```ts
+import { defineConfig } from '@playwright/test';
+import * as preset from '@acahet/playwright-config';
+
+export default defineConfig({
+	...preset,
+});
+```
+
+This package currently exports a placeholder root preset entry and is ready for incremental config extraction.

package/packages/playwright-config/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@acahet/playwright-config",
+  "version": "1.2.0",
+  "description": "Shared Playwright config presets",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.json",
+    "build:watch": "tsc --project tsconfig.json --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "playwright",
+    "playwright-config",
+    "testing",
+    "e2e",
+    "typescript"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/acahet-automation-org/playwright-toolbox.git",
+    "directory": "packages/playwright-config"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.40.0"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.58.2",
+    "typescript": "^5.9.3"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/packages/playwright-config/src/index.ts

@@ -0,0 +1,21 @@
+/**
+ * @acahet/playwright-config
+ *
+ * Shared Playwright config presets.
+ *
+ * Usage in a consuming project's playwright.config.ts:
+ *
+ *   import { baseConfig } from '@acahet/playwright-config';
+ *   import { defineConfig } from '@playwright/test';
+ *
+ *   export default defineConfig({
+ *     ...baseConfig,
+ *     use: { ...baseConfig.use, baseURL: 'http://localhost:3000' },
+ *   });
+ */
+
+// Configs will be added here — e.g.:
+// export { baseConfig } from './base.config';
+// export { ciConfig }   from './ci.config';
+
+export {};

package/packages/playwright-config/tsconfig.json

@@ -0,0 +1,19 @@
+{
+	"compilerOptions": {
+		"target": "ES2020",
+		"module": "commonjs",
+		"lib": ["ES2020"],
+		"declaration": true,
+		"declarationMap": true,
+		"sourceMap": true,
+		"outDir": "./dist",
+		"rootDir": "./src",
+		"strict": true,
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"forceConsistentCasingInFileNames": true,
+		"resolveJsonModule": true
+	},
+	"include": ["src/**/*"],
+	"exclude": ["node_modules", "dist"]
+}

package/packages/playwright-history-dashboard/CHANGELOG.md

@@ -0,0 +1,21 @@
+# @acahet/playwright-history-dashboard
+
+## 2.0.0
+
+### Major Changes
+
+- 51cd994: feat: publish history dashboard to npm, extract playwright-config as standalone package, add missing .eslintrc.js to pw-standard
+
+## 1.0.1
+
+### Patch Changes
+
+- 4329be3: Convert repository to npm workspaces with three independent packages and introduce `@acahet/playwright-config`.
+
+  Summary:
+
+  - migrate to `packages/*` workspace structure
+  - split Playwright config into dedicated package
+  - keep a compatibility bridge export at `@acahet/pw-standard/playwright`
+  - update dashboard package metadata/docs for new workspace location
+  - add root orchestration scripts and Changesets configuration

package/packages/playwright-history-dashboard/README.md

@@ -0,0 +1,216 @@
+# @acahet/playwright-history-dashboard
+
+A self-hosted Playwright test history dashboard — no SaaS, no subscriptions, no external services. A custom reporter writes a local JSON index after every run, and a single-file HTML dashboard reads it directly from disk.
+
+In this workspace, the package source is located at `package/packages/playwright-history-dashboard`.
+
+## Install
+
+```bash
+npm install -D @acahet/playwright-history-dashboard
+```
+
+## Quick start
+
+### 1. Configure (optional but recommended)
+
+Create `pw-dashboard.config.js` in your project root:
+
+```js
+// pw-dashboard.config.js
+module.exports = {
+	projectName: 'Acme E2E', // shown in topbar and footer
+	brandName: 'pw_dashboard', // top-left brand label
+	pageTitle: 'Acme Test Dashboard', // browser tab title
+	historyDir: 'tests/report/test-history', // must match playwright.config.ts
+};
+```
+
+A starter config file is included in the package at `pw-dashboard.config.js`.
+
+### 2. Generate the dashboard
+
+```bash
+npx pw-history-init
+```
+
+Reads your `pw-dashboard.config.js`, injects your settings, and writes `index.html` into `historyDir`. Re-run after upgrading the package to pick up dashboard updates; your config is always preserved.
+
+### 3. Register the reporter in `playwright.config.ts`
+
+```ts
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+	reporter: [
+		['html'],
+		[
+			'@acahet/playwright-history-dashboard/reporter',
+			{
+				historyDir: 'tests/report/test-history', // match pw-dashboard.config.js
+				maxRuns: 30, // optional, default is 30
+			},
+		],
+	],
+	use: {
+		trace: 'on-first-retry',
+		screenshot: 'on', // required for the gallery page
+	},
+});
+```
+
+### 4. Run tests and serve the dashboard
+
+```bash
+npx playwright test
+npx serve tests/report/test-history
+```
+
+Open `http://localhost:3000` — the dashboard always shows the latest run.
+
+---
+
+## Features
+
+### Reporter
+
+- Records every test run to `history-index.json`
+- Captures pass, fail, flaky, skipped counts and total duration per run
+- Stores per-test: title, file, project, duration, status, error message, tags, and Playwright annotations
+- Detects flaky tests automatically — passed on retry after a prior failure
+- Copies failure artifacts (trace + screenshot) into a per-run directory scoped to the specific failing test
+- Retains the last **N runs** (default 30) as the single retention policy — index and disk stay in sync
+- Orphan guard removes any run directories not referenced in the index
+- Error boundary in `onEnd` — reporter failures never affect test exit codes
+- Skips `setup` project tests
+- Requires Playwright ≥ 1.42
+
+### Dashboard pages
+
+**Dashboard**
+
+- Suite health grade (A–F) on the latest run: 60% pass rate, 30% stability, 10% performance
+- Latest run stat cards: pass rate, passed, failed, flaky, skipped, total, duration
+- Clicking passed / failed / flaky / skipped filters that run's test list instantly
+- Stacked bar chart across last 30 runs with hover tooltip
+- Run duration line chart
+- Per-test view: search by name, project, or tag; sparkline of last 10 runs per card
+
+**Test detail** (click any test card)
+
+- Full run history with date, runId, status, duration
+- Duration-over-time mini chart with min / avg / max and `±% vs prev` delta
+- Failure reason grouping — normalises error messages to surface recurring patterns
+- Annotation support: `title` shown before the error, `description` in the header
+- Playwright error collapsed by default, expandable on click
+
+**Trends**
+
+- 4 charts across last 30 runs: Pass rate, Duration, Flaky count, Slow count
+- Each panel shows current value, delta vs previous run, and min / avg / max
+
+**Gallery**
+
+- Grid of failure screenshots grouped by run
+- Lightbox on click, Escape to close
+
+**Sidebar**
+
+- Navigate: Dashboard, Trends, Search tests, Gallery
+- Tag and Spec filter chips auto-populated from your test data
+- Recent runs list — click any run to scroll and auto-expand it
+
+**Run cards**
+
+- Collapsed by default, showing failed + flaky only
+- `SLOW` badge on tests above 1.5× the P75 duration of that run
+- Errors collapsed inline, expandable per test
+- Artifact links: download trace or screenshot per test
+
+---
+
+## Options
+
+| Option       | Type     | Default                         | Description                                       |
+| ------------ | -------- | ------------------------------- | ------------------------------------------------- |
+| `historyDir` | `string` | `'./tests/report/test-history'` | Where to write the JSON index and run directories |
+| `maxRuns`    | `number` | `30`                            | How many runs to keep in the index and on disk    |
+
+---
+
+## Using annotations
+
+```ts
+test('checkout fails with expired card', async ({ page }) => {
+	test.info().annotations.push(
+		{ type: 'title', description: 'Known payment gateway timeout' },
+		{
+			type: 'description',
+			description: 'Card validation times out after 30s under load',
+		},
+	);
+	// test body
+});
+```
+
+The `title` annotation appears as a prominent label before the Playwright error in run history. The `description` appears in the test detail header. Any other annotation types appear as chips under the test name.
+
+---
+
+## Using with Azure App Testing
+
+Create a thin wrapper config — your reporter and test code stay untouched:
+
+```ts
+// playwright.service.config.ts
+import { defineConfig } from '@playwright/test';
+import { getServiceConfig } from '@azure/microsoft-playwright-testing';
+import baseConfig from './playwright.config';
+
+export default defineConfig(baseConfig, getServiceConfig(baseConfig), {
+	reporter: [
+		['list'],
+		['@azure/microsoft-playwright-testing/reporter'],
+		['@acahet/playwright-history-dashboard'],
+	],
+});
+```
+
+Run with Azure: `npx playwright test --config=playwright.service.config.ts`
+
+To detach: delete the service config, remove the package. Zero changes to tests.
+
+---
+
+## File structure after setup
+
+```
+your-project/
+└── tests/
+    └── report/
+        └── test-history/
+			├── index.html              ← dashboard (copied by pw-history-init)
+            ├── history-index.json      ← auto-generated after each run
+            └── runs/
+                └── <run-id>/
+                    ├── <test>-trace.zip
+                    └── <test>-screenshot.png
+```
+
+Add to `.gitignore`:
+
+```
+tests/report/test-history/runs/
+tests/report/test-history/history-index.json
+```
+
+---
+
+## Requirements
+
+- Playwright ≥ 1.42
+- Node.js ≥ 18
+
+## License
+
+MIT