pointfree-docs 0.1.0 → 0.2.1

package/dist/lib/index.js

@@ -5,8 +5,8 @@ import Database from "better-sqlite3";
 import { existsSync, mkdirSync, readFileSync } from "fs";
 import { glob } from "glob";
 import { basename, join } from "path";
-import { PATHS } from "../config.js";
-import { getDocsPaths } from "./repos.js";
+import { PATHS, EXAMPLES_CONFIG, EPISODES_CONFIG } from "../config.js";
+import { getDocsPaths, getExamplesPaths, getEpisodesPath } from "./repos.js";
 import { cleanMarkdown, extractTitle } from "./markdown.js";
 let db = null;
 /**
@@ -28,6 +28,7 @@ export function openIndex() {
       path TEXT NOT NULL,
       title TEXT,
       content TEXT,
+      source TEXT NOT NULL DEFAULT 'docs',
       UNIQUE(library, path)
     );
 
@@ -36,26 +37,40 @@ export function openIndex() {
       content,
       library,
       path,
+      source,
       content='docs',
       content_rowid='id'
     );
+  `);
+    // Add source column if it doesn't exist (migration for existing databases)
+    try {
+        db.exec(`ALTER TABLE docs ADD COLUMN source TEXT NOT NULL DEFAULT 'docs'`);
+    }
+    catch {
+        // Column already exists, ignore
+    }
+    // Drop and recreate triggers to ensure they include the source column
+    // This handles migration from older schema versions
+    db.exec(`
+    DROP TRIGGER IF EXISTS docs_ai;
+    DROP TRIGGER IF EXISTS docs_ad;
+    DROP TRIGGER IF EXISTS docs_au;
 
-    -- Triggers to keep FTS index in sync
-    CREATE TRIGGER IF NOT EXISTS docs_ai AFTER INSERT ON docs BEGIN
-      INSERT INTO docs_fts(rowid, title, content, library, path)
-      VALUES (new.id, new.title, new.content, new.library, new.path);
+    CREATE TRIGGER docs_ai AFTER INSERT ON docs BEGIN
+      INSERT INTO docs_fts(rowid, title, content, library, path, source)
+      VALUES (new.id, new.title, new.content, new.library, new.path, new.source);
     END;
 
-    CREATE TRIGGER IF NOT EXISTS docs_ad AFTER DELETE ON docs BEGIN
-      INSERT INTO docs_fts(docs_fts, rowid, title, content, library, path)
-      VALUES ('delete', old.id, old.title, old.content, old.library, old.path);
+    CREATE TRIGGER docs_ad AFTER DELETE ON docs BEGIN
+      INSERT INTO docs_fts(docs_fts, rowid, title, content, library, path, source)
+      VALUES ('delete', old.id, old.title, old.content, old.library, old.path, old.source);
     END;
 
-    CREATE TRIGGER IF NOT EXISTS docs_au AFTER UPDATE ON docs BEGIN
-      INSERT INTO docs_fts(docs_fts, rowid, title, content, library, path)
-      VALUES ('delete', old.id, old.title, old.content, old.library, old.path);
-      INSERT INTO docs_fts(rowid, title, content, library, path)
-      VALUES (new.id, new.title, new.content, new.library, new.path);
+    CREATE TRIGGER docs_au AFTER UPDATE ON docs BEGIN
+      INSERT INTO docs_fts(docs_fts, rowid, title, content, library, path, source)
+      VALUES ('delete', old.id, old.title, old.content, old.library, old.path, old.source);
+      INSERT INTO docs_fts(rowid, title, content, library, path, source)
+      VALUES (new.id, new.title, new.content, new.library, new.path, new.source);
     END;
   `);
     return db;
@@ -67,8 +82,8 @@ export function indexLibrary(lib) {
     const db = openIndex();
     const docsPaths = getDocsPaths(lib);
     const insertStmt = db.prepare(`
-    INSERT OR REPLACE INTO docs (library, path, title, content)
-    VALUES (?, ?, ?, ?)
+    INSERT OR REPLACE INTO docs (library, path, title, content, source)
+    VALUES (?, ?, ?, ?, ?)
   `);
     let indexed = 0;
     for (const docsPath of docsPaths) {
@@ -86,7 +101,7 @@ export function indexLibrary(lib) {
                 const title = extractTitle(content) || basename(file, ".md");
                 // Logical path like "tca/Testing" or "tca/Articles/Performance"
                 const docPath = `${lib.shortName}/${file.replace(/\.md$/, "")}`;
-                insertStmt.run(lib.shortName, docPath, title, cleanedContent);
+                insertStmt.run(lib.shortName, docPath, title, cleanedContent, "docs");
                 indexed++;
             }
             catch (error) {
@@ -96,9 +111,112 @@ export function indexLibrary(lib) {
     }
     return indexed;
 }
+/**
+ * Index TCA examples (CaseStudies, etc.)
+ */
+export function indexExamples() {
+    const db = openIndex();
+    const examplesPaths = getExamplesPaths();
+    const insertStmt = db.prepare(`
+    INSERT OR REPLACE INTO docs (library, path, title, content, source)
+    VALUES (?, ?, ?, ?, ?)
+  `);
+    let indexed = 0;
+    for (const examplesPath of examplesPaths) {
+        if (!existsSync(examplesPath)) {
+            continue;
+        }
+        // Find all Swift files
+        for (const pattern of EXAMPLES_CONFIG.filePatterns) {
+            const files = glob.sync(pattern, { cwd: examplesPath });
+            for (const file of files) {
+                const fullPath = join(examplesPath, file);
+                try {
+                    const content = readFileSync(fullPath, "utf-8");
+                    // Extract title from filename or first struct/class
+                    const title = extractSwiftTitle(content) || basename(file, ".swift");
+                    // Get the example category from the path (e.g., "CaseStudies", "SyncUps")
+                    const category = basename(examplesPath);
+                    const docPath = `examples/${category}/${file}`;
+                    insertStmt.run("examples", docPath, title, content, "examples");
+                    indexed++;
+                }
+                catch (error) {
+                    console.error(`  Warning: Failed to index ${fullPath}:`, error);
+                }
+            }
+        }
+    }
+    return indexed;
+}
+/**
+ * Index episode code samples
+ */
+export function indexEpisodes() {
+    const db = openIndex();
+    const episodesPath = getEpisodesPath();
+    if (!existsSync(episodesPath)) {
+        return 0;
+    }
+    const insertStmt = db.prepare(`
+    INSERT OR REPLACE INTO docs (library, path, title, content, source)
+    VALUES (?, ?, ?, ?, ?)
+  `);
+    let indexed = 0;
+    // Find all episode directories (0001-xxx, 0002-xxx, etc.)
+    const episodeDirs = glob.sync("[0-9][0-9][0-9][0-9]-*", { cwd: episodesPath });
+    for (const episodeDir of episodeDirs) {
+        const episodePath = join(episodesPath, episodeDir);
+        // Find all Swift files in this episode
+        for (const pattern of EPISODES_CONFIG.filePatterns) {
+            const files = glob.sync(pattern, { cwd: episodePath });
+            for (const file of files) {
+                const fullPath = join(episodePath, file);
+                try {
+                    const content = readFileSync(fullPath, "utf-8");
+                    // Title: episode name + file name
+                    const episodeName = formatEpisodeName(episodeDir);
+                    const fileName = basename(file, ".swift");
+                    const title = `${episodeName}: ${fileName}`;
+                    const docPath = `episodes/${episodeDir}/${file}`;
+                    insertStmt.run("episodes", docPath, title, content, "episodes");
+                    indexed++;
+                }
+                catch (error) {
+                    console.error(`  Warning: Failed to index ${fullPath}:`, error);
+                }
+            }
+        }
+    }
+    return indexed;
+}
+/**
+ * Extract title from Swift file (first struct/class/enum name)
+ */
+function extractSwiftTitle(content) {
+    // Match struct, class, enum, or actor declarations
+    const match = content.match(/(?:struct|class|enum|actor)\s+(\w+)/);
+    return match ? match[1] : null;
+}
+/**
+ * Format episode directory name to readable title
+ * "0156-testable-state-pt1" -> "Episode 156: Testable State Pt1"
+ */
+function formatEpisodeName(dirName) {
+    const match = dirName.match(/^(\d+)-(.+)$/);
+    if (!match)
+        return dirName;
+    const num = parseInt(match[1], 10);
+    const name = match[2]
+        .split("-")
+        .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+        .join(" ");
+    return `Ep${num}: ${name}`;
+}
 export function search(query, options = {}) {
     const db = openIndex();
     const limit = options.limit || 10;
+    const source = options.source || "docs"; // Default to docs only
     // Escape special FTS5 characters and format query
     const ftsQuery = query
         .replace(/['"]/g, "") // Remove quotes
@@ -115,7 +233,8 @@ export function search(query, options = {}) {
       path,
       title,
       snippet(docs_fts, 1, '**', '**', '...', 32) as snippet,
-      bm25(docs_fts) as score
+      bm25(docs_fts) as score,
+      source
     FROM docs_fts
     WHERE docs_fts MATCH ?
   `;
@@ -124,6 +243,11 @@ export function search(query, options = {}) {
         sql += ` AND library = ?`;
         params.push(options.lib);
     }
+    // Filter by source unless "all" is specified
+    if (source !== "all") {
+        sql += ` AND source = ?`;
+        params.push(source);
+    }
     sql += ` ORDER BY score LIMIT ?`;
     params.push(limit);
     try {
@@ -142,13 +266,15 @@ export function search(query, options = {}) {
 function fallbackSearch(query, options = {}) {
     const db = openIndex();
     const limit = options.limit || 10;
+    const source = options.source || "docs";
     let sql = `
     SELECT
       library,
       path,
       title,
       substr(content, 1, 200) as snippet,
-      0 as score
+      0 as score,
+      source
     FROM docs
     WHERE (title LIKE ? OR content LIKE ?)
   `;
@@ -158,6 +284,10 @@ function fallbackSearch(query, options = {}) {
         sql += ` AND library = ?`;
         params.push(options.lib);
     }
+    if (source !== "all") {
+        sql += ` AND source = ?`;
+        params.push(source);
+    }
     sql += ` LIMIT ?`;
     params.push(limit);
     try {
@@ -171,15 +301,19 @@ function fallbackSearch(query, options = {}) {
 /**
  * List all indexed documents
  */
-export function listDocs(lib) {
+export function listDocs(lib, source) {
     const db = openIndex();
-    let sql = `SELECT library, path, title FROM docs`;
+    let sql = `SELECT library, path, title, source FROM docs WHERE 1=1`;
     const params = [];
     if (lib) {
-        sql += ` WHERE library = ?`;
+        sql += ` AND library = ?`;
         params.push(lib);
     }
-    sql += ` ORDER BY library, path`;
+    if (source && source !== "all") {
+        sql += ` AND source = ?`;
+        params.push(source);
+    }
+    sql += ` ORDER BY source, library, path`;
     const stmt = db.prepare(sql);
     return stmt.all(...params);
 }
@@ -188,7 +322,7 @@ export function listDocs(lib) {
  */
 export function getDoc(path) {
     const db = openIndex();
-    const stmt = db.prepare(`SELECT library, path, title, content FROM docs WHERE path = ?`);
+    const stmt = db.prepare(`SELECT library, path, title, content, source FROM docs WHERE path = ?`);
     return stmt.get(path);
 }
 /**
@@ -201,7 +335,10 @@ export function getStats() {
     const byLibStmt = db.prepare(`SELECT library, COUNT(*) as count FROM docs GROUP BY library`);
     const byLibRows = byLibStmt.all();
     const byLibrary = Object.fromEntries(byLibRows.map((row) => [row.library, row.count]));
-    return { totalDocs: total, byLibrary };
+    const bySourceStmt = db.prepare(`SELECT source, COUNT(*) as count FROM docs GROUP BY source`);
+    const bySourceRows = bySourceStmt.all();
+    const bySource = Object.fromEntries(bySourceRows.map((row) => [row.source, row.count]));
+    return { totalDocs: total, byLibrary, bySource };
 }
 /**
  * Run a function with the index open, closing it automatically afterward.

package/dist/lib/repos.d.ts

@@ -6,15 +6,47 @@ import { LibraryConfig } from "../config.js";
  * Clone a library repository (sparse checkout, docs only)
  */
 export declare function cloneLibrary(lib: LibraryConfig): Promise<void>;
+/**
+ * Clone TCA examples (CaseStudies, SyncUps, etc.)
+ */
+export declare function cloneExamples(): Promise<void>;
+/**
+ * Clone episode code samples
+ */
+export declare function cloneEpisodes(): Promise<void>;
 /**
  * Update a library repository
  */
 export declare function updateLibrary(lib: LibraryConfig): Promise<boolean>;
+/**
+ * Update examples repository
+ */
+export declare function updateExamples(): Promise<boolean>;
+/**
+ * Update episodes repository
+ */
+export declare function updateEpisodes(): Promise<boolean>;
 /**
  * Get all local paths to a library's docs
  */
 export declare function getDocsPaths(lib: LibraryConfig): string[];
+/**
+ * Get all local paths to examples
+ */
+export declare function getExamplesPaths(): string[];
+/**
+ * Get local path to episodes
+ */
+export declare function getEpisodesPath(): string;
 /**
  * Check if a library is cloned
  */
 export declare function isLibraryCloned(lib: LibraryConfig): boolean;
+/**
+ * Check if examples are cloned
+ */
+export declare function areExamplesCloned(): boolean;
+/**
+ * Check if episodes are cloned
+ */
+export declare function areEpisodesCloned(): boolean;

package/dist/lib/repos.js

@@ -4,7 +4,7 @@
 import { simpleGit } from "simple-git";
 import { existsSync, mkdirSync } from "fs";
 import { join } from "path";
-import { PATHS } from "../config.js";
+import { PATHS, EXAMPLES_CONFIG, EPISODES_CONFIG } from "../config.js";
 /**
  * Clone a library repository (sparse checkout, docs only)
  */
@@ -34,6 +34,58 @@ export async function cloneLibrary(lib) {
     await repoGit.raw(["sparse-checkout", "set", ...lib.docsPaths]);
     console.log(`  ✓ Cloned ${lib.shortName}`);
 }
+/**
+ * Clone TCA examples (CaseStudies, SyncUps, etc.)
+ */
+export async function cloneExamples() {
+    const repoDir = join(PATHS.reposDir, EXAMPLES_CONFIG.name);
+    // Ensure repos directory exists
+    if (!existsSync(PATHS.reposDir)) {
+        mkdirSync(PATHS.reposDir, { recursive: true });
+    }
+    if (existsSync(repoDir)) {
+        console.log(`  Repository already exists: ${EXAMPLES_CONFIG.name}`);
+        return;
+    }
+    console.log(`  Cloning ${EXAMPLES_CONFIG.repo} (examples)...`);
+    const git = simpleGit();
+    // Sparse checkout: only download examples directories
+    await git.clone(`https://github.com/${EXAMPLES_CONFIG.repo}.git`, repoDir, [
+        "--depth",
+        "1",
+        "--filter=blob:none",
+        "--sparse",
+    ]);
+    const repoGit = simpleGit(repoDir);
+    // Set up sparse checkout to only get the examples folders
+    await repoGit.raw(["sparse-checkout", "init", "--cone"]);
+    await repoGit.raw(["sparse-checkout", "set", ...EXAMPLES_CONFIG.paths]);
+    console.log(`  ✓ Cloned examples`);
+}
+/**
+ * Clone episode code samples
+ */
+export async function cloneEpisodes() {
+    const repoDir = join(PATHS.reposDir, EPISODES_CONFIG.name);
+    // Ensure repos directory exists
+    if (!existsSync(PATHS.reposDir)) {
+        mkdirSync(PATHS.reposDir, { recursive: true });
+    }
+    if (existsSync(repoDir)) {
+        console.log(`  Repository already exists: ${EPISODES_CONFIG.name}`);
+        return;
+    }
+    console.log(`  Cloning ${EPISODES_CONFIG.repo} (episodes)...`);
+    console.log(`  ⚠ Note: This may take a while (350+ episodes)...`);
+    const git = simpleGit();
+    // Full clone with depth 1 and blob filter for efficiency
+    await git.clone(`https://github.com/${EPISODES_CONFIG.repo}.git`, repoDir, [
+        "--depth",
+        "1",
+        "--filter=blob:none",
+    ]);
+    console.log(`  ✓ Cloned episodes`);
+}
 /**
  * Update a library repository
  */
@@ -61,12 +113,78 @@ export async function updateLibrary(lib) {
         return false;
     }
 }
