sourcebook 0.4.1 → 0.5.0

package/dist/generators/claude.js

@@ -1,4 +1,4 @@
-import { groupByCategory, hasCommands, categorizeFindings, enforceTokenBudget, } from "./shared.js";
+import { groupByCategory, hasCommands, categorizeFindings, enforceTokenBudget, buildQuickReference, getModePriorities, } from "./shared.js";
 /**
  * Generate a CLAUDE.md file from scan results.
  *
@@ -10,6 +10,7 @@ import { groupByCategory, hasCommands, categorizeFindings, enforceTokenBudget, }
  */
 export function generateClaude(scan, budget) {
     const { critical, important, supplementary } = categorizeFindings(scan.findings);
+    const priorities = getModePriorities(scan.repoMode);
     const sections = [];
     // ============================================
     // BEGINNING: Most critical info goes here
@@ -23,7 +24,12 @@ export function generateClaude(scan, budget) {
         "",
     ].join("\n");
     sections.push({ key: "header", content: header, priority: 100 });
-    // Commands first -- most immediately actionable
+    // Quick Reference — the "30-second handoff" (highest priority in app mode)
+    const quickRef = buildQuickReference(scan.findings);
+    if (quickRef) {
+        sections.push({ key: "quick_reference", content: quickRef, priority: priorities.quick_reference });
+    }
+    // Commands — most immediately actionable
     if (hasCommands(scan.commands)) {
         const lines = ["## Commands", ""];
         if (scan.commands.dev)
@@ -49,7 +55,7 @@ export function generateClaude(scan, budget) {
             lines.push(`- **${finding.category}:** ${finding.description}`);
         }
         lines.push("");
-        sections.push({ key: "critical", content: lines.join("\n"), priority: 90 });
+        sections.push({ key: "critical", content: lines.join("\n"), priority: priorities.critical });
     }
     // ============================================
     // MIDDLE: Less critical but useful info
@@ -58,7 +64,7 @@ export function generateClaude(scan, budget) {
     // Stack (brief)
     if (scan.frameworks.length > 0) {
         const content = ["## Stack", "", scan.frameworks.join(", "), ""].join("\n");
-        sections.push({ key: "stack", content, priority: 50 });
+        sections.push({ key: "stack", content, priority: priorities.stack });
     }
     // Key directories (only non-obvious ones)
     if (Object.keys(scan.structure.directories).length > 0) {
@@ -69,7 +75,7 @@ export function generateClaude(scan, budget) {
                 lines.push(`- \`${dir}/\` — ${purpose}`);
             }
             lines.push("");
-            sections.push({ key: "structure", content: lines.join("\n"), priority: 40 });
+            sections.push({ key: "structure", content: lines.join("\n"), priority: priorities.structure });
         }
     }
     // Core modules (from PageRank)
@@ -80,7 +86,7 @@ export function generateClaude(scan, budget) {
             lines.push(`- \`${file}\``);
         }
         lines.push("");
-        sections.push({ key: "core_modules", content: lines.join("\n"), priority: 60 });
+        sections.push({ key: "core_modules", content: lines.join("\n"), priority: priorities.core_modules });
     }
     // Important findings (high confidence, non-critical)
     if (important.length > 0) {
@@ -98,7 +104,7 @@ export function generateClaude(scan, budget) {
             }
         }
         lines.push("");
-        sections.push({ key: "conventions", content: lines.join("\n"), priority: 30 });
+        sections.push({ key: "conventions", content: lines.join("\n"), priority: priorities.conventions });
     }
     // Supplementary findings (medium confidence)
     if (supplementary.length > 0) {
@@ -116,7 +122,7 @@ export function generateClaude(scan, budget) {
             }
         }
         lines.push("");
-        sections.push({ key: "supplementary", content: lines.join("\n"), priority: 20 });
+        sections.push({ key: "supplementary", content: lines.join("\n"), priority: priorities.supplementary });
     }
     // ============================================
     // END: Important reminders go here

package/dist/generators/shared.d.ts

