@arpanp/zen-reporter 0.10.1 → 0.11.1

package/README.md

@@ -34,8 +34,12 @@ Dark mode:
   - **Themes & Dark Mode**: Multiple design themes (`Cafe`, `Concept`, `Sentinel`) with light and dark mode toggles, built with WCAG-compliant color tokens and configurable default states.
   - **Single-File Standalone Output**: Generates a self-contained single-file HTML report (`index.html`) with embedded datasets for easy sharing and CI/CD artifact storage. Optionally creates a lightweight standalone `summary.html` dedicated to executive dashboards.
 
+> **Note**: Designed and built with AI pair-programming tools; fully tested, maintained, and quality-assured by human hands.
+
 ---
 
+> **Compatibility**: Zen Reporter is designed for standard Playwright test suites and does not support BDD-styled tests (e.g. Cucumber / `playwright-bdd`).
+
 ## Installation
 
 ```bash
@@ -121,12 +125,13 @@ npx zr show
 
 ### 3. CLI Commands Reference (`zr`)
 
-Zen Reporter includes a built-in CLI executable (`npx zr`) for serving reports and querying historical test execution data:
+Zen Reporter includes a built-in CLI executable (`npx zr`) for serving reports, checking system environment, and querying historical test execution data:
 
-#### Report & Summaries
+#### Report & Environment
 
 - **`npx zr show`** — Launch the report server to view `index.html` in your default browser.
 - **`npx zr summary`** — Output Markdown summary snippet for current run results (ideal for PR comments or Slack).
+- **`npx zr env`** — Print environment details (`zen-reporter` version, `@playwright/test` version, Node.js version, OS).
 
 #### History & Intelligence (`zr history`)
 
@@ -140,7 +145,7 @@ Zen Reporter includes a built-in CLI executable (`npx zr`) for serving reports a
 | `npx zr history tests`            | Summarize granular historical execution metrics and average durations per test case.               |
 | `npx zr history flaky`            | Identify flaky tests that passed in some runs and failed in others.                                |
 | `npx zr history regressions`      | List tests that passed in a previous run but failed in the latest run.                             |
-| `npx zr history slow [--limit N]` | Rank the top $N$ slowest tests by average execution duration across runs (default: 10).            |
+| `npx zr history slow [--limit N]` | Rank the top `N` slowest tests by average execution duration across runs (default: 10).            |
 | `npx zr history trend`            | Display historical pass rate percentages per run over time.                                        |
 | `npx zr history report`           | Build `history.json` and inject it into `index.html` to populate the History & Trends tabs.        |
 | `npx zr history query "<SQL>"`    | Run arbitrary DuckDB SQL queries over recorded test runs.                                          |

package/bin/zen-reporter.js

@@ -407,6 +407,61 @@ function generateMarkdownSummaryFromReport(reportData) {
   return md;
 }
 
+import { createRequire } from 'module';
+import { platform, type } from 'os';
+
+function getOsName() {
+  const p = platform();
+  if (p === 'darwin') return 'macOS';
+  if (p === 'win32') return 'Windows';
+  if (p === 'linux') {
+    try {
+      if (existsSync('/etc/os-release')) {
+        const content = readFileSync('/etc/os-release', 'utf8');
+        const match = content.match(/^PRETTY_NAME="?([^"\n]+)"?/m);
+        if (match && match[1]) return match[1];
+      }
+    } catch {
+      /* ignore */
+    }
+    return 'Linux';
+  }
+  return type();
+}
+
+function getPlaywrightVersion(cwd) {
+  const require = createRequire(resolve(cwd, 'package.json'));
+  try {
+    const pwPkg = require('@playwright/test/package.json');
+    return pwPkg.version || 'not installed';
+  } catch {
+    return 'not installed';
+  }
+}
+
+function getZenReporterVersion() {
+  try {
+    const pkgPath = resolve(
+      import.meta.dirname || new URL('.', import.meta.url).pathname,
+      '../package.json'
+    );
+    if (existsSync(pkgPath)) {
+      const pkg = JSON.parse(readFileSync(pkgPath, 'utf8'));
+      return pkg.version || 'unknown';
+    }
+  } catch {
+    /* ignore */
+  }
+  return 'unknown';
+}
+
+function handleEnv() {
+  console.log(`zen-reporter version: ${getZenReporterVersion()}`);
+  console.log(`@playwright/test version: ${getPlaywrightVersion(cwd)}`);
+  console.log(`Node.js version: ${process.version}`);
+  console.log(`OS: ${getOsName()}`);
+}
+
 function printHelp() {
   console.log(`
 Zen Reporter CLI
@@ -414,6 +469,7 @@ Zen Reporter CLI
 Usage:
   npx zr show                           Serve and view the HTML report
   npx zr summary                        Output Markdown summary snippet for current run results
+  npx zr env                            Print environment details (versions, OS)
   npx zr history                        List historic runs
   npx zr history runs                   Same as above
   npx zr history flaky                  Tests that failed in some runs and passed in others
@@ -663,6 +719,8 @@ if (command === 'show') {
     console.error('✗ Failed to read report summary:', err.message || err);
     process.exit(1);
   }
+} else if (command === 'env') {
+  handleEnv();
 } else if (command === 'history') {
   handleHistory(args.slice(1)).catch((e) => {
     console.error('✗ history command failed:', e?.message || e);