pointfree-docs 0.1.0 → 0.2.1

package/dist/commands/search.js

@@ -3,11 +3,25 @@
  */
 import chalk from "chalk";
 import { search as searchIndex, withIndex } from "../lib/index.js";
+import { SOURCE_TYPES } from "../config.js";
+import { getSourceLabel } from "../lib/format.js";
 export function searchCommand(query, options) {
     const limit = options.limit ? parseInt(options.limit, 10) : 10;
-    const results = withIndex(() => searchIndex(query, { lib: options.lib, limit }));
+    // Validate source option
+    let source = "docs"; // Default to docs only
+    if (options.source) {
+        if (options.source === "all" || SOURCE_TYPES.includes(options.source)) {
+            source = options.source;
+        }
+        else {
+            console.log(chalk.red(`Invalid source: ${options.source}`));
+            console.log(chalk.gray(`Valid sources: ${SOURCE_TYPES.join(", ")}, all`));
+            return;
+        }
+    }
+    const results = withIndex(() => searchIndex(query, { lib: options.lib, limit, source }));
     if (options.json) {
-        console.log(JSON.stringify({ query, results }, null, 2));
+        console.log(JSON.stringify({ query, source, results }, null, 2));
         return;
     }
     if (results.length === 0) {
@@ -15,17 +29,26 @@ export function searchCommand(query, options) {
         if (options.lib) {
             console.log(chalk.gray(`  (searched in library: ${options.lib})`));
         }
+        if (source !== "all") {
+            console.log(chalk.gray(`  (searched in source: ${source})`));
+            console.log(chalk.gray(`  Try --source=all to search everything`));
+        }
         console.log(chalk.gray(`\nTry a different query or run 'pf-docs list' to see available docs.`));
         return;
     }
-    console.log(chalk.bold(`\n🔍 Search results for: "${query}"\n`));
+    const sourceLabel = source === "all" ? "all sources" : source;
+    console.log(chalk.bold(`\n🔍 Search results for: "${query}" (${sourceLabel})\n`));
     for (let i = 0; i < results.length; i++) {
         const result = results[i];
-        console.log(chalk.blue(`${i + 1}. ${result.title}`));
+        const label = source === "all" ? `${getSourceLabel(result.source)} ` : "";
+        console.log(`${label}${chalk.blue(`${i + 1}. ${result.title}`)}`);
         console.log(chalk.gray(`   Path: ${result.path}`));
         console.log(chalk.gray(`   ${result.snippet}`));
         console.log();
     }
     console.log(chalk.gray(`\nTo view a document: pf-docs get <path>`));
     console.log(chalk.gray(`Example: pf-docs get ${results[0].path}`));
+    if (source !== "all") {
+        console.log(chalk.gray(`\nTip: Use --source=all to search docs, examples, and episodes together`));
+    }
 }

package/dist/commands/stats.js

@@ -3,8 +3,9 @@
  */
 import chalk from "chalk";
 import { getStats, withIndex } from "../lib/index.js";
-import { LIBRARIES, getLibrary } from "../config.js";
-import { isLibraryCloned } from "../lib/repos.js";
+import { LIBRARIES, getLibrary, EXAMPLES_CONFIG, EPISODES_CONFIG } from "../config.js";
+import { isLibraryCloned, areExamplesCloned, areEpisodesCloned } from "../lib/repos.js";
+import { getSourceName } from "../lib/format.js";
 export function statsCommand(options) {
     const stats = withIndex(() => getStats());
     if (options.json) {
@@ -12,12 +13,19 @@ export function statsCommand(options) {
         return;
     }
     console.log(chalk.bold("\n📊 pf-docs Statistics\n"));
-    console.log(chalk.blue(`Total indexed documents: ${stats.totalDocs}`));
+    console.log(chalk.blue(`Total indexed items: ${stats.totalDocs}`));
     console.log();
-    console.log(chalk.bold("Indexed libraries:"));
+    // Show breakdown by source
+    console.log(chalk.bold("By source:"));
+    for (const [sourceName, count] of Object.entries(stats.bySource)) {
+        console.log(`  ${getSourceName(sourceName)}: ${count} items`);
+    }
+    console.log();
+    // Show breakdown by library
+    console.log(chalk.bold("By library:"));
     for (const [libName, count] of Object.entries(stats.byLibrary)) {
         const libConfig = getLibrary(libName);
-        console.log(`  ${chalk.green("●")} ${libName}: ${count} docs`);
+        console.log(`  ${chalk.green("●")} ${libName}: ${count} items`);
         if (libConfig) {
             console.log(chalk.gray(`      ${libConfig.description}`));
         }
@@ -34,4 +42,23 @@ export function statsCommand(options) {
         console.log();
         console.log(chalk.gray(`To add: pf-docs init --libs ${notIndexed[0].shortName}`));
     }
+    // Show examples/episodes status
+    const extrasNotIndexed = [];
+    if (!areExamplesCloned()) {
+        extrasNotIndexed.push("examples");
+    }
+    if (!areEpisodesCloned()) {
+        extrasNotIndexed.push("episodes");
+    }
+    if (extrasNotIndexed.length > 0) {
+        console.log(chalk.bold("Additional sources (not indexed):"));
+        if (extrasNotIndexed.includes("examples")) {
+            console.log(`  ${chalk.gray("○")} examples — ${EXAMPLES_CONFIG.description}`);
+        }
+        if (extrasNotIndexed.includes("episodes")) {
+            console.log(`  ${chalk.gray("○")} episodes — ${EPISODES_CONFIG.description}`);
+        }
+        console.log();
+        console.log(chalk.gray(`To add: pf-docs init --examples --episodes`));
+    }
 }

package/dist/commands/update.d.ts

@@ -3,6 +3,8 @@
  */
 interface UpdateOptions {
     libs?: string[];
+    examples?: boolean;
+    episodes?: boolean;
 }
 export declare function updateCommand(options: UpdateOptions): Promise<void>;
 export {};

package/dist/commands/update.js

@@ -3,8 +3,8 @@
  */
 import chalk from "chalk";
 import { LIBRARIES, getLibrary } from "../config.js";
-import { updateLibrary, isLibraryCloned } from "../lib/repos.js";
-import { indexLibrary, openIndex, closeIndex } from "../lib/index.js";
+import { updateLibrary, updateExamples, updateEpisodes, isLibraryCloned, areExamplesCloned, areEpisodesCloned } from "../lib/repos.js";
+import { indexLibrary, indexExamples, indexEpisodes, openIndex, closeIndex } from "../lib/index.js";
 export async function updateCommand(options) {
     console.log(chalk.bold("\n🔄 Updating Point-Free Documentation\n"));
     // Determine which libraries to update
@@ -24,27 +24,53 @@ export async function updateCommand(options) {
             }
         }
     }
-    if (librariesToUpdate.length === 0) {
-        console.log(chalk.yellow("No libraries to update. Run 'pf-docs init' first."));
+    // Check for examples/episodes
+    const shouldUpdateExamples = options.examples && areExamplesCloned();
+    const shouldUpdateEpisodes = options.episodes && areEpisodesCloned();
+    if (options.examples && !areExamplesCloned()) {
+        console.log(chalk.yellow(`  ⚠ Examples not initialized. Run 'pf-docs init --examples' first.`));
+    }
+    if (options.episodes && !areEpisodesCloned()) {
+        console.log(chalk.yellow(`  ⚠ Episodes not initialized. Run 'pf-docs init --episodes' first.`));
+    }
+    if (librariesToUpdate.length === 0 && !shouldUpdateExamples && !shouldUpdateEpisodes) {
+        console.log(chalk.yellow("Nothing to update. Run 'pf-docs init' first."));
         return;
     }
     // Update repositories
     console.log(chalk.bold("Pulling latest changes..."));
     const updatedLibs = [];
+    let examplesUpdated = false;
+    let episodesUpdated = false;
     for (const lib of librariesToUpdate) {
         const wasUpdated = await updateLibrary(lib);
         if (wasUpdated) {
             updatedLibs.push(lib);
         }
     }
-    // Re-index updated libraries
-    if (updatedLibs.length > 0) {
-        console.log(chalk.bold("\nRe-indexing updated libraries..."));
+    if (shouldUpdateExamples) {
+        examplesUpdated = await updateExamples();
+    }
+    if (shouldUpdateEpisodes) {
+        episodesUpdated = await updateEpisodes();
+    }
+    // Re-index updated sources
+    const hasUpdates = updatedLibs.length > 0 || examplesUpdated || episodesUpdated;
+    if (hasUpdates) {
+        console.log(chalk.bold("\nRe-indexing updated sources..."));
         openIndex();
         for (const lib of updatedLibs) {
             const count = indexLibrary(lib);
             console.log(`  ✓ Re-indexed ${lib.shortName}: ${count} documents`);
         }
+        if (examplesUpdated) {
+            const count = indexExamples();
+            console.log(`  ✓ Re-indexed examples: ${count} files`);
+        }
+        if (episodesUpdated) {
+            const count = indexEpisodes();
+            console.log(`  ✓ Re-indexed episodes: ${count} files`);
+        }
         closeIndex();
     }
     console.log(chalk.green(`\n✅ Update complete!\n`));

package/dist/config.d.ts

@@ -1,6 +1,10 @@
 /**
- * Configuration for Point-Free libraries
+ * Configuration for Point-Free libraries and example sources
  */
+/**
+ * Source types for documentation
+ */
+export type SourceType = "docs" | "examples" | "episodes";
 export interface LibraryConfig {
     name: string;
     shortName: string;
@@ -8,11 +12,34 @@ export interface LibraryConfig {
     docsPaths: string[];
     description: string;
 }
+export interface ExamplesConfig {
+    name: string;
+    shortName: string;
+    repo: string;
+    paths: string[];
+    description: string;
+    filePatterns: string[];
+}
+export interface EpisodesConfig {
+    name: string;
+    shortName: string;
+    repo: string;
+    description: string;
+    filePatterns: string[];
+}
 /**
  * All available Point-Free libraries
  * Add or remove libraries here to customize what's indexed
  */
 export declare const LIBRARIES: LibraryConfig[];
+/**
+ * TCA Examples configuration (CaseStudies, SyncUps, etc.)
+ */
+export declare const EXAMPLES_CONFIG: ExamplesConfig;
+/**
+ * Episode code samples configuration
+ */
+export declare const EPISODES_CONFIG: EpisodesConfig;
 /**
  * Get library config by short name
  */
@@ -21,6 +48,10 @@ export declare function getLibrary(shortName: string): LibraryConfig | undefined
  * All library short names
  */
 export declare const LIBRARY_NAMES: string[];
+/**
+ * All valid source types
+ */
+export declare const SOURCE_TYPES: SourceType[];
 export declare const PATHS: {
     dataDir: string;
     reposDir: string;

package/dist/config.js

@@ -1,5 +1,5 @@
 /**
- * Configuration for Point-Free libraries
+ * Configuration for Point-Free libraries and example sources
  */
 import { join } from "path";
 /**
@@ -100,6 +100,35 @@ export const LIBRARIES = [
         description: "Runtime warnings & assertions",
     },
 ];
+/**
+ * TCA Examples configuration (CaseStudies, SyncUps, etc.)
+ */
+export const EXAMPLES_CONFIG = {
+    name: "tca-examples",
+    shortName: "examples",
+    repo: "pointfreeco/swift-composable-architecture",
+    paths: [
+        "Examples/CaseStudies",
+        "Examples/SyncUps",
+        "Examples/Todos",
+        "Examples/VoiceMemos",
+        "Examples/Search",
+        "Examples/TicTacToe",
+        "Examples/SpeechRecognition",
+    ],
+    description: "TCA example apps and case studies",
+    filePatterns: ["**/*.swift"],
+};
+/**
+ * Episode code samples configuration
+ */
+export const EPISODES_CONFIG = {
+    name: "episode-code-samples",
+    shortName: "episodes",
+    repo: "pointfreeco/episode-code-samples",
+    description: "Point-Free episode code samples (350+ episodes)",
+    filePatterns: ["**/*.swift", "**/*.playground/**/*.swift"],
+};
 /**
  * Get library config by short name
  */
@@ -110,6 +139,10 @@ export function getLibrary(shortName) {
  * All library short names
  */
 export const LIBRARY_NAMES = LIBRARIES.map((lib) => lib.shortName);
+/**
+ * All valid source types
+ */
+export const SOURCE_TYPES = ["docs", "examples", "episodes"];
 /**
  * Paths configuration
  */

package/dist/lib/format.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Shared formatting utilities
+ */
+import { SourceType } from "../config.js";
+/**
+ * Get source type label with color and brackets for search/list results
+ */
+export declare function getSourceLabel(source: SourceType): string;
+/**
+ * Get source type name with color (for stats display)
+ */
+export declare function getSourceName(source: SourceType): string;

package/dist/lib/format.js

@@ -0,0 +1,30 @@
+/**
+ * Shared formatting utilities
+ */
+import chalk from "chalk";
+/**
+ * Get source type label with color and brackets for search/list results
+ */
+export function getSourceLabel(source) {
+    switch (source) {
+        case "docs":
+            return chalk.cyan("[DOC]");
+        case "examples":
+            return chalk.magenta("[EXAMPLE]");
+        case "episodes":
+            return chalk.yellow("[EPISODE]");
+    }
+}
+/**
+ * Get source type name with color (for stats display)
+ */
+export function getSourceName(source) {
+    switch (source) {
+        case "docs":
+            return chalk.cyan("docs");
+        case "examples":
+            return chalk.magenta("examples");
+        case "episodes":
+            return chalk.yellow("episodes");
+    }
+}

package/dist/lib/index.d.ts

@@ -2,11 +2,12 @@
  * Search index using SQLite FTS5 for full-text search
  */
 import Database from "better-sqlite3";
-import { LibraryConfig } from "../config.js";
+import { LibraryConfig, SourceType } from "../config.js";
 export interface DocEntry {
     library: string;
     path: string;
     title: string;
+    source: SourceType;
 }
 export interface DocWithContent extends DocEntry {
     content: string;
@@ -14,6 +15,7 @@ export interface DocWithContent extends DocEntry {
 export interface IndexStats {
     totalDocs: number;
     byLibrary: Record<string, number>;
+    bySource: Record<SourceType, number>;
 }
 /**
  * Initialize or open the search index database
@@ -23,6 +25,14 @@ export declare function openIndex(): Database.Database;
  * Index all documentation files for a library
  */
 export declare function indexLibrary(lib: LibraryConfig): number;
+/**
+ * Index TCA examples (CaseStudies, etc.)
+ */
+export declare function indexExamples(): number;
+/**
+ * Index episode code samples
+ */
+export declare function indexEpisodes(): number;
 /**
  * Search the index
  */
@@ -32,15 +42,17 @@ export interface SearchResult {
     title: string;
     snippet: string;
     score: number;
+    source: SourceType;
 }
 export declare function search(query: string, options?: {
     lib?: string;
     limit?: number;
+    source?: SourceType | "all";
 }): SearchResult[];
 /**
  * List all indexed documents
  */
-export declare function listDocs(lib?: string): DocEntry[];
+export declare function listDocs(lib?: string, source?: SourceType | "all"): DocEntry[];
 /**
  * Get a specific document by path
  */