vite-plugin-kiru 0.29.10 → 0.29.11

package/README.md

@@ -1,14 +1,6 @@
 # vite-plugin-kiru
 
-Vite plugin for <a href="https://kirujs.dev">Kiru</a> apps that enables HMR, devtools, file-based routing, and SSG/SSR.
-
-## Installation
-
-```bash
-npm i -D vite-plugin-kiru
-# or
-pnpm add -D vite-plugin-kiru
-```
+Vite plugin for <a href="https://kirujs.dev">Kiru</a> apps that enables HMR, devtools, and SSG with file-based routing & sitemap generation.
 
 ## Basic Usage
 
@@ -60,25 +52,106 @@ kiru({
   onFileExcluded: (id) => {
     console.log(`Excluded: ${id}`)
   },
+
+  // Static Site Generation (SSG) configuration
+  ssg: {
+    // Base URL for the app
+    baseUrl: "/",
+    // Directory containing pages
+    dir: "./src/pages",
+    // Document component filename pattern
+    document: "document.{tsx,jsx}",
+    // Page component filename pattern
+    page: "index.{tsx,jsx}",
+    // Layout component filename pattern
+    layout: "layout.{tsx,jsx}",
+    // Enable view transitions for route changes and page loaders
+    transition: true,
+    // Build options
+    build: {
+      // Maximum number of pages to render concurrently
+      maxConcurrentRenders: 100,
+    },
+    // Sitemap generation options
+    sitemap: {
+      // Domain for sitemap URLs (required)
+      domain: "https://example.com",
+      // Default last modified date for all URLs
+      lastmod: new Date(),
+      // Default change frequency (hourly | daily | weekly | monthly | yearly | never)
+      changefreq: "weekly", // default: "weekly"
+      // Default priority (0.0 to 1.0)
+      priority: 0.5, // default: 0.5
+      // Per-route overrides
+      overrides: {
+        "/": {
+          changefreq: "daily",
+          priority: 0.8,
+          lastmod: new Date("2024-01-01"),
+          // Images to include for this route
+          images: ["/images/hero.png"],
+          // Videos to include for this route
+          videos: [
+            {
+              title: "Product Demo",
+              thumbnail_loc: "/images/video-thumbnail.png",
+              description: "A demonstration of our product features.",
+            },
+          ],
+        },
+        "/blog": {
+          changefreq: "weekly",
+          priority: 0.7,
+        },
+      },
+    },
+  },
+
+  // Or, if you want to enable SSG with default configuration:
+  ssg: true,
+  // (this will not include sitemap generation as it requires manual configuration)
 })
 ```
 
+## Static Site Generation (SSG)
+
+The plugin supports static site generation with configurable sitemap creation. When SSG is enabled, all routes are pre-rendered at build time and a `sitemap.xml` file is generated if configured.
+
+### Sitemap Generation
+
+The sitemap feature generates a `sitemap.xml` file in your build output with all discovered routes (excluding 404 pages).
+
+**Features:**
+
+- Automatic route discovery from your file structure
+- Configurable default `changefreq`, `priority`, and `lastmod` for all routes
+- Per-route overrides for fine-grained control
+- Support for images and videos (Google sitemap extensions)
+
+**Example:**
+
+```ts
+ssg: {
+  sitemap: {
+    domain: "https://kirujs.dev",
+    changefreq: "weekly",
+    priority: 0.5,
+    overrides: {
+      "/": {
+        changefreq: "daily",
+        priority: 0.8,
+        images: ["/images/kiru.png"],
+      },
+    },
+  },
+}
+```
+
+This will generate a `sitemap.xml` file in `dist/client/sitemap.xml` with all your routes properly formatted.
+
 ## Features
 
-- **File-based routing**: Automatic route generation from your pages directory
-- **SSR/SSG**: Server-side rendering and static site generation
+- **SSG + file-based routing**: Automatic route discovery, static site and sitemap generation
 - **HMR**: Hot module replacement for fast development
 - **Devtools**: Built-in development tools for debugging
 - **TypeScript**: Full TypeScript support with proper type definitions
-
-## Architecture
-
-The plugin is organized into focused modules:
-
-- `virtual-modules.ts` - Virtual module generation for routing
-- `dev-server.ts` - Development server SSR handling
-- `preview-server.ts` - Preview server middleware
-- `devtools.ts` - Development tools integration
-- `ssg.ts` - Static site generation
-- `config.ts` - Configuration management
-- `utils.ts` - Shared utilities

package/dist/index.d.ts

@@ -10,6 +10,86 @@ export interface SSGBuildOptions {
   maxConcurrentRenders?: number
 }
 
+export type SSGSitemapChangefreq =
+  // | "always"
+  "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never"
+
+export interface SSGSitemapVideo {
+  title: string
+  thumbnail_loc: string
+  description?: string
+}
+
+export interface SSGSitemapOverride {
+  /**
+   * Change frequency override for this route
+   * @default "weekly"
+   */
+  changefreq?: SSGSitemapChangefreq
+  /**
+   * Priority override for this route (0.0 to 1.0)
+   * @default 0.5
+   */
+  priority?: number
+  /**
+   * Last modified date override for this route
+   */
+  lastmod?: Date
+  /**
+   * Images to include for this route
+   * @example ["/images/kiru.png"]
+   */
+  images?: string[]
+  /**
+   * Videos to include for this route
+   * @example
+   * ```ts
+   * videos: [
+   *   {
+   *     title: "Kiru",
+   *     thumbnail_loc: "/images/kiru.png",
+   *     description: "Kiru is a framework for building web applications."
+   *   }
+   * ]
+   * ```
+   */
+  videos?: Array<SSGSitemapVideo>
+}
+
+export interface SSGSitemapOptions {
+  /**
+   * The domain to use for sitemap URLs
+   * @example "https://example.com"
+   */
+  domain: string
+  /**
+   * Default last modified date for all URLs
+   */
+  lastmod?: Date
+  /**
+   * Default change frequency for all URLs
+   * @default "weekly"
+   */
+  changefreq?: SSGSitemapChangefreq
+  /**
+   * Default priority for all URLs (0.0 to 1.0)
+   * @default 0.5
+   */
+  priority?: number
+  /**
+   * Per-route overrides for sitemap entries
+   * @example
+   * ```ts
+   * overrides: {
+   *   "/": {
+   *     changefreq: "never",
+   *     priority: 0.8,
+   *   },
+   * }
+   */
+  overrides?: Record<string, SSGSitemapOverride>
+}
+
 export interface SSGOptions {
   /**
    * The base URL of the app
@@ -42,6 +122,11 @@ export interface SSGOptions {
    */
   transition?: boolean
 
+  /**
+   * Options for sitemap generation
+   */
+  sitemap?: SSGSitemapOptions
+
   /**
    * Options for build
    */

package/dist/index.js

@@ -8968,6 +8968,7 @@ function createPluginState(opts = {}) {
       page: ssg.page ?? page,
       layout: ssg.layout ?? layout,
       transition: ssg.transition ?? transition,
+      sitemap: ssg.sitemap,
       build: {
         maxConcurrentRenders: ssg.build?.maxConcurrentRenders ?? maxConcurrentRenders
       }
@@ -11212,7 +11213,7 @@ import path6 from "node:path";
 import fs3 from "node:fs";
 import { pathToFileURL } from "node:url";
 async function generateStaticSite(state, outputOptions, bundle, log) {
-  const { projectRoot, baseOutDir, manifestPath } = state;
+  const { projectRoot, baseOutDir, manifestPath, ssgOptions } = state;
   const outDirAbs = path6.resolve(projectRoot, outputOptions?.dir ?? "dist");
   const ssrEntry = Object.values(bundle).find(
     (c) => c.type === "chunk" && c.isEntry
@@ -11234,7 +11235,7 @@ async function generateStaticSite(state, outputOptions, bundle, log) {
   const routes = Object.keys(paths);
   log(ANSI.cyan("[SSG]"), `discovered ${routes.length} routes:`, routes);
   const renderingChunks = [];
-  const maxConcurrentRenders = state.ssgOptions.build.maxConcurrentRenders;
+  const maxConcurrentRenders = ssgOptions.build.maxConcurrentRenders;
   for (let i = 0; i < routes.length; i += maxConcurrentRenders) {
     const chunkKeys = routes.slice(i, i + maxConcurrentRenders);
     renderingChunks.push(
@@ -11263,6 +11264,9 @@ async function generateStaticSite(state, outputOptions, bundle, log) {
     );
   }
   await appendStaticPropsToClientModules(state, clientOutDirAbs, log);
+  if (ssgOptions.sitemap?.domain) {
+    await generateSitemap(state, routes, clientOutDirAbs, log);
+  }
 }
 async function getClientAssets(clientOutDirAbs, manifestPath) {
   let clientEntry = null;
@@ -11395,6 +11399,101 @@ function getOutputPath(clientOutDirAbs, route) {
   }
   return path6.resolve(dirPath, `${last}.html`);
 }
+async function generateSitemap(state, routes, clientOutDirAbs, log) {
+  const sitemapConfig = state.ssgOptions.sitemap;
+  const {
+    domain,
+    lastmod: lastModified,
+    changefreq = "weekly",
+    priority = 0.5,
+    overrides = {}
+  } = sitemapConfig;
+  const baseUrl = state.ssgOptions.baseUrl;
+  const normalizedDomain = domain.replace(/\/$/, "");
+  const normalizedBaseUrl = baseUrl === "/" ? "" : baseUrl.replace(/\/$/, "");
+  let hasImages = false;
+  let hasVideos = false;
+  for (const route of routes) {
+    const override = overrides[route];
+    if (override?.images?.length) {
+      hasImages = true;
+    }
+    if (override?.videos?.length) {
+      hasVideos = true;
+    }
+  }
+  const sortedRoutes = [...routes].filter((route) => !route.endsWith("/404")).sort((a, b) => {
+    if (a === "/") return -1;
+    if (b === "/") return 1;
+    const aDepth = a.split("/").filter(Boolean).length;
+    const bDepth = b.split("/").filter(Boolean).length;
+    if (aDepth !== bDepth) {
+      return aDepth - bDepth;
+    }
+    return a < b ? -1 : a > b ? 1 : 0;
+  });
+  const urls = sortedRoutes.map((route) => {
+    const normalizedRoute = route.startsWith("/") ? route : `/${route}`;
+    const url = `${normalizedDomain}${normalizedBaseUrl}${normalizedRoute}`;
+    const override = overrides[route] || {};
+    const routeChangefreq = override.changefreq ?? changefreq;
+    const routePriority = override.priority ?? priority;
+    const routeLastModified = override.lastmod ?? lastModified;
+    let urlEntry = `  <url>
+    <loc>${escapeXml(url)}</loc>
+    <changefreq>${routeChangefreq}</changefreq>
+    <priority>${routePriority}</priority>`;
+    if (routeLastModified) {
+      const lastMod = routeLastModified.toISOString().split("T")[0];
+      urlEntry += `
+    <lastmod>${lastMod}</lastmod>`;
+    }
+    if (override.images?.length) {
+      for (const image of override.images) {
+        const imageUrl = image.startsWith("http") ? image : `${normalizedDomain}${normalizedBaseUrl}${image.startsWith("/") ? image : `/${image}`}`;
+        urlEntry += `
+    <image:image>
+      <image:loc>${escapeXml(imageUrl)}</image:loc>
+    </image:image>`;
+      }
+    }
+    if (override.videos?.length) {
+      for (const video of override.videos) {
+        const thumbnailUrl = video.thumbnail_loc.startsWith("http") ? video.thumbnail_loc : `${normalizedDomain}${normalizedBaseUrl}${video.thumbnail_loc.startsWith("/") ? video.thumbnail_loc : `/${video.thumbnail_loc}`}`;
+        urlEntry += `
+    <video:video>
+      <video:title>${escapeXml(video.title)}</video:title>
+      <video:thumbnail_loc>${escapeXml(thumbnailUrl)}</video:thumbnail_loc>`;
+        if (video.description) {
+          urlEntry += `
+      <video:description>${escapeXml(
+            video.description
+          )}</video:description>`;
+        }
+        urlEntry += `
+    </video:video>`;
+      }
+    }
+    urlEntry += `
+  </url>`;
+    return urlEntry;
+  }).join("\n");
+  const namespaces = [
+    'xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"',
+    hasImages && 'xmlns:image="http://www.google.com/schemas/sitemap-image/1.1"',
+    hasVideos && 'xmlns:video="http://www.google.com/schemas/sitemap-video/1.1"'
+  ].filter(Boolean).join(" ");
+  const sitemapXml = `<?xml version="1.0" encoding="UTF-8"?>
+<urlset ${namespaces}>
+${urls}
+</urlset>`;
+  const sitemapPath = path6.resolve(clientOutDirAbs, "sitemap.xml");
+  fs3.writeFileSync(sitemapPath, sitemapXml, "utf-8");
+  log(ANSI.cyan("[SSG]"), "Generated sitemap:", ANSI.black(sitemapPath));
+}
+function escapeXml(unsafe) {
+  return unsafe.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&apos;");
+}
 async function appendStaticPropsToClientModules(state, clientOutDirAbs, log) {
   const { projectRoot, manifestPath, ssgOptions } = state;
   try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-kiru",
-  "version": "0.29.10",
+  "version": "0.29.11",
   "description": "",
   "main": "dist/index.js",
   "type": "module",
@@ -24,7 +24,7 @@
     "glob": "^11.0.3",
     "magic-string": "^0.30.17",
     "mime": "^4.1.0",
-    "vite": "^7.0.6"
+    "vite": "^7.2.2"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\"",