open-ready 0.1.2 → 0.1.6

package/README.md

@@ -0,0 +1,64 @@
+# open-ready
+
+Smart dev server launcher that watches your server's output and automatically opens the browser when ready — or opens an AI assistant with the error context when something goes wrong.
+
+Works with Next.js, Vite, and any CLI-based dev server.
+
+## Install
+
+```sh
+npm install -g open-ready
+# or use without installing:
+npx open-ready <your-dev-command>
+```
+
+## Usage
+
+```sh
+open-ready <command> [options]
+```
+
+### Examples
+
+```sh
+open-ready npm run dev
+open-ready bun run dev
+open-ready vite
+open-ready next dev
+```
+
+### Options
+
+| Flag | Default | Description |
+|------|---------|-------------|
+| `--ai-base <url>` | `https://perplexity.ai?q=` | AI assistant base URL to open on error |
+| `--noAi` | `false` | Disable opening AI on error |
+| `--noOpen` | `false` | Disable opening browser when ready |
+| `--pollDelay <ms>` | `1200` | How often to poll the log for ready/error signals |
+
+### Disable AI on error
+
+```sh
+open-ready npm run dev --noAi
+```
+
+### Use a different AI assistant
+
+```sh
+open-ready npm run dev --ai-base "https://chatgpt.com/?q="
+```
+
+## How it works
+
+1. Spawns your dev command and pipes its stdout/stderr to a log file
+2. Polls the log every `pollDelay` ms looking for:
+   - **Error signal** — lines matching `error`, `failed`, `exception`, `SyntaxError`, or `⨯`
+   - **Ready signal** — lines matching `ready - started server` or `Ready in Xms`
+3. On **error**: extracts up to ~1000 chars of surrounding context and opens your AI assistant with a pre-filled prompt explaining the error and asking for a fix
+4. On **ready**: waits for the port to be reachable, then opens the local URL in your default browser
+
+For Next.js projects, the log is written to `.next/port.log`; otherwise `open-when-ready.log` in the current directory.
+
+## License
+
+MIT

package/open-when-ready.mjs

@@ -1,4 +1,12 @@
 #!/usr/bin/env node
+
+/**
+ * @fileoverview CLI tool that spawns a dev server command, monitors its log
+ * output for a "ready" signal, and automatically opens the local URL in the
+ * browser. If an error is detected first, it opens an AI assistant with the
+ * error context for troubleshooting.
+ */
+
 import fsPromises from "fs/promises";
 import fs from "fs";
 import path from "path";
@@ -20,18 +28,12 @@ const logPath = fs.existsSync(nextDir)
   ? path.join(".next", "port.log")
   : "open-when-ready.log";
 
-console.log(`📁 Log: ${logPath} | Poll: ${pollDelay}ms`);
 
 /**
- * Opens browser when dev server is ready.
- * 
- * ### Features
- * - **Automatic**: Detects server start
- * - **Versatile**: Supports multiple browsers
- * 
- * ```js
- * console.log("Ready!");
- * ```
+ * Scans log output for error lines and extracts surrounding context
+ * as a URL-encoded string suitable for an AI search query.
+ * @param {string} log - Raw log output from the dev server
+ * @returns {string} URL-encoded error context, or empty string if no error found
  */
 function getErrorContext(log) {
   const lines = log.split(/\n/);
@@ -53,31 +55,31 @@ function getErrorContext(log) {
   return "";
 }
 
+/**
+ * Parses log output to find the local dev server URL (e.g. http://localhost:3000).
+ * @param {string} log - Raw log output from the dev server
+ * @returns {string|null} The localhost URL, or null if not found
+ */
 function extractUrl(log) {
   // Better regex for Local: line
   const localMatch = log.match(/Local:\s+(http:\/\/localhost:\d+)/i);
-  if (localMatch) {
-    console.log("✅ EXTRACTED URL:", localMatch[1]);
-    return localMatch[1];
-  }
+  if (localMatch) return localMatch[1];
 
   // Fallback port
   const portMatch = log.match(/localhost:(\d+)/);
-  if (portMatch) {
-    const url = `http://localhost:${portMatch[1]}`;
-    console.log("✅ FALLBACK URL:", url);
-    return url;
-  }
+  if (portMatch) return `http://localhost:${portMatch[1]}`;
 
-  console.log("❌ NO URL FOUND");
   return null;
 }
 
+/**
+ * Main entry point. Spawns the dev server command, pipes its output to a log
+ * file, and polls the log for ready/error signals to open the browser or AI helper.
+ */
 async function run() {
   try {
     await fsPromises.rm(logPath, { force: true });
   } catch {}
-  console.log("🚀 Starting", cmdArgs.join(" "));
 
   const proc = spawn(cmdArgs.join(" "), [], {
     stdio: ["ignore", "pipe", "pipe", "ipc"],
@@ -107,14 +109,9 @@ async function run() {
       if (logChanged && stats.size > 100) {
         stableCount = 0;
         lastLogSize = stats.size;
-        console.log(
-          `📊 ${stats.size}B CHANGED | LOG:\n${currentLog.slice(0, 500)}...`,
-        );
       } else if (stats.size > 100) {
         stableCount++;
-        console.log(`📊 ${stats.size}B STABLE (${stableCount}/5)`);
         if (stableCount >= 5) {
-          console.log("🛑 Log stable 5 polls - stopping");
           clearInterval(poll);
           return;
         }
@@ -123,7 +120,6 @@ async function run() {
       // Error first
       const errorRegex = /⨯|[Ss]yntax[Ee]rror|error|failed|exception/i;
       if (errorRegex.test(currentLog) && !noAi && !errorOpened) {
-        console.log("🎯 ERROR!");
         const err = getErrorContext(currentLog);
         const customPrompt = "Explain what the error is, how to fix it, then give a shell script with the best recommended solution.";
         const prompt = encodeURIComponent(customPrompt + " ");
@@ -138,33 +134,21 @@ async function run() {
       if (isReadyNow && !lastReadySeen && !opened) {
         opened = true;
         lastReadySeen = true;
-        console.log("🎉 READY DETECTED!");
         const url = extractUrl(currentLog);
         if (url && !noOpen) {
-          console.log("🌐 Testing", url);
           try {
             await waitOn(url, { timeout: 10000, http: true });
-            console.log("✅ HTTP READY!");
-          } catch (e) {
-            console.log(
-              "⚠ HTTP not ready, but opening:",
-              e.message.slice(0, 50),
-            );
-          }
-          console.log("🚀 OPENING BROWSER:", url);
+          } catch {}
           opener(url);
         }
         clearInterval(poll);
         return;
       }
       lastReadySeen = isReadyNow;
-    } catch (e) {
-      console.log("Poll error:", e.message);
-    }
+    } catch {}
   }, pollDelay);
 
   process.on("SIGINT", () => {
-    console.log("\n👋 Exiting (dev server alive)");
     clearInterval(poll);
     process.exit(0);
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "open-ready",
-  "version": "0.1.2",
+  "version": "0.1.6",
   "description": "Smart dev server launcher: error→AI search, success→auto-open browser. Any CLI tool.",
   "type": "module",
   "bin": {
@@ -20,7 +20,6 @@
   "license": "MIT",
   "dependencies": {
     "minimist": "^1.2.8",
-    "open": "^10.1.0",
     "opener": "^1.5.2",
     "wait-on": "^8.0.1"
   },