reroute-js 0.0.1

package/README.md

@@ -0,0 +1,144 @@
+# Reroute
+
+A dead simple file-based routing framework for building fullstack React apps on Bun and Elysia. No extra dependencies are required.
+
+## ✨ Features
+
+### 🎯 Core Framework
+- ⚡ **Built on Bun** - Lightning-fast JavaScript runtime for everything
+- 🔄 **File-Based Routing** - Automatic route generation from your file structure
+- 🎨 **Server-Side Rendering (SSR)** - SEO-friendly React rendering on the server
+- 🔥 **Live Reload** - Live reload in development mode with instant feedback
+- 📦 **Zero Config** - Works out of the box with sensible defaults
+
+### 🛠️ CLI Tools
+- 🚀 **`reroute init`** - Scaffold new projects with templates (basic, blog)
+- 🔨 **`reroute gen`** - Generate content registry and route artifacts
+
+### 📄 Content Management
+- 📚 **Content Collections** - Organize content by collections (blog posts, docs, etc.)
+- 🔍 **Content Discovery** - Automatic scanning and indexing of content files
+- 🏷️ **Metadata Extraction** - Support for content metadata
+- 📑 **Content Registry** - Pre-generated content index for fast lookups
+- 🎯 **Dynamic Imports** - Code-split content chunks for optimal loading
+- 📦 **Collection Chunking** - Individual module bundles per content item
+
+### ⚛️ React Integration
+- 🪝 **Router Hooks**:
+  - `useNavigate()` - Programmatic navigation
+  - `useParams()` - Access route parameters
+  - `useSearchParams()` - Query string manipulation
+  - `useRouter()` - Access router state and utilities
+- 📚 **Content Hooks**:
+  - `useContent()` - Load and manage content collections with sorting
+- 🧩 **Components**:
+  - `<Link>` - Client-side navigation with automatic prefetching
+  - `<Outlet>` - Render nested route components
+  - `<ContentRoute>` - Dynamic content rendering with metadata injection
+- 🎭 **Providers**:
+  - `<RouterProvider>` - Router context for the app
+  - `<ContentProvider>` - Content system context
+  - `<RerouteProvider>` - All-in-one provider wrapper
+ - 🗂️ **SSR Data**:
+   - `useData()` - Read route-level SSR data without loaders
+   - `export const ssr = { data() {} }` - Route data function executed on server
+
+### 🚀 Performance Optimizations
+- 💾 **Smart Caching** - LRU cache for files and bundles
+- 🔗 **Link Prefetching** - Automatic content prefetching on hover/focus
+- 📦 **Bundle Hashing** - Content-based hashing for optimal cache invalidation
+- ⚡ **Module Preloading** - Browser hints for critical resources
+- 🎯 **SSR Module Seeding** - Pre-populate modules for instant hydration
+- 📊 **Collection Inlining** - Inline collection data for zero-latency rendering
+
+### 🎨 Developer Experience
+- 📁 **Project Templates** - Quick start with `basic` or `blog` templates
+- 🔄 **Live Reload** - Server-Sent Events (SSE) for instant browser updates
+- 🎯 **TypeScript Support** - Full type safety throughout the stack
+- 🗂️ **File System Watcher** - Automatic rebuilds on source changes
+- 🎪 **404 Handling** - Custom NotFound routes with pattern matching
+- 🏗️ **Layout System** - Shared layouts across route groups
+
+### 🌐 Server Features (Elysia Plugin)
+- 🔌 **Elysia Plugin** - Drop-in plugin for Elysia apps
+- 🎨 **SSR Routes** - Server-rendered React pages
+- 📄 **Static File Serving** - Optimized bundle delivery
+- 📚 **Content API Routes** - Dynamic content endpoints
+- 🛠️ **Dev Mode Routes** - Development tooling and live reload
+- 📦 **Artifact Routes** - Serve generated content chunks and registry
+
+### 🎯 Build System
+- 🔧 **Transpilation** - TypeScript/JSX to optimized JavaScript
+- 🗜️ **Minification** - Optional code minification for production
+- 🗺️ **Source Maps** - Debug support with source map generation
+- 📦 **Module Bundling** - Efficient code splitting and bundling
+- 🎯 **Tree Shaking** - Remove unused code automatically
+
+### 🎨 Head Management
+- 🏷️ **Meta Tags** - Automatic meta tag injection from content metadata
+- 📝 **Per-Page Head** - Route-specific head elements
+- 🌍 **Language Attribute** - Dynamic `lang` attribute support
+- 🎯 **SEO Optimization** - Title, description, and custom meta tags
+
+### 📦 Configuration Options
+- 🎯 **Custom Assets Directory** - Configure where your client files live
+- 🔧 **URL Prefix** - Deploy to subdirectories with custom prefixes
+- 🚫 **Ignore Patterns** - Exclude files from static serving
+- 🏷️ **Custom Headers** - Add headers to static file responses
+ - ⏰ **Cache Control** - Configurable max-age and cache directives for static files and `__reroute_data` JSON
+- 🎨 **HTML Template** - Custom index.html with variable substitution
+
+## 🚀 Quick Start
+
+```bash
+# Create a new project
+bunx reroute-js init my-app
+
+# Or with a template
+bunx reroute-js init my-blog --template blog
+
+# Navigate to project
+cd my-app
+
+# Start development
+bun dev
+```
+
+## 📖 Learn More
+
+- [Examples](./examples) - Example projects to get started
+- [GitHub](https://github.com/stewones/reroute) - Source code and issues
+
+## 🔌 SSR Data: External Requests Without Loaders
+
+Reroute can execute route-level data fetching on the server and inline the result for instant hydration. Define an optional `ssr.data` in a route module and read it with `useData()`:
+
+```tsx
+// routes/products/[id].tsx
+import { useData, useParams } from 'reroute-js/react';
+import { getProduct } from '../lib/api';
+
+export const ssr = {
+  async data({ params }: { params: { id?: string } }) {
+    const id = Number.parseInt(params.id || '');
+    if (!Number.isFinite(id)) return { product: null };
+    const product = await getProduct(id);
+    return { product };
+  },
+};
+
+export default function Page() {
+  const { id } = useParams<{ id: string }>();
+  const data = useData<{ product: any }>(); // keyed by pathname
+  return <div>{data?.product?.title || `Invalid product ${id}`}</div>;
+}
+```
+
+Notes:
+- Works with Bun + Elysia SSR, no client loaders needed for initial render
+- Data is injected as `window.__REROUTE_DATA__` and read during hydration
+- Use with existing content features (useContent); both can be seeded in the same page
+
+## 📝 License
+
+MIT

package/cli/bin.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env bun
+export * from './src';
+//# sourceMappingURL=bin.d.ts.map

package/cli/bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../../../../packages/cli/bin.ts"],"names":[],"mappings":";AAEA,cAAc,OAAO,CAAC"}