+/**
+ * Update examples repository
+ */
+export async function updateExamples() {
+    const repoDir = join(PATHS.reposDir, EXAMPLES_CONFIG.name);
+    if (!existsSync(repoDir)) {
+        console.log(`  Examples not found. Run 'pf-docs init --examples' first.`);
+        return false;
+    }
+    console.log(`  Updating examples...`);
+    const git = simpleGit(repoDir);
+    try {
+        const pullResult = await git.pull();
+        if (pullResult.summary.changes > 0) {
+            console.log(`  ✓ Updated examples (${pullResult.summary.changes} changes)`);
+            return true;
+        }
+        else {
+            console.log(`  ✓ Examples are up to date`);
+            return false;
+        }
+    }
+    catch (error) {
+        console.error(`  ✗ Failed to update examples:`, error);
+        return false;
+    }
+}
+/**
+ * Update episodes repository
+ */
+export async function updateEpisodes() {
+    const repoDir = join(PATHS.reposDir, EPISODES_CONFIG.name);
+    if (!existsSync(repoDir)) {
+        console.log(`  Episodes not found. Run 'pf-docs init --episodes' first.`);
+        return false;
+    }
+    console.log(`  Updating episodes...`);
+    const git = simpleGit(repoDir);
+    try {
+        const pullResult = await git.pull();
+        if (pullResult.summary.changes > 0) {
+            console.log(`  ✓ Updated episodes (${pullResult.summary.changes} changes)`);
+            return true;
+        }
+        else {
+            console.log(`  ✓ Episodes are up to date`);
+            return false;
+        }
+    }
+    catch (error) {
+        console.error(`  ✗ Failed to update episodes:`, error);
+        return false;
+    }
+}
 /**
  * Get all local paths to a library's docs
  */
 export function getDocsPaths(lib) {
     return lib.docsPaths.map((docsPath) => join(PATHS.reposDir, lib.name, docsPath));
 }
