@gethmy/mcp 1.0.0 → 2.1.0

package/src/tui/docs.ts

@@ -0,0 +1,650 @@
+import {
+  existsSync,
+  readFileSync,
+  readdirSync,
+  statSync,
+} from "node:fs";
+import { join } from "node:path";
+import * as p from "@clack/prompts";
+import { colors, symbols } from "./theme.js";
+
+// ── Types ───────────────────────────────────────────────────────────────────
+
+export interface ProjectInfo {
+  packageManager: "bun" | "pnpm" | "yarn" | "npm" | null;
+  scripts: Record<string, string>;
+  language: "typescript" | "javascript" | "go" | "rust" | "python" | "unknown";
+  framework: string | null;
+  linter: string | null;
+  indentStyle: { type: "space" | "tab"; width: number } | null;
+  dirs: string[];
+  srcDirs: string[];
+  monorepo: boolean;
+  existingDocs: {
+    agentsMd: boolean;
+    claudeMd: boolean;
+    docsDir: boolean;
+    architectureMd: boolean;
+  };
+}
+
+export interface DocsIssue {
+  severity: "error" | "warning";
+  file: string;
+  message: string;
+  fix?: string;
+}
+
+export interface DocsStepResult {
+  files: Array<{ path: string; content: string; type: "text" }>;
+  issues: DocsIssue[];
+  skipped: boolean;
+}
+
+// ── Helpers ─────────────────────────────────────────────────────────────────
+
+const IGNORED_DIRS = new Set([
+  "node_modules",
+  ".git",
+  "dist",
+  "build",
+  ".next",
+  ".nuxt",
+  ".output",
+  ".vercel",
+  ".turbo",
+  ".cache",
+  "coverage",
+  ".harmony-worktrees",
+  "__pycache__",
+  "target",
+  "vendor",
+]);
+
+/** Read a JSON file safely, returning null on failure. */
+function readJson(filePath: string): Record<string, unknown> | null {
+  try {
+    return JSON.parse(readFileSync(filePath, "utf-8"));
+  } catch {
+    return null;
+  }
+}
+
+/** Read a text file safely, returning null on failure. */
+function readText(filePath: string): string | null {
+  try {
+    return readFileSync(filePath, "utf-8");
+  } catch {
+    return null;
+  }
+}
+
+/** List immediate subdirectories, excluding ignored names. */
+function listDirs(dirPath: string): string[] {
+  try {
+    return readdirSync(dirPath).filter((entry) => {
+      if (IGNORED_DIRS.has(entry) || entry.startsWith(".")) return false;
+      try {
+        return statSync(join(dirPath, entry)).isDirectory();
+      } catch {
+        return false;
+      }
+    });
+  } catch {
+    return [];
+  }
+}
+
+/** Map of common directory names to short descriptions. */
+const DIR_DESCRIPTIONS: Record<string, string> = {
+  components: "UI components",
+  pages: "Route-level pages",
+  routes: "Route-level pages",
+  views: "Route-level pages",
+  hooks: "Custom hooks",
+  lib: "Utilities",
+  utils: "Utilities",
+  api: "API / server code",
+  server: "API / server code",
+  contexts: "State management",
+  store: "State management",
+  stores: "State management",
+  types: "Type definitions",
+  styles: "Stylesheets",
+  public: "Static assets",
+  static: "Static assets",
+  assets: "Static assets",
+  supabase: "Supabase backend",
+  functions: "Edge functions",
+  packages: "Monorepo packages",
+  apps: "Monorepo applications",
+  src: "Source code",
+  test: "Tests",
+  tests: "Tests",
+  __tests__: "Tests",
+  scripts: "Build / utility scripts",
+  config: "Configuration",
+  docs: "Documentation",
+  migrations: "Database migrations",
+  prisma: "Prisma schema & migrations",
+  e2e: "End-to-end tests",
+  cypress: "Cypress tests",
+};
+
+function describeDir(name: string): string {
+  return DIR_DESCRIPTIONS[name.toLowerCase()] ?? name;
+}
+
+// ── Core functions ──────────────────────────────────────────────────────────
+
+/**
+ * Scan the project directory and return structured metadata.
+ * Pure static analysis — no AI, no network calls.
+ */
+export function scanProject(cwd: string): ProjectInfo {
+  // Package manager
+  let packageManager: ProjectInfo["packageManager"] = null;
+  if (existsSync(join(cwd, "bun.lock")) || existsSync(join(cwd, "bun.lockb"))) {
+    packageManager = "bun";
+  } else if (existsSync(join(cwd, "pnpm-lock.yaml"))) {
+    packageManager = "pnpm";
+  } else if (existsSync(join(cwd, "yarn.lock"))) {
+    packageManager = "yarn";
+  } else if (existsSync(join(cwd, "package.json"))) {
+    packageManager = "npm";
+  }
+
+  // Scripts
+  const pkg = readJson(join(cwd, "package.json"));
+  const scripts: Record<string, string> =
+    pkg && typeof pkg.scripts === "object" && pkg.scripts !== null
+      ? (pkg.scripts as Record<string, string>)
+      : {};
+
+  // Language
+  let language: ProjectInfo["language"] = "unknown";
+  if (existsSync(join(cwd, "tsconfig.json"))) {
+    language = "typescript";
+  } else if (existsSync(join(cwd, "go.mod"))) {
+    language = "go";
+  } else if (existsSync(join(cwd, "Cargo.toml"))) {
+    language = "rust";
+  } else if (
+    existsSync(join(cwd, "setup.py")) ||
+    existsSync(join(cwd, "pyproject.toml"))
+  ) {
+    language = "python";
+  } else if (pkg) {
+    language = "javascript";
+  }
+
+  // Framework detection (from package.json dependencies)
+  let framework: string | null = null;
+  if (pkg) {
+    const deps: Record<string, string> = {
+      ...(typeof pkg.dependencies === "object" ? (pkg.dependencies as Record<string, string>) : {}),
+      ...(typeof pkg.devDependencies === "object" ? (pkg.devDependencies as Record<string, string>) : {}),
+    };
+
+    if (deps.next) {
+      framework = "next";
+    } else if (deps.react && deps.vite) {
+      framework = "react+vite";
+    } else if (deps.react) {
+      framework = "react";
+    } else if (deps.vue && deps.vite) {
+      framework = "vue+vite";
+    } else if (deps.vue && deps.nuxt) {
+      framework = "nuxt";
+    } else if (deps.vue) {
+      framework = "vue";
+    } else if (deps.astro) {
+      framework = "astro";
+    } else if (deps.svelte) {
+      framework = "svelte";
+    } else if (deps.express) {
+      framework = "express";
+    } else if (deps.fastify) {
+      framework = "fastify";
+    } else if (deps.hono) {
+      framework = "hono";
+    }
+  }
+
+  // Linter
+  let linter: string | null = null;
+  if (
+    existsSync(join(cwd, "biome.json")) ||
+    existsSync(join(cwd, "biome.jsonc"))
+  ) {
+    linter = "biome";
+  } else {
+    const eslintFiles = [
+      ".eslintrc",
+      ".eslintrc.js",
+      ".eslintrc.cjs",
+      ".eslintrc.json",
+      ".eslintrc.yml",
+      ".eslintrc.yaml",
+      "eslint.config.js",
+      "eslint.config.mjs",
+      "eslint.config.cjs",
+      "eslint.config.ts",
+    ];
+    if (eslintFiles.some((f) => existsSync(join(cwd, f)))) {
+      linter = "eslint";
+    } else {
+      const prettierFiles = [
+        ".prettierrc",
+        ".prettierrc.js",
+        ".prettierrc.json",
+        ".prettierrc.yml",
+        ".prettierrc.yaml",
+        "prettier.config.js",
+        "prettier.config.mjs",
+      ];
+      if (prettierFiles.some((f) => existsSync(join(cwd, f)))) {
+        linter = "prettier";
+      }
+    }
+  }
+
+  // Indent style
+  let indentStyle: ProjectInfo["indentStyle"] = null;
+  const biome =
+    readJson(join(cwd, "biome.json")) ?? readJson(join(cwd, "biome.jsonc"));
+  if (biome) {
+    const formatter = biome.formatter as Record<string, unknown> | undefined;
+    if (formatter) {
+      const type = formatter.indentStyle === "tab" ? "tab" : "space";
+      const width =
+        typeof formatter.indentWidth === "number" ? formatter.indentWidth : 2;
+      indentStyle = { type, width };
+    }
+  }
+  if (!indentStyle) {
+    const editorConfig = readText(join(cwd, ".editorconfig"));
+    if (editorConfig) {
+      const styleMatch = editorConfig.match(/indent_style\s*=\s*(space|tab)/);
+      const sizeMatch = editorConfig.match(/indent_size\s*=\s*(\d+)/);
+      if (styleMatch) {
+        indentStyle = {
+          type: styleMatch[1] as "space" | "tab",
+          width: sizeMatch ? Number.parseInt(sizeMatch[1], 10) : 2,
+        };
+      }
+    }
+  }
+
+  // Directories
+  const dirs = listDirs(cwd);
+  const srcDirs = existsSync(join(cwd, "src"))
+    ? listDirs(join(cwd, "src"))
+    : [];
+
+  // Monorepo
+  const monorepo =
+    existsSync(join(cwd, "packages")) || existsSync(join(cwd, "apps"));
+
+  // Existing docs
+  const existingDocs = {
+    agentsMd: existsSync(join(cwd, "AGENTS.md")),
+    claudeMd: existsSync(join(cwd, "CLAUDE.md")),
+    docsDir: existsSync(join(cwd, "docs")),
+    architectureMd: existsSync(join(cwd, "docs", "architecture.md")),
+  };
+
+  return {
+    packageManager,
+    scripts,
+    language,
+    framework,
+    linter,
+    indentStyle,
+    dirs,
+    srcDirs,
+    monorepo,
+    existingDocs,
+  };
+}
+
+// ── Generators ──────────────────────────────────────────────────────────────
+
+/** Build a human-friendly run command prefix. */
+function runCmd(pm: ProjectInfo["packageManager"]): string {
+  if (pm === "bun") return "bun run";
+  if (pm === "pnpm") return "pnpm run";
+  if (pm === "yarn") return "yarn";
+  return "npm run";
+}
+
+/** Guess a short description for a package.json script based on its name. */
+function describeScript(name: string): string {
+  const map: Record<string, string> = {
+    dev: "Dev server",
+    start: "Start server",
+    build: "Production build",
+    lint: "Lint",
+    "lint:fix": "Lint + autofix",
+    format: "Format code",
+    test: "Run tests",
+    "test:watch": "Run tests (watch)",
+    "test:e2e": "End-to-end tests",
+    typecheck: "Type-check",
+    "type-check": "Type-check",
+    preview: "Preview production build",
+    deploy: "Deploy",
+    generate: "Code generation",
+    migrate: "Run migrations",
+    seed: "Seed database",
+    clean: "Clean build artifacts",
+    prepare: "Prepare (husky, etc.)",
+  };
+  return map[name] ?? "";
+}
+
+/**
+ * Generate a scaffold AGENTS.md from project metadata.
+ */
+export function generateAgentsMd(info: ProjectInfo, _cwd: string): string {
+  const lang = info.language === "typescript" ? "TypeScript" : info.language === "javascript" ? "JavaScript" : info.language;
+  const frameworkLabel = info.framework ? `${info.framework} ` : "";
+  const monoLabel = info.monorepo ? " (monorepo)" : "";
+
+  const lines: string[] = [];
+  lines.push("# AGENTS.md");
+  lines.push("");
+  lines.push(`${frameworkLabel}${lang} project${monoLabel}.`);
+  lines.push("");
+
+  // Commands
+  const scriptEntries = Object.entries(info.scripts);
+  if (scriptEntries.length > 0 && info.packageManager) {
+    const prefix = runCmd(info.packageManager);
+    lines.push("## Commands");
+    lines.push("");
+    lines.push("```bash");
+
+    // Calculate padding for alignment
+    const commands = scriptEntries.map(([name]) => `${prefix} ${name}`);
+    const maxLen = Math.max(...commands.map((c) => c.length));
+
+    for (let i = 0; i < scriptEntries.length; i++) {
+      const [name] = scriptEntries[i];
+      const cmd = commands[i];
+      const desc = describeScript(name);
+      if (desc) {
+        lines.push(`${cmd}${" ".repeat(maxLen - cmd.length + 4)}# ${desc}`);
+      } else {
+        lines.push(cmd);
+      }
+    }
+
+    lines.push("```");
+    lines.push("");
+  }
+
+  // Code standards
+  lines.push("## Code Standards");
+  lines.push("");
+
+  const langLabel = info.language === "typescript" ? "TypeScript" : "JavaScript";
+  if (info.language === "typescript" || info.language === "javascript") {
+    lines.push(`- ${langLabel} with ES modules`);
+  }
+
+  if (info.indentStyle) {
+    const unit = info.indentStyle.type === "tab" ? "tab" : "space";
+    lines.push(`- ${info.indentStyle.width}-${unit} indentation`);
+  }
+
+  if (info.linter) {
+    lines.push(`- Linted with ${info.linter}`);
+  }
+
+  lines.push("");
+
+  // Architecture
+  lines.push("## Architecture");
+  lines.push("");
+
+  for (const dir of info.dirs) {
+    lines.push(`- \`${dir}/\` — ${describeDir(dir)}`);
+  }
+
+  if (info.srcDirs.length > 0) {
+    for (const sub of info.srcDirs) {
+      lines.push(`  - \`src/${sub}/\` — ${describeDir(sub)}`);
+    }
+  }
+
+  lines.push("");
+  return lines.join("\n");
+}
+
+/**
+ * Generate a lean CLAUDE.md pointer file.
+ */
+export function generateClaudeMd(info: ProjectInfo): string {
+  const lines: string[] = [];
+  lines.push("# CLAUDE.md");
+  lines.push("");
+  lines.push("@AGENTS.md");
+
+  if (info.existingDocs.architectureMd || info.dirs.includes("docs")) {
+    lines.push("@docs/architecture.md");
+  }
+
+  lines.push("");
+  return lines.join("\n");
+}
+
+/**
+ * Generate an architecture.md scaffold.
+ */
+export function generateArchitectureMd(info: ProjectInfo, _cwd: string): string {
+  const lines: string[] = [];
+  lines.push("# Architecture");
+  lines.push("");
+  lines.push("## Directory Structure");
+  lines.push("");
+
+  for (const dir of info.dirs) {
+    lines.push(`- \`${dir}/\` — ${describeDir(dir)}`);
+  }
+
+  if (info.srcDirs.length > 0) {
+    lines.push("");
+    lines.push("### `src/`");
+    lines.push("");
+    for (const sub of info.srcDirs) {
+      lines.push(`- \`src/${sub}/\` — ${describeDir(sub)}`);
+    }
+  }
+
+  lines.push("");
+  return lines.join("\n");
+}
+
+// ── Verification ────────────────────────────────────────────────────────────
+
+/**
+ * Verify existing docs for broken references, stale commands, and dead paths.
+ */
+export function verifyDocs(cwd: string): DocsIssue[] {
+  const issues: DocsIssue[] = [];
+
+  // 1. CLAUDE.md — check @-references
+  const claudeMd = readText(join(cwd, "CLAUDE.md"));
+  if (claudeMd) {
+    for (const line of claudeMd.split("\n")) {
+      const match = line.match(/^@(.+)$/);
+      if (match) {
+        const refPath = match[1].trim();
+        if (!existsSync(join(cwd, refPath))) {
+          issues.push({
+            severity: "error",
+            file: "CLAUDE.md",
+            message: `Referenced file does not exist: ${refPath}`,
+            fix: `Remove the @${refPath} line or create the file`,
+          });
+        }
+      }
+    }
+  }
+
+  // 2. AGENTS.md — check commands against package.json scripts
+  const agentsMd = readText(join(cwd, "AGENTS.md"));
+  const pkg = readJson(join(cwd, "package.json"));
+  const pkgScripts = pkg && typeof pkg.scripts === "object" && pkg.scripts !== null
+    ? (pkg.scripts as Record<string, string>)
+    : {};
+
+  if (agentsMd) {
+    // Extract commands from code blocks
+    const codeBlockRe = /```[\s\S]*?```/g;
+    let blockMatch: RegExpExecArray | null;
+    while ((blockMatch = codeBlockRe.exec(agentsMd)) !== null) {
+      const block = blockMatch[0];
+      // Match lines that look like package manager commands
+      const cmdRe = /(?:bun|npm|pnpm|yarn)\s+(?:run\s+)?(\S+)/g;
+      let cmdMatch: RegExpExecArray | null;
+      while ((cmdMatch = cmdRe.exec(block)) !== null) {
+        const scriptName = cmdMatch[1];
+        // Skip if the script name is a built-in (install, init, etc.)
+        const builtins = new Set(["install", "init", "create", "exec", "dlx", "x", "test", "start"]);
+        if (builtins.has(scriptName)) continue;
+        if (Object.keys(pkgScripts).length > 0 && !(scriptName in pkgScripts)) {
+          issues.push({
+            severity: "warning",
+            file: "AGENTS.md",
+            message: `Command references script "${scriptName}" which is not in package.json`,
+            fix: `Update the command or add "${scriptName}" to package.json scripts`,
+          });
+        }
+      }
+    }
+
+    // 3. Check backtick-quoted paths in AGENTS.md
+    checkBacktickPaths(agentsMd, "AGENTS.md", cwd, issues);
+  }
+
+  // 3b. Check backtick-quoted paths in docs/architecture.md
+  const archMd = readText(join(cwd, "docs", "architecture.md"));
+  if (archMd) {
+    checkBacktickPaths(archMd, "docs/architecture.md", cwd, issues);
+  }
+
+  return issues;
+}
+
+/** Scan markdown for backtick-quoted paths and check they exist. */
+function checkBacktickPaths(
+  content: string,
+  file: string,
+  cwd: string,
+  issues: DocsIssue[],
+): void {
+  const pathRe = /`((?:src\/|packages\/|apps\/|supabase\/|docs\/)[^`]+)`/g;
+  let match: RegExpExecArray | null;
+  const checked = new Set<string>();
+
+  while ((match = pathRe.exec(content)) !== null) {
+    const refPath = match[1].replace(/\/$/, ""); // strip trailing slash
+    if (checked.has(refPath)) continue;
+    checked.add(refPath);
+
+    if (!existsSync(join(cwd, refPath))) {
+      issues.push({
+        severity: "warning",
+        file,
+        message: `Referenced path does not exist: ${refPath}`,
+        fix: `Update or remove the \`${refPath}\` reference`,
+      });
+    }
+  }
+}
+
+// ── TUI Entry Point ─────────────────────────────────────────────────────────
+
+/**
+ * Run the docs step of the setup wizard.
+ * Scans the project, then either scaffolds new docs or verifies existing ones.
+ */
+export async function runDocsStep(cwd: string): Promise<DocsStepResult> {
+  const info = scanProject(cwd);
+  const hasDocs = info.existingDocs.agentsMd || info.existingDocs.claudeMd;
+
+  if (!hasDocs) {
+    // No docs — offer to generate
+    const shouldGenerate = await p.confirm({
+      message: "No project docs found. Generate AGENTS.md and CLAUDE.md?",
+      initialValue: true,
+    });
+
+    if (p.isCancel(shouldGenerate) || !shouldGenerate) {
+      return { files: [], issues: [], skipped: true };
+    }
+
+    const files: DocsStepResult["files"] = [];
+
+    files.push({
+      path: join(cwd, "AGENTS.md"),
+      content: generateAgentsMd(info, cwd),
+      type: "text",
+    });
+
+    files.push({
+      path: join(cwd, "CLAUDE.md"),
+      content: generateClaudeMd(info),
+      type: "text",
+    });
+
+    // Generate architecture.md if docs/ exists or we referenced it
+    if (info.dirs.includes("docs") || info.srcDirs.length > 0) {
+      files.push({
+        path: join(cwd, "docs", "architecture.md"),
+        content: generateArchitectureMd(info, cwd),
+        type: "text",
+      });
+    }
+
+    p.log.success(
+      `Generated ${files.length} doc file(s): ${files.map((f) => f.path.replace(cwd + "/", "")).join(", ")}`,
+    );
+    return { files, issues: [], skipped: false };
+  }
+
+  // Docs exist — offer to verify
+  const shouldVerify = await p.confirm({
+    message: "Project docs found. Verify for issues?",
+    initialValue: false,
+  });
+
+  if (p.isCancel(shouldVerify) || !shouldVerify) {
+    return { files: [], issues: [], skipped: true };
+  }
+
+  const issues = verifyDocs(cwd);
+
+  if (issues.length === 0) {
+    p.log.success("No issues found in project docs.");
+  } else {
+    for (const issue of issues) {
+      const prefix = `${colors.bold(issue.file)}:`;
+      if (issue.severity === "error") {
+        p.log.error(`${prefix} ${issue.message}`);
+      } else {
+        p.log.warning(`${prefix} ${issue.message}`);
+      }
+      if (issue.fix) {
+        p.log.message(`  ${symbols.arrow} ${colors.dim(issue.fix)}`);
+      }
+    }
+    p.log.info(
+      `Found ${issues.length} issue(s) (${issues.filter((i) => i.severity === "error").length} errors, ${issues.filter((i) => i.severity === "warning").length} warnings)`,
+    );
+  }
+
+  return { files: [], issues, skipped: false };
+}