experiment-e2e-generator 1.0.1 → 1.0.3

package/README.md

@@ -21,7 +21,7 @@ npx experiment-e2e-generator
 
 ### Requirements
 
-- Node.js >= 16.15.1
+- Node.js >= 18 (required by Playwright 1.40+)
 - Existing `package.json` in project root
 - Project must be an Experiment Framework project
 
@@ -344,8 +344,8 @@ The generator safely updates your `package.json`:
 ```json
 {
   "devDependencies": {
-    "@playwright/test": "^1.40.0",
-    "playwright": "^1.40.0"
+    "@playwright/test": "1.40.0",
+    "playwright": "1.40.0"
   }
 }
 ```

package/package.json

@@ -3,7 +3,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "1.0.1",
+    "version": "1.0.3",
     "description": "CLI tool to generate Playwright e2e tests for Experiment Framework projects",
     "type": "module",
     "bin": {

package/src/generator.js

@@ -3,7 +3,7 @@ import chalk from 'chalk';
 import { validateProjectDirectory, pathExists } from './utils.js';
 import { getUserInput, confirmAction } from './prompts.js';
 import { generateTestFiles, testsDirectoryExists, getGeneratedFilesList } from './file-operations.js';
-import { updatePackageJson, isPlaywrightInstalled } from './package-updater.js';
+import { updatePackageJson, isPlaywrightInstalled, installDependencies } from './package-updater.js';
 
 /**
  * Main generator function
@@ -69,21 +69,38 @@ export async function generator() {
 			console.log(chalk.gray('  ℹ No package.json updates needed'));
 		}
 		
-		// Step 5: Display completion message
+		// Step 5: Install dependencies in target project (only Playwright from its package.json)
+		let installSucceeded = false;
+		if (packageResult.updated) {
+			console.log(chalk.blue('\n📥 Installing Playwright...\n'));
+			const installResult = await installDependencies(cwd);
+			if (installResult.success) {
+				installSucceeded = true;
+				console.log(chalk.green('  ✓ Playwright installed\n'));
+			} else {
+				console.log(chalk.yellow(`  ⚠ ${installResult.error}`));
+				console.log(chalk.gray('  Run yarn install or npm install in this directory to install Playwright.\n'));
+			}
+		}
+		
+		// Step 6: Display completion message
 		console.log(chalk.green.bold('\n✓ Test structure generated successfully!\n'));
 		
 		console.log(chalk.blue('Next steps:\n'));
-		console.log(chalk.white('  1. Install dependencies:'));
-		console.log(chalk.gray('     yarn install\n'));
-		
-		console.log(chalk.white('  2. Update test URLs in:'));
+		let step = 1;
+		if (!installSucceeded && packageResult.updated) {
+			console.log(chalk.white(`  ${step}. Install dependencies:`));
+			console.log(chalk.gray('     yarn install  (or npm install)\n'));
+			step++;
+		}
+		console.log(chalk.white(`  ${step}. Update test URLs in:`));
 		console.log(chalk.gray('     tests/config/qa-links.config.js\n'));
-		
-		console.log(chalk.white('  3. Customize test selectors in:'));
+		step++;
+		console.log(chalk.white(`  ${step}. Customize test selectors in:`));
 		console.log(chalk.gray(`     tests/e2e/${config.experimentName.toLowerCase().replace(/\s+/g, '-')}/${config.experimentName.toLowerCase().replace(/\s+/g, '-')}.spec.js\n`));
-		
-		console.log(chalk.white('  4. Run tests:'));
-		console.log(chalk.gray('     yarn test:e2e\n'));
+		step++;
+		console.log(chalk.white(`  ${step}. Run tests:`));
+		console.log(chalk.gray('     yarn test:e2e  (or npm run test:e2e)\n'));
 		
 		console.log(chalk.blue('📖 Documentation:'));
 		console.log(chalk.gray('   https://playwright.dev/docs/intro\n'));

package/src/package-updater.js

@@ -1,6 +1,7 @@
 import path from 'path';
+import { spawnSync } from 'child_process';
 import fs from 'fs-extra';
-import { mergePackageJson, formatPackageJson } from './utils.js';
+import { mergePackageJson, formatPackageJson, pathExists } from './utils.js';
 
 /**
  * Update package.json with Playwright dependencies and scripts
@@ -17,8 +18,8 @@ export async function updatePackageJson(targetDir) {
 	// Define additions
 	const additions = {
 		devDependencies: {
-			'@playwright/test': '^1.40.0',
-			'playwright': '^1.40.0',
+			'@playwright/test': '1.40.0',
+			'playwright': '1.40.0',
 		},
 		scripts: {},
 	};
@@ -71,3 +72,37 @@ export async function isPlaywrightInstalled(targetDir) {
 		return false;
 	}
 }
+
+/**
+ * Detect which package manager the project uses
+ * @param {string} targetDir - Target project directory
+ * @returns {'yarn' | 'npm'}
+ */
+export async function detectPackageManager(targetDir) {
+	const hasYarnLock = await pathExists(path.join(targetDir, 'yarn.lock'));
+	return hasYarnLock ? 'yarn' : 'npm';
+}
+
+/**
+ * Install dependencies in the target project (only installs what's in its package.json, e.g. Playwright)
+ * @param {string} targetDir - Target project directory
+ * @returns {Promise<{success: boolean, error?: string}>}
+ */
+export async function installDependencies(targetDir) {
+	const packageManager = await detectPackageManager(targetDir);
+	const isWindows = process.platform === 'win32';
+	const cmd = packageManager === 'yarn' ? 'yarn' : 'npm';
+	const args = ['install'];
+	const result = spawnSync(cmd, args, {
+		cwd: targetDir,
+		stdio: 'inherit',
+		shell: isWindows,
+	});
+	if (result.status !== 0) {
+		return {
+			success: false,
+			error: `${packageManager} install failed with exit code ${result.status}`,
+		};
+	}
+	return { success: true };
+}