muagqa 1.1.1 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "muagqa",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "description": "MuagQA CLI — Test case runner with one-time session token and Playwright recorder",
   "author": "Mary C.N. Enwezor",
   "license": "MIT",
@@ -9,6 +9,9 @@
   "bin": {
     "muagqa": "./bin/muagqa"
   },
+  "scripts": {
+    "postinstall": "node ./src/postinstall.js"
+  },
 
   "dependencies": {
     "axios": "^1.6.0",

package/src/index.js

@@ -1,11 +1,55 @@
 #!/usr/bin/env node
+import { exec } from "child_process";
+import { createRequire } from "module";
+import { promisify } from "util";
 import inquirer from "inquirer";
 import chalk from "chalk";
 import run from "./runner.js";
 
-console.log(chalk.cyan.bold("\n🚀 MuagQA CLI — One-Time Test Case Recorder\n"));
+const execAsync = promisify(exec);
+const require = createRequire(import.meta.url);
+const pkg = require("../package.json");
+
+console.log(chalk.cyan.bold("\nMuagQA CLI - One-Time Test Case Recorder\n"));
+
+async function checkForUpdate({ force = false } = {}) {
+  try {
+    const { stdout } = await execAsync("npm view muagqa version", {
+      timeout: 4000
+    });
+    const latest = stdout.trim();
+    if (!latest) {
+      return;
+    }
+    if (latest !== pkg.version) {
+      console.log(chalk.yellow(`Update available: v${latest} (installed v${pkg.version}).`));
+      console.log(chalk.gray("Run: npm install -g muagqa@latest\n"));
+    } else if (force) {
+      console.log(chalk.green(`MuagQA is up to date (v${pkg.version}).`));
+    }
+  } catch (err) {
+    if (force) {
+      console.log(chalk.red("Unable to check for updates right now."));
+    }
+  }
+}
 
 async function startCLI() {
+  const args = new Set(process.argv.slice(2));
+
+  if (args.has("--version") || args.has("-v")) {
+    console.log(`muagqa v${pkg.version}`);
+    return;
+  }
+
+  if (args.has("--check-update")) {
+    await checkForUpdate({ force: true });
+    return;
+  }
+
+  // Fire-and-forget update check to avoid slowing down the prompt.
+  checkForUpdate();
+
   const { token } = await inquirer.prompt([
     {
       type: "input",

package/src/playwrightCli.js

@@ -0,0 +1,15 @@
+import fs from "fs";
+import path from "path";
+import { createRequire } from "module";
+
+const require = createRequire(import.meta.url);
+
+export function getPlaywrightCliPath() {
+  try {
+    const pkgPath = require.resolve("playwright/package.json");
+    const cliPath = path.join(path.dirname(pkgPath), "cli.js");
+    return fs.existsSync(cliPath) ? cliPath : null;
+  } catch {
+    return null;
+  }
+}

package/src/playwrightInstaller.js

@@ -1,36 +1,30 @@
-import { execSync } from "child_process";
-import path from "path";
-import chalk from "chalk";
-
-export function ensurePlaywrightInstalled() {
-  try {
-    console.log(chalk.cyan("🔍 Checking Playwright installation..."));
-
-    // Try running playwright --version
-    execSync("npx playwright --version", { stdio: "ignore" });
-
-    console.log(chalk.green("✔ Playwright is already installed globally."));
-    return true;
-  } catch (err) {
-    console.log(chalk.yellow("⚠ Playwright not found globally. Installing..."));
-  }
-
-  try {
-    // 1️⃣ Determine global CLI install folder
-    const globalRoot = execSync("npm root -g").toString().trim();
-
-    const cliPath = path.join(globalRoot, "muagqa");
-
-    console.log(chalk.cyan(`📂 Installing Playwright inside: ${cliPath}`));
-
-    // 2️⃣ Install Playwright inside the global muagqa folder
-    execSync(`cd "${cliPath}" && npm install playwright`, { stdio: "inherit" });
-
-    console.log(chalk.green("✔ Playwright installed successfully!"));
-    return true;
-  } catch (e) {
-    console.log(chalk.red("❌ Failed to install Playwright globally."));
-    console.error(e);
-    return false;
-  }
-}
+import { execSync } from "child_process";
+import chalk from "chalk";
+import { getPlaywrightCliPath } from "./playwrightCli.js";
+
+export function ensurePlaywrightInstalled() {
+  try {
+    const cliPath = getPlaywrightCliPath();
+    if (!cliPath) {
+      console.log(chalk.red("Playwright CLI not found. Please reinstall the package."));
+      return false;
+    }
+
+    if (process.env.PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD === "1") {
+      console.log(chalk.yellow("Skipping Playwright browser download (env set)."));
+      return true;
+    }
+
+    console.log(chalk.cyan("Ensuring Playwright Chrome browser is installed..."));
+    execSync(`"${process.execPath}" "${cliPath}" install chrome`, {
+      stdio: "inherit"
+    });
+
+    console.log(chalk.green("Playwright browser install complete."));
+    return true;
+  } catch (err) {
+    console.log(chalk.red("Failed to ensure Playwright browsers are installed."));
+    console.error(err);
+    return false;
+  }
+}

package/src/playwrightRunner.js

@@ -1,19 +1,41 @@
-import { exec } from "child_process";
+import { spawn } from "child_process";
 import chalk from "chalk";
+import { getPlaywrightCliPath } from "./playwrightCli.js";
 
 export function openCodegenForTest(testCase) {
   return new Promise((resolve) => {
     const outputPath = `./generated-tests/${testCase.id}.spec.ts`;
 
-    console.log(chalk.cyan(`\n▶ Recording: ${testCase.title}`));
+    console.log(chalk.cyan(`\nRecording: ${testCase.title}`));
     console.log(chalk.gray(`Description: ${testCase.description}\n`));
 
-    const cmd = `npx playwright codegen ${testCase.startUrl || ""} --output=${outputPath}`;
+    const cliPath = getPlaywrightCliPath();
+    if (!cliPath) {
+      console.log(chalk.red("Playwright CLI not found. Please reinstall the package."));
+      resolve();
+      return;
+    }
+
+    const args = [cliPath, "codegen"];
+    if (testCase.startUrl) {
+      args.push(testCase.startUrl);
+    }
+    args.push(`--output=${outputPath}`, "--channel=chrome");
+
+    const child = spawn(process.execPath, args, { stdio: "inherit" });
 
-    const child = exec(cmd);
+    child.on("error", (err) => {
+      console.log(chalk.red("Failed to start Playwright codegen."));
+      console.error(err);
+      resolve();
+    });
 
-    child.on("exit", () => {
-      console.log(chalk.green(`✔ Saved recording to ${outputPath}`));
+    child.on("exit", (code) => {
+      if (code === 0) {
+        console.log(chalk.green(`Saved recording to ${outputPath}`));
+      } else {
+        console.log(chalk.red(`Playwright codegen exited with code ${code}.`));
+      }
       resolve();
     });
   });

package/src/postinstall.js

@@ -0,0 +1,31 @@
+import { execSync } from "child_process";
+import chalk from "chalk";
+import { getPlaywrightCliPath } from "./playwrightCli.js";
+
+function shouldSkip() {
+  return process.env.PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD === "1";
+}
+
+function installChrome() {
+  const cliPath = getPlaywrightCliPath();
+  if (!cliPath) {
+    console.log(chalk.red("Playwright CLI not found; skipping browser install."));
+    return;
+  }
+
+  console.log(chalk.cyan("Installing Playwright Chrome browser..."));
+  execSync(`"${process.execPath}" "${cliPath}" install chrome`, {
+    stdio: "inherit"
+  });
+}
+
+try {
+  if (shouldSkip()) {
+    console.log(chalk.yellow("Skipping Playwright browser download (env set)."));
+  } else {
+    installChrome();
+  }
+} catch (err) {
+  console.log(chalk.red("Failed to install Playwright browsers."));
+  console.error(err);
+}

package/src/runner.js

@@ -5,7 +5,6 @@ import { ensureFolder } from "./fileManager.js";
 import { openCodegenForTest } from "./playwrightRunner.js";
 import { ensurePlaywrightInstalled } from "./playwrightInstaller.js";
 
-
 export default async function run(token) {
   const spinner = ora("Validating token...").start();
 
@@ -14,7 +13,7 @@ export default async function run(token) {
 
     if (!result.success) {
       spinner.fail("Invalid token.");
-      console.log(chalk.red(`\n❌ ${result.error}\n`));
+      console.log(chalk.red(`\n${result.error}\n`));
       return;
     }
 
@@ -23,24 +22,25 @@ export default async function run(token) {
     const { testCases } = result;
 
     if (!testCases || testCases.length === 0) {
-      console.log(chalk.red("\n⚠ No test cases found.\n"));
+      console.log(chalk.red("\nNo test cases found.\n"));
       return;
     }
 
-    console.log(chalk.green(`\n📌 ${testCases.length} test cases found.\n`));
+    console.log(chalk.green(`\n${testCases.length} test cases found.\n`));
 
-     await ensurePlaywrightInstalled();
+    const ok = ensurePlaywrightInstalled();
+    if (!ok) {
+      return;
+    }
 
     ensureFolder("./generated-tests");
 
-    // sequentially open codegen for each test
     for (const testCase of testCases) {
       await openCodegenForTest(testCase);
     }
 
-    console.log(chalk.green.bold("\n🎉 All test cases recorded successfully!\n"));
-    console.log(chalk.yellow("⚠ Token has now expired. Generate a new one for the next session.\n"));
-
+    console.log(chalk.green.bold("\nAll test cases recorded successfully!\n"));
+    console.log(chalk.yellow("Token has now expired. Generate a new one for the next session.\n"));
   } catch (err) {
     spinner.fail("An error occurred.");
     console.error(err);