create-specra 0.1.0

package/templates/minimal/scripts/index-search.ts

@@ -0,0 +1,159 @@
+import { MeiliSearch } from "meilisearch"
+import fs from "fs"
+import path from "path"
+import matter from "gray-matter"
+import { getConfig } from "specra"
+import { extractSearchText } from "specra/components"
+// import { extractSearchText } from "@/components/docs/componentTextProps"
+
+interface SearchDocument {
+    id: string
+    title: string
+    content: string
+    slug: string
+    version: string
+    category?: string
+    tags?: string[]
+}
+
+
+async function indexDocuments() {
+    const config = getConfig()
+    const searchConfig = config.search
+
+    if (!searchConfig?.enabled || searchConfig.provider !== "meilisearch") {
+        console.error("Meilisearch is not enabled in config")
+        process.exit(1)
+    }
+
+    const meilisearchConfig = searchConfig.meilisearch
+    if (!meilisearchConfig) {
+        console.error("Meilisearch configuration is missing")
+        process.exit(1)
+    }
+
+    console.log("Connecting to Meilisearch at:", meilisearchConfig.host)
+
+    const client = new MeiliSearch({
+        host: meilisearchConfig.host,
+        apiKey: meilisearchConfig.apiKey || "",
+    })
+
+    const index = client.index(meilisearchConfig.indexName)
+
+    // Get all MDX files
+    const docsDir = path.join(process.cwd(), "docs")
+    const documents: SearchDocument[] = []
+
+    function processDirectory(dir: string, version: string) {
+        const files = fs.readdirSync(dir)
+
+        for (const file of files) {
+            const filePath = path.join(dir, file)
+            const stat = fs.statSync(filePath)
+
+            if (stat.isDirectory()) {
+                processDirectory(filePath, version)
+            } else if (file.endsWith(".mdx") || file.endsWith(".md")) {
+                const content = fs.readFileSync(filePath, "utf-8")
+                const { data, content: mdxContent } = matter(content)
+
+                // Generate slug from file path
+                const relativePath = path.relative(path.join(docsDir, version), filePath)
+                const slug = relativePath
+                    .replace(/\.(mdx|md)$/, "")
+                    .replace(/\\/g, "/")
+
+                // Extract category from path
+                const pathParts = slug.split("/")
+                const category = pathParts.length > 1 ? pathParts[0] : undefined
+
+                // Clean content (remove code blocks and special chars for better search)
+                // const cleanContent = mdxContent
+                //     .replace(/```[\s\S]*?```/g, "") // Remove code blocks
+                //     .replace(/`[^`]+`/g, "") // Remove inline code
+                //     .replace(/[#*_~]/g, "") // Remove markdown symbols
+                //     .replace(/\n+/g, " ") // Replace newlines with spaces
+                //     .trim()
+                //     .slice(0, 1000) // Limit content length
+
+                const cleanContent = extractSearchText(mdxContent);
+
+                // console.log("------");
+                // console.log("Cleaned content: ");
+                // console.log(cleanContent);
+                // console.log("------");
+                // Create a valid document ID (replace periods with underscores)
+                // const docId = `${version.replace(/\./g, "_")}-${slug.replace(/\//g, "-")}`
+                const docId = slug.replace(/\//g, "-")
+
+                documents.push({
+                    id: docId,
+                    title: data.title || slug,
+                    content: cleanContent,
+                    slug: slug,
+                    version: version,
+                    category: category,
+                    tags: data.tags || [],
+                })
+            }
+        }
+    }
+
+    // Process all version directories
+    const versions = fs.readdirSync(docsDir).filter((item) => {
+        const itemPath = path.join(docsDir, item)
+        return fs.statSync(itemPath).isDirectory()
+    })
+
+    console.log(`Found ${versions.length} version(s):`, versions.join(", "))
+
+    for (const version of versions) {
+        const versionPath = path.join(docsDir, version)
+        processDirectory(versionPath, version)
+    }
+
+    console.log(`Indexing ${documents.length} documents...`)
+
+    try {
+        // Configure searchable attributes first
+        console.log("Configuring search settings...")
+        await index.updateSearchableAttributes(["title", "content", "tags"])
+        await index.updateFilterableAttributes(["version", "category", "tags"])
+        await index.updateSortableAttributes(["title"])
+        await index.updateDistinctAttribute("id")
+        await index.updateSettings({
+            rankingRules: [
+                "words",
+                "typo",
+                "proximity",
+                "attribute",
+                "sort",
+                "exactness"
+            ]
+        })
+        console.log("✅ Search configuration updated!")
+
+        // Delete existing documents
+        console.log("Clearing old documents...")
+        const deleteTask = await index.deleteAllDocuments()
+        console.log("Delete task created:", deleteTask.taskUid)
+
+        // Add new documents
+        console.log("Adding documents...")
+        const addTask = await index.addDocuments(documents, { primaryKey: "id" })
+        console.log("Add task created:", addTask.taskUid)
+        console.log("✅ Documents sent for indexing!")
+
+        console.log("\n⏳ Indexing is processing in the background...")
+        console.log("Wait a few seconds, then run 'npm run test:search' to verify!")
+    } catch (error) {
+        console.error("Error indexing documents:", error)
+        if (error instanceof Error) {
+            console.error("Error message:", error.message)
+        }
+        process.exit(1)
+    }
+}
+
+indexDocuments()

package/templates/minimal/scripts/test-search.ts

@@ -0,0 +1,83 @@
+import { MeiliSearch } from "meilisearch"
+import { getConfig } from "specra"
+
+async function testSearch() {
+    const config = getConfig()
+    const searchConfig = config.search
+
+    if (!searchConfig?.enabled || searchConfig.provider !== "meilisearch") {
+        console.error("Meilisearch is not enabled in config")
+        process.exit(1)
+    }
+
+    const meilisearchConfig = searchConfig.meilisearch
+    if (!meilisearchConfig) {
+        console.error("Meilisearch configuration is missing")
+        process.exit(1)
+    }
+
+    console.log("Connecting to Meilisearch at:", meilisearchConfig.host)
+    console.log("Using API Key:", meilisearchConfig.apiKey ? "Yes" : "No")
+
+    const client = new MeiliSearch({
+        host: meilisearchConfig.host,
+        apiKey: meilisearchConfig.apiKey || "",
+    })
+
+    const index = client.index(meilisearchConfig.indexName)
+
+    try {
+        // Get index stats
+        console.log("\n📊 Index Stats:")
+        const stats = await index.getStats()
+        console.log("- Number of documents:", stats.numberOfDocuments)
+        console.log("- Is indexing:", stats.isIndexing)
+        console.log("- Field distribution:", JSON.stringify(stats.fieldDistribution, null, 2))
+
+        // Get some documents
+        console.log("\n📄 Sample Documents:")
+        const documents = await index.getDocuments({ limit: 3 })
+        console.log("Total documents:", documents.results.length)
+        documents.results.forEach((doc: any, i: number) => {
+            console.log(`\nDocument ${i + 1}:`)
+            console.log("- ID:", doc.id)
+            console.log("- Title:", doc.title)
+            console.log("- Version:", doc.version)
+            console.log("- Slug:", doc.slug)
+            console.log("- Category:", doc.category)
+            console.log("- Content preview:", doc.content?.substring(0, 100) + "...")
+        })
+
+        // Test search
+        console.log("\n🔍 Testing Search:")
+        const searchQueries = ["documentation", "getting", "guide", "intro"]
+        
+        for (const query of searchQueries) {
+            const results = await index.search(query, {
+                limit: 5,
+            })
+            console.log(`\nQuery: "${query}"`)
+            console.log(`- Results found: ${results.hits.length}`)
+            console.log(`- Processing time: ${results.processingTimeMs}ms`)
+            if (results.hits.length > 0) {
+                console.log("- First result:", (results.hits[0] as any).title)
+            }
+        }
+
+        // Get searchable attributes
+        console.log("\n⚙️  Index Settings:")
+        const searchableAttrs = await index.getSearchableAttributes()
+        console.log("- Searchable attributes:", searchableAttrs)
+        
+        const filterableAttrs = await index.getFilterableAttributes()
+        console.log("- Filterable attributes:", filterableAttrs)
+
+    } catch (error) {
+        console.error("\n❌ Error:", error)
+        if (error instanceof Error) {
+            console.error("Message:", error.message)
+        }
+    }
+}
+
+testSearch()

package/templates/minimal/specra.config.json

@@ -0,0 +1,124 @@
+{
+  "$schema": "./lib/config.types.ts",
+  "site": {
+    "title": "Documentation Library",
+    "description": "Comprehensive documentation for your project",
+    "url": "https://vercel.com/dalmasontos-projects/v0-documentation-library",
+    "baseUrl": "/",
+    "language": "en",
+    "organizationName": "Your Organization",
+    "projectName": "v0-documentation-library",
+    "activeVersion": "v1.0.0",
+    "favicon": "/icon-light-32x32.png"
+  },
+  "theme": {
+    "defaultMode": "system",
+    "respectPrefersColorScheme": true
+  },
+  "navigation": {
+    "showSidebar": true,
+    "collapsibleSidebar": true,
+    "showBreadcrumbs": true,
+    "showTableOfContents": true,
+    "tocPosition": "right",
+    "tocMaxDepth": 3,
+    "tabGroups": [
+      {
+        "id": "guides",
+        "label": "Guides",
+        "icon": "book-open"
+      },
+      {
+        "id": "api",
+        "label": "API Reference",
+        "icon": "zap"
+      },
+      {
+        "id": "components",
+        "label": "Components",
+        "icon": "layers"
+      }
+    ]
+  },
+  "social": {
+    "github": "https://github.com/dalmasonto",
+    "twitter": "https://twitter.com/dalmasonto",
+    "discord": "https://discord.com/invite/dalmasonto",
+    "custom": [
+      {
+        "label": "Website",
+        "href": "https://craftfolio.com/dalmasonto"
+      }
+    ]
+  },
+  "search": {
+    "enabled": false,
+    "placeholder": "Search documentation...",
+    "provider": "meilisearch",
+    "meilisearch": {
+      "host": "http://localhost:7700",
+      "apiKey": "aSampleMasterKey",
+      "indexName": "docs"
+    }
+  },
+  "analytics": {
+    "googleAnalytics": "",
+    "plausible": ""
+  },
+  "footer": {
+    "copyright": "Copyright © 2024 Specra. All rights reserved.",
+    "links": [
+      {
+        "title": "Documentation",
+        "items": [
+          {
+            "label": "Getting Started",
+            "href": "/docs/v1.0.0/getting-started"
+          },
+          {
+            "label": "API Reference",
+            "href": "/docs/v1.0.0/api"
+          }
+        ]
+      },
+      {
+        "title": "Community",
+        "items": [
+          {
+            "label": "GitHub",
+            "href": "https://github.com/yourusername/your-repo"
+          },
+          {
+            "label": "Discord",
+            "href": "#"
+          }
+        ]
+      }
+    ]
+  },
+  "banner": {
+    "enabled": false,
+    "message": "🎉 This is a development version. Some features may not work as expected.",
+    "type": "error",
+    "dismissible": true
+  },
+  "features": {
+    "editUrl": "https://github.com/yourusername/your-repo/edit/main/docs",
+    "showLastUpdated": true,
+    "showReadingTime": true,
+    "showAuthors": false,
+    "showTags": true,
+    "versioning": true,
+    "i18n": false
+  },
+  "env": {
+    "API_BASE_URL": "https://api.example.com",
+    "API_VERSION": "v1",
+    "CDN_URL": "https://cdn.example.com"
+  },
+  "deployment": {
+    "target": "github-pages",
+    "basePath": "",
+    "customDomain": false
+  }
+}

package/templates/minimal/tsconfig.json

@@ -0,0 +1,41 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": true,
+    "target": "ES6",
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "react-jsx",
+    "incremental": true,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "paths": {
+      "@/*": [
+        "./*"
+      ]
+    }
+  },
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts",
+    ".next/dev/types/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}