aeo-ready 1.1.0 → 1.2.0

package/src/fix/generators/agents-json.js

@@ -1,73 +0,0 @@
-import { existsSync, readFileSync } from "fs";
-import { join } from "path";
-
-export function generateAgentsJson(check, scanResult, dir) {
-  const { siteType, target } = scanResult;
-
-  const hostname = extractHostname(target);
-  const name = inferName(dir, hostname);
-
-  const manifest = {
-    schema_version: "1.0",
-    name,
-    description: "",
-    url: target || "",
-    site_type: siteType,
-    interfaces: {
-      human: "/",
-      llm: "/llms.txt",
-      structured: "/.well-known/agent.json",
-    },
-    capabilities: getCapabilities(siteType),
-    contact: {},
-  };
-
-  if (siteType === "saas" || siteType === "api") {
-    manifest.api_base = "";
-    manifest.openapi = "/openapi.json";
-    manifest.protocols = ["rest"];
-  }
-
-  return {
-    file: ".well-known/agent.json",
-    description: `Agent manifest for ${siteType} site — fill in description and contact`,
-    draft: true,
-    content: JSON.stringify(manifest, null, 2) + "\n",
-  };
-}
-
-function getCapabilities(siteType) {
-  switch (siteType) {
-    case "saas":
-      return ["pricing-lookup", "api-integration", "trial-signup"];
-    case "api":
-      return ["api-integration", "sdk-install", "docs-lookup"];
-    case "content":
-      return ["content-search", "topic-lookup", "citation"];
-    case "personal":
-      return ["contact", "expertise-lookup", "project-listing"];
-    default:
-      return [];
-  }
-}
-
-function extractHostname(target) {
-  if (!target) return null;
-  try {
-    return new URL(target).hostname.replace("www.", "");
-  } catch {
-    return null;
-  }
-}
-
-function inferName(dir, hostname) {
-  const pkgPath = join(dir, "package.json");
-  if (existsSync(pkgPath)) {
-    try {
-      const pkg = JSON.parse(readFileSync(pkgPath, "utf8"));
-      if (pkg.name) return pkg.name;
-    } catch {}
-  }
-  if (hostname) return hostname.split(".")[0];
-  return "";
-}

package/src/fix/generators/agents-md.js

@@ -1,85 +0,0 @@
-import { existsSync, readFileSync, readdirSync } from "fs";
-import { join } from "path";
-
-export function generateAgentsMd(check, scanResult, dir) {
-  const { siteType, target } = scanResult;
-  const name = inferName(dir);
-  const structure = inferStructure(dir);
-
-  const content = `# ${name || "[Project Name]"}
-
-> [One sentence: what this project does]
-
-## Project structure
-
-${structure || "```\n[Add key directories and their purpose]\n```"}
-
-## Key files
-
-- Entry point: [path]
-- Config: [path]
-- API routes: [path]
-
-## Development
-
-\`\`\`bash
-[install command]
-[run command]
-\`\`\`
-
-## Conventions
-
-- [Language/framework convention 1]
-- [Language/framework convention 2]
-
-## Constraints
-
-- [Rate limits, auth requirements, etc]
-- [External dependencies]
-`;
-
-  return {
-    file: "AGENTS.md",
-    description: "Draft AGENTS.md — REVIEW AND EDIT with real project details",
-    draft: true,
-    content,
-  };
-}
-
-function inferName(dir) {
-  const pkgPath = join(dir, "package.json");
-  if (existsSync(pkgPath)) {
-    try {
-      return JSON.parse(readFileSync(pkgPath, "utf8")).name || "";
-    } catch {}
-  }
-  const pomPath = join(dir, "pom.xml");
-  if (existsSync(pomPath)) {
-    const pom = readFileSync(pomPath, "utf8");
-    const match = pom.match(/<artifactId>([^<]+)<\/artifactId>/);
-    if (match) return match[1];
-  }
-  return "";
-}
-
-function inferStructure(dir) {
-  try {
-    const entries = readdirSync(dir, { withFileTypes: true });
-    const dirs = entries
-      .filter(
-        (e) =>
-          e.isDirectory() &&
-          !e.name.startsWith(".") &&
-          e.name !== "node_modules",
-      )
-      .map((e) => e.name)
-      .slice(0, 10);
-
-    if (dirs.length === 0) return null;
-
-    const lines = dirs.map((d) => `${d}/`);
-    return "```\n" + lines.join("\n") + "\n```";
-  } catch {
-    return null;
-  }
-}

