@testrelic/playwright-analytics 2.3.18 → 2.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testrelic/playwright-analytics",
-  "version": "2.3.18",
+  "version": "2.4.1",
   "description": "Playwright test analytics reporter with E2E navigation tracking, API call capture, network stats, failure diagnostics, and interactive HTML reports",
   "keywords": [
     "playwright",
@@ -74,6 +74,7 @@
   },
   "files": [
     "dist",
+    "scripts",
     "timeline-schema.json",
     "README.md"
   ],
@@ -81,7 +82,7 @@
     "@playwright/test": ">=1.35.0"
   },
   "dependencies": {
-    "@testrelic/core": "2.3.18"
+    "@testrelic/core": "2.4.1"
   },
   "devDependencies": {
     "@playwright/test": "^1.35.0",
@@ -106,6 +107,7 @@
   },
   "scripts": {
     "build": "tsup",
+    "postinstall": "node scripts/postinstall.cjs",
     "test": "vitest run --exclude '**/e2e/**'",
     "test:watch": "vitest",
     "test:integration": "vitest run --config vitest.integration.config.ts",

package/scripts/postinstall.cjs

@@ -0,0 +1,54 @@
+/**
+ * Postinstall script: scaffolds `.testrelic/testrelic-config.json` in the user's
+ * project root when `@testrelic/playwright-analytics` is installed as a dependency.
+ *
+ * Skips silently when:
+ *  - Running inside a CI environment (CI=true)
+ *  - INIT_CWD is not set (e.g. direct development install of the package itself)
+ *  - The config file already exists (idempotent)
+ */
+
+'use strict';
+
+const { existsSync, mkdirSync, writeFileSync } = require('fs');
+const { join } = require('path');
+
+// npm sets INIT_CWD to the directory where `npm install` was run (the user's project root).
+const projectRoot = process.env.INIT_CWD;
+
+// Skip if not running as a dependency install (e.g. during the package's own development)
+if (!projectRoot) process.exit(0);
+
+// Skip in CI environments to avoid creating files unexpectedly in pipelines
+if (process.env.CI === 'true' || process.env.CI === '1') process.exit(0);
+
+// Skip if the install is happening inside node_modules itself (nested install scenario)
+if (projectRoot.includes('node_modules')) process.exit(0);
+
+const configDir = join(projectRoot, '.testrelic');
+const configFile = join(configDir, 'testrelic-config.json');
+
+// Idempotent: skip if config already exists
+if (existsSync(configFile)) process.exit(0);
+
+const template = {
+  cloud: {
+    apiKey: '$TESTRELIC_API_KEY',
+    endpoint: 'https://platform.testrelic.ai/api/v1',
+    upload: 'both',
+  },
+  'testrelic-repo': {
+    name: 'my-project',
+  },
+};
+
+try {
+  mkdirSync(configDir, { recursive: true });
+  writeFileSync(configFile, JSON.stringify(template, null, 2) + '\n', 'utf-8');
+  process.stdout.write(
+    '[testrelic] Created .testrelic/testrelic-config.json — update "testrelic-repo.name" and set TESTRELIC_API_KEY.\n',
+  );
+} catch (err) {
+  // Non-fatal: log but do not fail the install
+  process.stderr.write('[testrelic] Could not create .testrelic/testrelic-config.json: ' + err.message + '\n');
+}