+/**
+ * Get all local paths to examples
+ */
+export function getExamplesPaths() {
+    return EXAMPLES_CONFIG.paths.map((path) => join(PATHS.reposDir, EXAMPLES_CONFIG.name, path));
+}
+/**
+ * Get local path to episodes
+ */
+export function getEpisodesPath() {
+    return join(PATHS.reposDir, EPISODES_CONFIG.name);
+}
 /**
  * Check if a library is cloned
  */
@@ -74,3 +192,17 @@ export function isLibraryCloned(lib) {
     const repoDir = join(PATHS.reposDir, lib.name);
     return existsSync(repoDir);
 }
+/**
+ * Check if examples are cloned
+ */
+export function areExamplesCloned() {
+    const repoDir = join(PATHS.reposDir, EXAMPLES_CONFIG.name);
+    return existsSync(repoDir);
+}
+/**
+ * Check if episodes are cloned
+ */
+export function areEpisodesCloned() {
+    const repoDir = join(PATHS.reposDir, EPISODES_CONFIG.name);
+    return existsSync(repoDir);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pointfree-docs",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "CLI tool for searching Point-Free library documentation",
   "type": "module",
   "bin": {
@@ -33,10 +33,10 @@
   "license": "MIT",
   "dependencies": {
     "better-sqlite3": "^11.0.0",
+    "chalk": "^5.3.0",
     "commander": "^12.0.0",
     "glob": "^10.3.0",
-    "simple-git": "^3.22.0",
-    "chalk": "^5.3.0"
+    "simple-git": "^3.22.0"
   },
   "devDependencies": {
     "@types/better-sqlite3": "^7.6.9",