package/src/fix/generators/llms-txt.js

@@ -1,166 +0,0 @@
-import { existsSync, readFileSync } from "fs";
-import { join } from "path";
-
-export function generateLlmsTxt(check, scanResult, dir) {
-  const { siteType, target } = scanResult;
-  const hostname = extractHostname(target);
-  const name = inferName(dir, hostname);
-
-  const content = generateByType(siteType, name, target);
-
-  return {
-    file: "llms.txt",
-    description: `Draft llms.txt for ${siteType} site — REVIEW AND EDIT before publishing`,
-    draft: true,
-    content,
-  };
-}
-
-function generateByType(siteType, name, target) {
-  const base = target || "https://example.com";
-
-  switch (siteType) {
-    case "saas":
-      return `# ${name || "[Company Name]"}
-
-> [One sentence: what problem you solve and for whom]
-
-## What it does
-- [Core capability 1]
-- [Core capability 2]
-- [Core capability 3]
-
-## Pricing
-- [Plan 1]: $X/mo — [what's included]
-- [Plan 2]: $X/mo — [what's included]
-- Details: ${base}/pricing
-
-## Integration
-- API docs: ${base}/docs
-- OpenAPI spec: ${base}/openapi.json
-- Auth: [API key / OAuth / etc]
-
-## Get started
-1. [Signup step]
-2. [First API call or setup]
-3. [See results]
-
-## Links
-- Documentation: ${base}/docs
-- Changelog: ${base}/changelog
-- Status: ${base}/status
-`;
-
-    case "api":
-      return `# ${name || "[Tool Name]"}
-
-> [One sentence: what this tool does]
-
-## Quick start
-\`\`\`bash
-[install command]
-\`\`\`
-
-## Key concepts
-- [Concept 1]: [one-line explanation]
-- [Concept 2]: [one-line explanation]
-
-## API reference
-- Base URL: ${base}/api/v1
-- Auth: [method]
-- OpenAPI: ${base}/openapi.json
-
-## SDKs
-- Node.js: \`npm install [package]\`
-- Python: \`pip install [package]\`
-
-## Links
-- Full docs: ${base}/docs
-- Examples: ${base}/examples
-- Changelog: ${base}/changelog
-`;
-
-    case "personal":
-      return `# ${name || "[Your Name]"}
-
-> [Role/title] — [what you're known for]
-
-## Expertise
-- [Area 1]
-- [Area 2]
-- [Area 3]
-
-## Notable work
-- [Project 1]: [one-line description] — [url]
-- [Project 2]: [one-line description] — [url]
-
-## Writing & speaking
-- [Topic you cover]
-- [Where to find your content]
-
-## Contact
-- Email: [email]
-- LinkedIn: [url]
-- Available for: [consulting / speaking / hiring / etc]
-`;
-
-    case "content":
-      return `# ${name || "[Publication Name]"}
-
-> [What topics you cover and your angle/expertise]
-
-## Topics
-- [Topic 1]: [what you cover, how many pieces]
-- [Topic 2]: [what you cover, how many pieces]
-
-## Best starting points
-- [Most important article]: ${base}/[path]
-- [Second article]: ${base}/[path]
-- [Third article]: ${base}/[path]
-
-## About
-- Author(s): [who writes]
-- Cadence: [how often you publish]
-- Angle: [what makes your coverage unique]
-
-## Links
-- All articles: ${base}/blog
-- RSS: ${base}/feed.xml
-- Newsletter: ${base}/subscribe
-`;
-
-    default:
-      return `# ${name || "[Site Name]"}
-
-> [One sentence: what this site is and who it's for]
-
-## What you'll find here
-- [Section 1]: [description]
-- [Section 2]: [description]
-
-## Links
-- Homepage: ${base}
-`;
-  }
-}
-
-function extractHostname(target) {
-  if (!target) return null;
-  try {
-    return new URL(target).hostname.replace("www.", "");
-  } catch {
-    return null;
-  }
-}
-
-function inferName(dir, hostname) {
-  const pkgPath = join(dir, "package.json");
-  if (existsSync(pkgPath)) {
-    try {
-      const pkg = JSON.parse(readFileSync(pkgPath, "utf8"));
-      if (pkg.name) return pkg.name;
-    } catch {}
-  }
-  if (hostname) return hostname.split(".")[0];
-  return "";
-}