@@ -27,6 +27,18 @@ export declare function categorizeFindings(findings: Finding[]): {
  * 6. Supplementary findings (drop first)
  * 7. Footer/manual section (always keep — end of context = high retention)
  */
+/**
+ * Build a Quick Reference section from dominant pattern findings.
+ * This is the "30-second senior engineer handoff" — the single most
+ * actionable section in the output.
+ */
+export declare function buildQuickReference(findings: Finding[]): string | null;
+/**
+ * Get priority adjustments based on repo mode.
+ * App repos: boost dominant patterns, demote structural.
+ * Library repos: boost structural, demote patterns.
+ */
+export declare function getModePriorities(repoMode?: "app" | "library" | "monorepo"): Record<string, number>;
 export declare function enforceTokenBudget(sections: {
     key: string;
     content: string;

package/dist/generators/shared.js

@@ -10,6 +10,7 @@ const CRITICAL_CATEGORIES = new Set([
     "Git history",
     "Commit conventions",
     "Anti-patterns",
+    "Critical constraints",
 ]);
 const CRITICAL_KEYWORDS = [
     "breaking", "blast radius", "deprecated", "don't", "must",
@@ -62,6 +63,113 @@ export function categorizeFindings(findings) {
  * 6. Supplementary findings (drop first)
  * 7. Footer/manual section (always keep — end of context = high retention)
  */
+/**
+ * Build a Quick Reference section from dominant pattern findings.
+ * This is the "30-second senior engineer handoff" — the single most
+ * actionable section in the output.
+ */
+export function buildQuickReference(findings) {
+    const patterns = findings.filter((f) => f.category === "Dominant patterns");
+    if (patterns.length < 2)
+        return null;
+    const lines = ["## Quick Reference", ""];
+    for (const p of patterns) {
+        // Extract a short label from the description
+        const desc = p.description;
+        let label = "";
+        let value = desc;
+        if (desc.includes("internationalization") || desc.includes("i18n") || desc.includes("translation")) {
+            label = "i18n";
+        }
+        else if (desc.includes("route") || desc.includes("endpoint") || desc.includes("API")) {
+            label = "routing";
+        }
+        else if (desc.includes("validation") || desc.includes("schema") || desc.includes("Zod") || desc.includes("Pydantic")) {
+            label = "validation";
+        }
+        else if ((desc.includes("auth") || desc.includes("Auth") || desc.includes("session")) && !desc.includes("integration")) {
+            label = "auth";
+        }
+        else if (desc.includes("Test") || desc.includes("test")) {
+            label = "testing";
+        }
+        else if (desc.includes("Tailwind") || desc.includes("styled") || desc.includes("CSS")) {
+            label = "styling";
+        }
+        else if (desc.includes("database") || desc.includes("Database") || desc.includes("Prisma") || desc.includes("ORM")) {
+            label = "database";
+        }
+        else if (desc.includes("fetching") || desc.includes("Query") || desc.includes("SWR")) {
+            label = "data fetching";
+        }
+        else if (desc.includes("Route definitions") || desc.includes("Add new endpoints")) {
+            label = "routes";
+        }
+        else if (desc.includes("integration") || desc.includes("Third-party")) {
+            label = "integrations";
+        }
+        else if (desc.includes("components") || desc.includes("UI")) {
+            label = "components";
+        }
+        else if (desc.includes("Generated") || desc.includes("generated") || desc.includes("DO NOT")) {
+            label = "generated";
+        }
+        else {
+            continue; // Skip findings we can't label cleanly
+        }
+        // Compress the description to a short actionable line
+        const short = desc
+            .replace(/\. Follow this pattern.*$/, "")
+            .replace(/\. This is the project's standard.*$/, "")
+            .replace(/\. Each integration has.*$/, "");
+        lines.push(`- **${label}:** ${short}`);
+    }
+    if (lines.length <= 2)
+        return null; // Nothing useful
+    // Deduplicate by label — keep only first occurrence of each
+    const seen = new Set();
+    const deduped = [lines[0], lines[1]]; // Keep header
+    for (let i = 2; i < lines.length; i++) {
+        const labelMatch = lines[i].match(/^\- \*\*(\w[\w\s]*)\:\*\*/);
+        if (labelMatch) {
+            const lbl = labelMatch[1];
+            if (seen.has(lbl))
+                continue;
+            seen.add(lbl);
+        }
+        deduped.push(lines[i]);
+    }
+    deduped.push("");
+    return deduped.join("\n");
+}
+/**
+ * Get priority adjustments based on repo mode.
+ * App repos: boost dominant patterns, demote structural.
+ * Library repos: boost structural, demote patterns.
+ */
+export function getModePriorities(repoMode) {
+    if (repoMode === "library") {
+        return {
+            quick_reference: 85,
+            critical: 92,
+            core_modules: 90,
+            conventions: 80,
+            stack: 50,
+            structure: 40,
+            supplementary: 25,
+        };
+    }
+    // Default: app mode (boost patterns, Quick Reference highest)
+    return {
+        quick_reference: 96,
+        critical: 92,
+        core_modules: 50,
+        conventions: 85,
+        stack: 45,
+        structure: 60,
+        supplementary: 20,
+    };
+}
 export function enforceTokenBudget(sections, budget) {
     // Sort by priority descending (highest priority = keep)
     const sorted = [...sections].sort((a, b) => b.priority - a.priority);

package/dist/scanner/index.js

@@ -51,6 +51,8 @@ export async function scanProject(dir) {
         ...gitAnalysis.findings,
         ...graphAnalysis.findings,
     ];
+    // Detect repo mode for prioritization
+    const repoMode = detectRepoMode(dir, files, frameworks.map((f) => f.name));
     return {
         dir,
         files,
@@ -60,8 +62,29 @@ export async function scanProject(dir) {
         structure,
         findings,
         rankedFiles: graphAnalysis.rankedFiles,
+        repoMode,
     };
 }
+function detectRepoMode(dir, files, frameworks) {
+    // Monorepo detection
+    const hasWorkspaces = files.some((f) => f === "pnpm-workspace.yaml" || f === "lerna.json" || f === "nx.json");
+    if (hasWorkspaces)
+        return "monorepo";
+    // Library detection
+    const hasPublishConfig = files.some((f) => f === "setup.py" || f === "pyproject.toml" || f === "setup.cfg");
+    const hasSrcLib = files.some((f) => f.startsWith("src/lib/") || f.startsWith("lib/"));
+    const hasExportsField = false; // would need to read package.json, but frameworks already detected
+    const isLibraryFramework = frameworks.some((f) => ["FastAPI", "Flask", "Django", "Hono", "Express"].includes(f));
+    // If it has a setup.py/pyproject.toml AND no app/ or pages/ → library
+    const hasAppDirs = files.some((f) => f.startsWith("app/") || f.startsWith("pages/") || f.startsWith("src/app/") || f.startsWith("src/pages/"));
+    const hasComponents = files.some((f) => f.includes("/components/"));
+    if (hasPublishConfig && !hasAppDirs && !hasComponents)
+        return "library";
+    if (hasSrcLib && !hasAppDirs && !hasComponents && !isLibraryFramework)
+        return "library";
+    // Default: app
+    return "app";
+}
 function detectLanguages(files) {
     const extMap = {
         ".ts": "TypeScript",

package/dist/scanner/patterns.js

@@ -467,7 +467,211 @@ function detectDominantPatterns(dir, files, contents, frameworks) {
         });
     }
     // ========================================
-    // 6. KEY DIRECTORY PURPOSES (app-specific)
+    // 6. AUTH PATTERNS
+    // ========================================
+    const authPatterns = [
+        { pattern: "useAuth|useSession|useUser", name: "auth hooks (useAuth/useSession/useUser)", count: 0 },
+        { pattern: "withAuth|authMiddleware|requireAuth", name: "auth middleware", count: 0 },
+        { pattern: "passport\\.authenticate", name: "Passport.js", count: 0 },
+        { pattern: "jwt\\.verify|jwt\\.sign|jsonwebtoken", name: "JWT (jsonwebtoken)", count: 0 },
+        { pattern: "@login_required|LoginRequiredMixin", name: "Django login_required", count: 0 },
+        { pattern: "IsAuthenticated|AllowAny|BasePermission", name: "DRF permissions", count: 0 },
+        { pattern: "NextAuth|getServerSession", name: "NextAuth.js", count: 0 },
+        { pattern: "supabase\\.auth|useSupabaseClient", name: "Supabase Auth", count: 0 },
+        { pattern: "clerk|useClerk|ClerkProvider", name: "Clerk", count: 0 },
+    ];
+    for (const [, content] of allContents) {
+        for (const p of authPatterns) {
+            if (new RegExp(p.pattern).test(content)) {
+                p.count++;
+            }
+        }
+    }
+    const dominantAuth = authPatterns.filter((p) => p.count >= 2).sort((a, b) => b.count - a.count);
+    if (dominantAuth.length > 0) {
+        const primary = dominantAuth[0];
+        // Find auth middleware/guard files
+        const authFiles = files.filter((f) => (f.includes("auth") || f.includes("middleware") || f.includes("guard") || f.includes("session")) &&
+            !f.includes("node_modules") && !f.includes(".test.") &&
+            (f.endsWith(".ts") || f.endsWith(".tsx") || f.endsWith(".js") || f.endsWith(".py")));
+        const authEntrypoint = authFiles.find((f) => f.includes("middleware") || f.includes("guard") || f.includes("auth/index"));
+        let desc = `Auth uses ${primary.name}.`;
+        if (authEntrypoint) {
+            desc += ` Auth logic lives in ${authEntrypoint}.`;
+        }
+        findings.push({
+            category: "Dominant patterns",
+            description: desc,
+            evidence: `${primary.count} files`,
+            confidence: "high",
+            discoverable: false,
+        });
+    }
+    // ========================================
+    // 7. STYLING CONVENTIONS
+    // ========================================
+    const stylePatterns = [
+        { pattern: "className=|class=.*tw-", name: "Tailwind CSS", desc: "Styling uses Tailwind CSS utility classes", count: 0 },
+        { pattern: "styled\\.|styled\\(|css`", name: "styled-components/Emotion", desc: "Styling uses CSS-in-JS (styled-components or Emotion)", count: 0 },
+        { pattern: "styles\\.\\w+|from.*\\.module\\.(css|scss)", name: "CSS Modules", desc: "Styling uses CSS Modules (*.module.css)", count: 0 },
+    ];
+    for (const [f, content] of allContents) {
+        for (const p of stylePatterns) {
+            if (new RegExp(p.pattern).test(content)) {
+                p.count++;
+            }
+        }
+    }
+    const dominantStyle = stylePatterns.filter((p) => p.count >= 3).sort((a, b) => b.count - a.count);
+    if (dominantStyle.length > 0) {
+        const primary = dominantStyle[0];
+        let desc = `${primary.desc}.`;
+        // For Tailwind, check for custom tokens
+        if (primary.name === "Tailwind CSS") {
+            const twConfig = files.find((f) => f.includes("tailwind.config"));
+            if (twConfig) {
+                try {
+                    const configContent = fs.readFileSync(path.join(dir, twConfig), "utf-8");
+                    if (configContent.includes("colors") || configContent.includes("extend")) {
+                        desc += ` Custom design tokens defined in ${twConfig} — use these instead of arbitrary values.`;
+                    }
+                }
+                catch { /* skip */ }
+            }
+        }
+        findings.push({
+            category: "Dominant patterns",
+            description: desc,
+            evidence: `${primary.count} files`,
+            confidence: "high",
+            discoverable: false,
+        });
+    }
+    // ========================================
+    // 8. DATABASE / ORM PATTERNS
+    // ========================================
+    const dbPatterns = [
+        { pattern: "prisma\\.|PrismaClient|\\$queryRaw", name: "Prisma", entryHint: "prisma/schema.prisma", count: 0 },
+        { pattern: "drizzle\\(|pgTable|sqliteTable", name: "Drizzle ORM", entryHint: "drizzle.config.ts", count: 0 },
+        { pattern: "knex\\(|knex\\.schema", name: "Knex.js", entryHint: "knexfile", count: 0 },
+        { pattern: "sequelize\\.define|Model\\.init", name: "Sequelize", entryHint: "models/", count: 0 },
+        { pattern: "TypeORM|@Entity|getRepository", name: "TypeORM", entryHint: "entities/", count: 0 },
+        { pattern: "mongoose\\.model|Schema\\(\\{", name: "Mongoose", entryHint: "models/", count: 0 },
+        { pattern: "from django\\.db|models\\.Model", name: "Django ORM", entryHint: "models.py", count: 0 },
+        { pattern: "SQLAlchemy|declarative_base|sessionmaker", name: "SQLAlchemy", entryHint: "models/", count: 0 },
+        { pattern: "from tortoise|tortoise\\.models", name: "Tortoise ORM", entryHint: "models/", count: 0 },
+    ];
+    for (const [, content] of allContents) {
+        for (const p of dbPatterns) {
+            if (new RegExp(p.pattern).test(content)) {
+                p.count++;
+            }
+        }
+    }
+    const dominantDB = dbPatterns.filter((p) => p.count >= 2).sort((a, b) => b.count - a.count);
+    if (dominantDB.length > 0) {
+        const primary = dominantDB[0];
+        // Try to find the actual entrypoint file
+        const dbEntryFile = files.find((f) => f.includes(primary.entryHint) && !f.includes("node_modules"));
+        let desc = `Database access uses ${primary.name}.`;
+        if (dbEntryFile) {
+            desc += ` Schema/models defined in ${dbEntryFile}.`;
+        }
+        else {
+            desc += ` Look for schemas in ${primary.entryHint}.`;
+        }
+        findings.push({
+            category: "Dominant patterns",
+            description: desc,
+            evidence: `${primary.count} files`,
+            confidence: "high",
+            discoverable: false,
+        });
+    }
+    // ========================================
+    // 9. GENERATED / DO-NOT-EDIT FILES
+    // ========================================
+    const generatedFiles = [];
+    for (const [file, content] of allContents) {
+        const firstLines = content.slice(0, 500);
+        if (/@generated/.test(firstLines) ||
+            /DO NOT EDIT/i.test(firstLines) ||
+            /auto-generated/i.test(firstLines) ||
+            /this file is generated/i.test(firstLines) ||
+            /generated by/i.test(firstLines)) {
+            generatedFiles.push(file);
+        }
+    }
+    // Also check for common generated file patterns in the full file list
+    const knownGenerated = files.filter((f) => !f.includes("node_modules") &&
+        (f.includes(".generated.") ||
+            f.includes(".gen.") ||
+            f.endsWith(".d.ts") && f.includes("generated") ||
+            f.includes("__generated__") ||
+            f.includes("codegen")));
+    const allGenerated = [...new Set([...generatedFiles, ...knownGenerated])];
+    if (allGenerated.length >= 2) {
+        const samples = allGenerated.slice(0, 5).join(", ");
+        findings.push({
+            category: "Critical constraints",
+            description: `Generated files detected (${samples}${allGenerated.length > 5 ? ", ..." : ""}). Do NOT edit these directly — modify the source/schema they are generated from.`,
+            evidence: `${allGenerated.length} generated files`,
+            confidence: "high",
+            discoverable: false,
+        });
+    }
+    // ========================================
+    // 10. EDIT ENTRYPOINTS (where changes usually land)
+    // ========================================
+    // For routing — find where route definitions live
+    if (dominantRouter.length > 0) {
+        const routeDirs = files
+            .filter((f) => (f.includes("routes") || f.includes("routers") || f.includes("api/") || f.includes("app/api/")) &&
+            !f.includes("node_modules") && !f.includes(".test.") &&
+            (f.endsWith(".ts") || f.endsWith(".js") || f.endsWith(".py") || f.endsWith(".go")))
+            .map((f) => {
+            const parts = f.split("/");
+            // Get the directory containing route files
+            return parts.slice(0, -1).join("/");
+        })
+            .filter((v, i, a) => a.indexOf(v) === i)
+            .slice(0, 3);
+        if (routeDirs.length > 0) {
+            findings.push({
+                category: "Dominant patterns",
+                description: `Route definitions live in: ${routeDirs.join(", ")}. Add new endpoints here.`,
+                evidence: `${routeDirs.length} route directories`,
+                confidence: "high",
+                discoverable: false,
+            });
+        }
+    }
+    // For components — find where UI components live
+    const componentDirs = files
+        .filter((f) => (f.includes("/components/") || f.includes("/ui/")) &&
+        !f.includes("node_modules") && !f.includes(".test.") &&
+        (f.endsWith(".tsx") || f.endsWith(".jsx") || f.endsWith(".vue") || f.endsWith(".svelte")))
+        .map((f) => {
+        const match = f.match(/(.*\/(?:components|ui))\//);
+        return match ? match[1] : null;
+    })
+        .filter((v) => v !== null)
+        .filter((v, i, a) => a.indexOf(v) === i)
+        .slice(0, 3);
+    if (componentDirs.length > 0 && componentDirs.some((d) => !d.includes("node_modules"))) {
+        const filtered = componentDirs.filter((d) => !d.includes("node_modules"));
+        if (filtered.length > 0) {
+            findings.push({
+                category: "Dominant patterns",
+                description: `UI components live in: ${filtered.join(", ")}. Add new components here.`,
+                evidence: `${filtered.length} component directories`,
+                confidence: "medium",
+                discoverable: false,
+            });
+        }
+    }
+    // ========================================
+    // 11. KEY DIRECTORY PURPOSES (app-specific)
     // ========================================
     // Detect directories with clear domain purposes
     const dirPurposes = [];

package/dist/types.d.ts

@@ -48,4 +48,6 @@ export interface ProjectScan {
         file: string;
         score: number;
     }[];
+    /** Detected repo mode for context prioritization */
+    repoMode?: "app" | "library" | "monorepo";
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sourcebook",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Extract the conventions, constraints, and architectural truths your AI coding agents keep missing.",
   "type": "module",
   "bin": {