@elyracode/herd 0.5.3

package/README.md

@@ -0,0 +1,52 @@
+# @elyracode/herd
+
+Laravel Herd integration for Elyra -- environment detection, service management, logs, and .env sync.
+
+## Install
+
+```
+elyra install npm:@elyracode/herd
+```
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+| `herd_status` | Show PHP version, active services, linked sites, Node.js version |
+| `herd_logs` | Read Nginx, PHP, and Laravel error logs from Herd |
+| `herd_env_sync` | Verify .env matches Herd configuration (DB host/port, Redis, APP_URL, Mailpit) |
+| `herd_php` | Show or switch PHP version |
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `/herd` | Show Herd dashboard |
+| `/herd-logs` | Show recent error logs |
+| `/herd-sync` | Check .env against Herd config |
+
+## Usage
+
+```
+> What services are running in Herd?
+> Show me the PHP error logs
+> Does my .env match Herd's configuration?
+> Switch to PHP 8.4
+/herd
+/herd-logs
+/herd-sync
+```
+
+## .env Sync Checks
+
+The sync checker verifies:
+- **DB_HOST**: should be `127.0.0.1` for Herd MySQL/PostgreSQL
+- **DB_PORT**: should match Herd defaults (3306 for MySQL, 5432 for PostgreSQL)
+- **REDIS_HOST**: should be `127.0.0.1`
+- **APP_URL**: should use `.test` domain
+- **MAIL_HOST/PORT**: should match Herd Mailpit (`127.0.0.1:2525`)
+
+## Requirements
+
+- Laravel Herd installed with `herd` CLI in PATH
+- macOS (Herd's primary platform)

package/extensions/index.ts

@@ -0,0 +1,394 @@
+import { execSync } from "node:child_process";
+import { existsSync, readFileSync } from "node:fs";
+import { basename, join } from "node:path";
+import type { ExtensionAPI } from "@elyracode/coding-agent";
+import { Type } from "typebox";
+
+export default function (elyra: ExtensionAPI): void {
+
+	// ── Tool: herd_status ──
+	elyra.registerTool({
+		name: "herd_status",
+		label: "Herd Status",
+		description:
+			"Show the current Laravel Herd environment status: PHP version, active services " +
+			"(MySQL, Redis, PostgreSQL, Meilisearch, MinIO, Mailpit), linked sites, and Node.js version. " +
+			"Use this to understand the local development environment.",
+		parameters: Type.Object({}),
+		execute: async (_toolCallId, _params) => {
+			try {
+				const lines: string[] = ["# Laravel Herd Status", ""];
+
+				// Check if Herd CLI is available
+				if (!isHerdInstalled()) {
+					return {
+						content: [{ type: "text", text: "Laravel Herd is not installed or `herd` CLI is not in PATH." }],
+						details: {},
+					};
+				}
+
+				// PHP version
+				const phpVersion = herd("php --version 2>/dev/null || echo 'unknown'").split("\n")[0];
+				lines.push(`**PHP**: ${phpVersion}`);
+
+				// Node version
+				try {
+					const nodeVersion = herd("node --version 2>/dev/null || echo 'unknown'").trim();
+					lines.push(`**Node.js**: ${nodeVersion}`);
+				} catch { /* skip */ }
+
+				lines.push("");
+
+				// Services
+				lines.push("## Services");
+				const services = ["mysql", "redis", "postgresql", "meilisearch", "minio", "mailpit", "typesense"];
+				for (const service of services) {
+					try {
+						const status = herd(`services ${service} status 2>/dev/null || echo 'not available'`).trim();
+						const isRunning = status.toLowerCase().includes("running") || status.toLowerCase().includes("active");
+						const icon = isRunning ? "running" : "stopped";
+						lines.push(`- **${service}**: ${icon}`);
+					} catch {
+						// Service not available in this Herd version
+					}
+				}
+				lines.push("");
+
+				// Sites
+				lines.push("## Sites");
+				try {
+					const sitesOutput = herd("links 2>/dev/null || echo 'none'").trim();
+					if (sitesOutput && sitesOutput !== "none") {
+						lines.push(sitesOutput);
+					} else {
+						lines.push("No linked sites found.");
+					}
+				} catch {
+					lines.push("Could not list sites.");
+				}
+				lines.push("");
+
+				// Current project info
+				const cwd = process.cwd();
+				const projectName = basename(cwd);
+				lines.push("## Current Project");
+				lines.push(`- **Directory**: ${cwd}`);
+				lines.push(`- **Domain**: ${projectName}.test (if parked/linked)`);
+
+				// Check .env
+				const envPath = join(cwd, ".env");
+				if (existsSync(envPath)) {
+					const env = parseEnv(readFileSync(envPath, "utf-8"));
+					lines.push(`- **DB_CONNECTION**: ${env.DB_CONNECTION ?? "not set"}`);
+					lines.push(`- **DB_HOST**: ${env.DB_HOST ?? "not set"}`);
+					lines.push(`- **DB_PORT**: ${env.DB_PORT ?? "not set"}`);
+					lines.push(`- **REDIS_HOST**: ${env.REDIS_HOST ?? "not set"}`);
+				}
+
+				return {
+					content: [{ type: "text", text: lines.join("\n") }],
+					details: {},
+				};
+			} catch (error) {
+				const msg = error instanceof Error ? error.message : String(error);
+				return {
+					content: [{ type: "text", text: `Herd status failed: ${msg}` }],
+					details: {},
+				};
+			}
+		},
+	});
+
+	// ── Tool: herd_logs ──
+	elyra.registerTool({
+		name: "herd_logs",
+		label: "Herd Logs",
+		description:
+			"Read recent error logs from Laravel Herd -- Nginx errors, PHP errors, and Laravel application logs. " +
+			"Use this to debug issues with the local development server.",
+		parameters: Type.Object({
+			type: Type.Optional(
+				Type.Union([Type.Literal("nginx"), Type.Literal("php"), Type.Literal("laravel"), Type.Literal("all")], {
+					description: "Log type to read (default: all)",
+				}),
+			),
+			lines: Type.Optional(
+				Type.Number({ description: "Number of lines to read (default: 50)" }),
+			),
+		}),
+		execute: async (_toolCallId, params) => {
+			try {
+				const logType = params.type ?? "all";
+				const lineCount = params.lines ?? 50;
+				const cwd = process.cwd();
+				const lines: string[] = ["# Herd Logs", ""];
+
+				if (logType === "nginx" || logType === "all") {
+					lines.push("## Nginx Error Log");
+					const nginxLog = readLogFile(join(getHerdLogDir(), "nginx-error.log"), lineCount);
+					lines.push(nginxLog || "No recent errors.");
+					lines.push("");
+				}
+
+				if (logType === "php" || logType === "all") {
+					lines.push("## PHP Error Log");
+					const phpLog = readLogFile(join(getHerdLogDir(), "php-error.log"), lineCount);
+					lines.push(phpLog || "No recent errors.");
+					lines.push("");
+				}
+
+				if (logType === "laravel" || logType === "all") {
+					lines.push("## Laravel Application Log");
+					const laravelLog = readLogFile(join(cwd, "storage", "logs", "laravel.log"), lineCount);
+					lines.push(laravelLog || "No recent entries.");
+					lines.push("");
+				}
+
+				return {
+					content: [{ type: "text", text: lines.join("\n") }],
+					details: {},
+				};
+			} catch (error) {
+				const msg = error instanceof Error ? error.message : String(error);
+				return {
+					content: [{ type: "text", text: `Log reading failed: ${msg}` }],
+					details: {},
+				};
+			}
+		},
+	});
+
+	// ── Tool: herd_env_sync ──
+	elyra.registerTool({
+		name: "herd_env_sync",
+		label: "Herd .env Sync Check",
+		description:
+			"Check if the project's .env file matches the Laravel Herd environment. " +
+			"Verifies database host/port, Redis configuration, and service availability. " +
+			"Reports mismatches and suggests fixes.",
+		parameters: Type.Object({}),
+		execute: async (_toolCallId, _params) => {
+			try {
+				const cwd = process.cwd();
+				const envPath = join(cwd, ".env");
+
+				if (!existsSync(envPath)) {
+					return {
+						content: [{ type: "text", text: "No .env file found in the current project." }],
+						details: {},
+					};
+				}
+
+				const env = parseEnv(readFileSync(envPath, "utf-8"));
+				const issues: string[] = [];
+				const ok: string[] = [];
+
+				// Check DB connection
+				const dbConnection = env.DB_CONNECTION;
+				if (dbConnection === "mysql") {
+					const dbHost = env.DB_HOST ?? "";
+					if (dbHost !== "127.0.0.1" && dbHost !== "localhost") {
+						issues.push(`DB_HOST is '${dbHost}' -- Herd MySQL runs on 127.0.0.1. Change DB_HOST=127.0.0.1`);
+					} else {
+						ok.push("DB_HOST matches Herd MySQL");
+					}
+
+					const dbPort = env.DB_PORT ?? "3306";
+					if (dbPort !== "3306") {
+						issues.push(`DB_PORT is '${dbPort}' -- Herd MySQL default is 3306`);
+					} else {
+						ok.push("DB_PORT matches Herd default");
+					}
+				}
+
+				if (dbConnection === "pgsql") {
+					const dbPort = env.DB_PORT ?? "5432";
+					if (dbPort !== "5432") {
+						issues.push(`DB_PORT is '${dbPort}' -- Herd PostgreSQL default is 5432`);
+					} else {
+						ok.push("DB_PORT matches Herd PostgreSQL default");
+					}
+				}
+
+				// Check Redis
+				if (env.REDIS_HOST && env.REDIS_HOST !== "127.0.0.1" && env.REDIS_HOST !== "localhost") {
+					issues.push(`REDIS_HOST is '${env.REDIS_HOST}' -- Herd Redis runs on 127.0.0.1`);
+				} else if (env.REDIS_HOST) {
+					ok.push("REDIS_HOST matches Herd");
+				}
+
+				// Check common issues
+				if (env.APP_URL && !env.APP_URL.includes(".test")) {
+					issues.push(`APP_URL is '${env.APP_URL}' -- Herd uses .test domains (e.g., http://${basename(cwd)}.test)`);
+				} else if (env.APP_URL) {
+					ok.push("APP_URL uses .test domain");
+				}
+
+				// Check mail
+				if (env.MAIL_MAILER === "smtp" && env.MAIL_HOST === "127.0.0.1" && env.MAIL_PORT === "2525") {
+					ok.push("Mail configured for Herd Mailpit");
+				} else if (env.MAIL_MAILER === "smtp") {
+					issues.push("MAIL_HOST/MAIL_PORT may not match Herd Mailpit (127.0.0.1:2525)");
+				}
+
+				const lines: string[] = ["# Herd .env Sync Check", ""];
+
+				if (issues.length === 0) {
+					lines.push("All .env values match Herd configuration.");
+				} else {
+					lines.push(`Found ${issues.length} issue${issues.length > 1 ? "s" : ""}:`, "");
+					for (const issue of issues) {
+						lines.push(`- ${issue}`);
+					}
+				}
+
+				if (ok.length > 0) {
+					lines.push("", "Matching:");
+					for (const item of ok) {
+						lines.push(`- ${item}`);
+					}
+				}
+
+				return {
+					content: [{ type: "text", text: lines.join("\n") }],
+					details: { issues: issues.length, ok: ok.length },
+				};
+			} catch (error) {
+				const msg = error instanceof Error ? error.message : String(error);
+				return {
+					content: [{ type: "text", text: `Env sync check failed: ${msg}` }],
+					details: {},
+				};
+			}
+		},
+	});
+
+	// ── Tool: herd_php ──
+	elyra.registerTool({
+		name: "herd_php",
+		label: "Herd PHP Version",
+		description:
+			"Show or switch the PHP version used by Laravel Herd. " +
+			"Lists available PHP versions and the currently active one.",
+		parameters: Type.Object({
+			version: Type.Optional(
+				Type.String({ description: "PHP version to switch to (e.g., '8.3', '8.4'). Omit to show current." }),
+			),
+		}),
+		execute: async (_toolCallId, params) => {
+			try {
+				if (!isHerdInstalled()) {
+					return {
+						content: [{ type: "text", text: "Herd CLI not found." }],
+						details: {},
+					};
+				}
+
+				if (params.version) {
+					const result = herd(`use php ${params.version} 2>&1`);
+					return {
+						content: [{ type: "text", text: `Switched PHP to ${params.version}:\n${result}` }],
+						details: {},
+					};
+				}
+
+				const current = herd("php --version 2>/dev/null").split("\n")[0];
+				const lines = [
+					"# PHP Version",
+					"",
+					`**Current**: ${current}`,
+					"",
+					"To switch: use `herd_php` with a version parameter (e.g., '8.3', '8.4')",
+				];
+
+				return {
+					content: [{ type: "text", text: lines.join("\n") }],
+					details: {},
+				};
+			} catch (error) {
+				const msg = error instanceof Error ? error.message : String(error);
+				return {
+					content: [{ type: "text", text: `PHP version check failed: ${msg}` }],
+					details: {},
+				};
+			}
+		},
+	});
+
+	// ── Commands ──
+	elyra.registerCommand("herd", {
+		description: "Show Laravel Herd dashboard -- services, sites, PHP version",
+		handler: async (_args, _ctx) => {
+			elyra.sendUserMessage("Show me the Laravel Herd status: PHP version, running services, linked sites, and current project info.");
+		},
+	});
+
+	elyra.registerCommand("herd-logs", {
+		description: "Show recent Herd error logs",
+		handler: async (_args, _ctx) => {
+			elyra.sendUserMessage("Show me the recent error logs from Herd -- Nginx, PHP, and Laravel application logs.");
+		},
+	});
+
+	elyra.registerCommand("herd-sync", {
+		description: "Check if .env matches Herd configuration",
+		handler: async (_args, _ctx) => {
+			elyra.sendUserMessage("Check if my .env file matches the Laravel Herd environment and report any mismatches.");
+		},
+	});
+}
+
+function isHerdInstalled(): boolean {
+	try {
+		execSync("which herd 2>/dev/null || where herd 2>/dev/null", {
+			timeout: 5000,
+			encoding: "utf-8",
+			stdio: ["pipe", "pipe", "pipe"],
+		});
+		return true;
+	} catch {
+		return false;
+	}
+}
+
+function herd(command: string): string {
+	return execSync(`herd ${command}`, {
+		timeout: 15000,
+		encoding: "utf-8",
+		stdio: ["pipe", "pipe", "pipe"],
+	}).trim();
+}
+
+function getHerdLogDir(): string {
+	// macOS Herd log location
+	const home = process.env.HOME ?? "";
+	return join(home, "Library", "Application Support", "Herd", "Log");
+}
+
+function readLogFile(path: string, lines: number): string {
+	if (!existsSync(path)) return "";
+	try {
+		const content = readFileSync(path, "utf-8");
+		const allLines = content.split("\n");
+		return allLines.slice(-lines).join("\n").trim();
+	} catch {
+		return "";
+	}
+}
+
+function parseEnv(content: string): Record<string, string> {
+	const result: Record<string, string> = {};
+	for (const line of content.split("\n")) {
+		const trimmed = line.trim();
+		if (!trimmed || trimmed.startsWith("#")) continue;
+		const eqIndex = trimmed.indexOf("=");
+		if (eqIndex === -1) continue;
+		const key = trimmed.slice(0, eqIndex).trim();
+		let value = trimmed.slice(eqIndex + 1).trim();
+		if ((value.startsWith('"') && value.endsWith('"')) || (value.startsWith("'") && value.endsWith("'"))) {
+			value = value.slice(1, -1);
+		}
+		result[key] = value;
+	}
+	return result;
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@elyracode/herd",
+  "version": "0.5.3",
+  "description": "Elyra extension for Laravel Herd -- environment detection, service management, logs, and .env sync",
+  "type": "module",
+  "keywords": ["elyra-package", "herd", "laravel-herd", "local-dev", "php", "mysql", "redis"],
+  "license": "MIT",
+  "author": "Knut W. Horne",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kwhorne/elyra.git",
+    "directory": "packages/herd"
+  },
+  "elyra": {
+    "extensions": ["./extensions/index.ts"]
+  },
+  "peerDependencies": {
+    "@elyracode/coding-agent": "*",
+    "typebox": "*"
+  },
+  "scripts": {
+    "clean": "echo 'nothing to clean'",
+    "build": "echo 'nothing to build'",
+    "check": "echo 'nothing to check'"
+  }
+}