package/src/fix/generators/robots-txt.js

@@ -1,64 +0,0 @@
-import { existsSync, readFileSync } from "fs";
-import { join } from "path";
-
-const AI_CRAWLERS = [
-  "GPTBot",
-  "OAI-SearchBot",
-  "ClaudeBot",
-  "Claude-User",
-  "Claude-SearchBot",
-  "Google-Extended",
-  "PerplexityBot",
-  "Meta-ExternalAgent",
-  "CCBot",
-];
-
-export function generateRobotsTxt(check, scanResult, dir) {
-  const filePath = join(dir, "robots.txt");
-  const exists = existsSync(filePath);
-
-  if (exists) {
-    return {
-      file: "robots.txt",
-      description: "Add missing AI crawler rules",
-      draft: false,
-      merge: mergeRobotsTxt,
-      content: generateCrawlerBlock(),
-    };
-  }
-
-  return {
-    file: "robots.txt",
-    description: "Allow all AI crawlers for maximum agent discoverability",
-    draft: false,
-    content: generateFullRobotsTxt(),
-  };
-}
-
-function mergeRobotsTxt(existing, newContent) {
-  const presentBots = AI_CRAWLERS.filter((bot) => existing.includes(bot));
-  const missingBots = AI_CRAWLERS.filter((bot) => !existing.includes(bot));
-
-  if (missingBots.length === 0) return existing;
-
-  const additions = missingBots
-    .map((bot) => `User-agent: ${bot}\nAllow: /\n`)
-    .join("\n");
-
-  return (
-    existing.trimEnd() + "\n\n# AI crawlers (added by agent-web)\n" + additions
-  );
-}
-
-function generateCrawlerBlock() {
-  return AI_CRAWLERS.map((bot) => `User-agent: ${bot}\nAllow: /\n`).join("\n");
-}
-
-function generateFullRobotsTxt() {
-  let content = "User-agent: *\nAllow: /\n\n";
-  content += "# AI crawlers — explicit allow for agent discoverability\n";
-  content += AI_CRAWLERS.map((bot) => `User-agent: ${bot}\nAllow: /\n`).join(
-    "\n",
-  );
-  return content;
-}

package/src/fix/index.js

@@ -1,177 +0,0 @@
-import chalk from "chalk";
-import { writeFileSync, existsSync, readFileSync, mkdirSync } from "fs";
-import { join, dirname } from "path";
-import { generateRobotsTxt } from "./generators/robots-txt.js";
-import { generateAgentsJson } from "./generators/agents-json.js";
-import { generateLlmsTxt } from "./generators/llms-txt.js";
-import { generateAgentsMd } from "./generators/agents-md.js";
-import { generateDashboard } from "../dashboard/generate.js";
-
-export async function fix(beforeResult, dir, rescanFn) {
-  const failedChecks = getAllFailedChecks(beforeResult);
-  const applied = [];
-  const manual = [];
-
-  for (const check of failedChecks) {
-    const result = await generateFix(check, beforeResult, dir);
-    if (result) {
-      if (result.draft) {
-        manual.push(result);
-      } else {
-        writeFix(result, dir);
-        applied.push(result);
-      }
-    } else {
-      manual.push({ description: check.fix, name: check.name });
-    }
-  }
-
-  const afterResult = rescanFn ? await rescanFn() : null;
-
-  printSummary(beforeResult, afterResult, applied, manual);
-
-  if (afterResult && dir) {
-    const dashPath = await generateDashboard(afterResult, dir, {
-      beforeResult,
-    });
-    console.log(chalk.dim(`  Dashboard: ${dashPath}\n`));
-  }
-
-  return { applied, manual, afterResult };
-}
-
-function printSummary(before, after, applied, manual) {
-  const beforeScore = before.score;
-  const afterScore = after ? after.score : null;
-
-  console.log(chalk.bold("\n  aeo-ready --fix\n"));
-
-  if (afterScore !== null) {
-    const delta = afterScore - beforeScore;
-    const deltaStr =
-      delta > 0
-        ? chalk.green(` (+${delta})`)
-        : delta < 0
-          ? chalk.red(` (${delta})`)
-          : "";
-    const beforeGrade = gradeColor(before.grade)(`${beforeScore}`);
-    const afterGrade = gradeColor(after.grade)(`${afterScore}`);
-    console.log(
-      `  ${beforeGrade}${chalk.dim("/100")} ${chalk.dim("->")} ${afterGrade}${chalk.dim("/100")}${deltaStr}\n`,
-    );
-
-    const bA = before.agentReadiness.score;
-    const bV = before.aiVisibility.score;
-    const aA = after.agentReadiness.score;
-    const aV = after.aiVisibility.score;
-    const dA = aA - bA;
-    const dV = aV - bV;
-    const fmtDelta = (d) =>
-      d > 0 ? chalk.green(`+${d}`) : d < 0 ? chalk.red(`${d}`) : chalk.dim("—");
-
-    console.log(
-      chalk.dim("  Agent Readiness  ") +
-        `${bA} -> ${aA} ${fmtDelta(dA)}` +
-        chalk.dim("  can agents find, read, and use your site?"),
-    );
-    console.log(
-      chalk.dim("  AI Visibility    ") +
-        `${bV} -> ${aV} ${fmtDelta(dV)}` +
-        chalk.dim("  how accurately do AI engines describe you?"),
-    );
-
-    if (bA < 25) {
-      console.log(
-        chalk.dim(
-          "\n  Agent Readiness is low — AI engines can't cite what they can't read.",
-        ),
-      );
-      console.log(chalk.dim("  Fix the agent side first. Visibility follows."));
-    }
-  } else {
-    console.log(
-      `  ${chalk.dim("Score:")} ${beforeScore}/100 (${before.grade})\n`,
-    );
-  }
-
-  if (applied.length > 0) {
-    console.log(chalk.bold("\n  We fixed:"));
-    for (const fix of applied) {
-      console.log(
-        chalk.green(`    + ${fix.file}`) + chalk.dim(` — ${fix.description}`),
-      );
-    }
-  }
-
-  const humanTasks = manual.filter((m) => m.description);
-  if (humanTasks.length > 0) {
-    console.log(chalk.bold("\n  You still need to:"));
-    for (const task of humanTasks.slice(0, 6)) {
-      console.log(chalk.dim(`    - ${task.description}`));
-    }
-    if (humanTasks.length > 6) {
-      console.log(chalk.dim(`    ... and ${humanTasks.length - 6} more`));
-    }
-  }
-
-  console.log("");
-}
-
-function writeFix(fix, dir) {
-  const filePath = join(dir, fix.file);
-  const fileDir = dirname(filePath);
-  if (!existsSync(fileDir)) mkdirSync(fileDir, { recursive: true });
-
-  if (existsSync(filePath) && fix.merge) {
-    const existing = readFileSync(filePath, "utf8");
-    const merged = fix.merge(existing, fix.content);
-    writeFileSync(filePath, merged);
-  } else {
-    writeFileSync(filePath, fix.content);
-  }
-}
-
-async function generateFix(check, scanResult, dir) {
-  switch (check.name) {
-    case "robots.txt AI crawlers":
-      return generateRobotsTxt(check, scanResult, dir);
-    case "agents.json manifest":
-      return generateAgentsJson(check, scanResult, dir);
-    case "AGENTS.md / CLAUDE.md":
-      return generateAgentsMd(check, scanResult, dir);
-    case "llms.txt":
-      return generateLlmsTxt(check, scanResult, dir);
-    default:
-      return null;
-  }
-}
-
-function getAllFailedChecks(scanResult) {
-  const checks = [];
-  for (const scorecard of [
-    scanResult.agentReadiness,
-    scanResult.aiVisibility,
-  ]) {
-    for (const cat of Object.values(scorecard.categories)) {
-      for (const check of cat.checks) {
-        if (!check.passed) {
-          checks.push(check);
-        }
-      }
-    }
-  }
-  return checks;
-}
-
-function gradeColor(grade) {
-  switch (grade) {
-    case "A":
-      return chalk.green;
-    case "B":
-      return chalk.cyan;
-    case "C":
-      return chalk.yellow;
-    default:
-      return chalk.red;
-  }
-}