vite-plugin-sitemap-ts 1.0.0 → 1.1.0

package/README.md

@@ -2,8 +2,8 @@
 
 A Vite plugin to generate `sitemap.xml`. Works in development mode by proxying middleware to `/sitemap.xml`.
 
-> [!IMPORTANT]
-> This plugin is actively being devloped. DO NOT USE IN PRODUCTION!
+> [!WARNING]
+> **DO NOT USE IN PRODUCTION!** This plugin is actively being devloped.
 
 ## Installation
 
@@ -23,16 +23,20 @@ import { sitemap } from 'vite-plugin-sitemap-ts'
 
 export default {
   plugins: [
-    sitemap(),
+    sitemap({
+      hostname: 'https://example.com',
+    }),
   ],
 }
 ```
 
 ## Options
 
-All options are optional.
+The `hostname` option is required. All other options are optional.
 
-| Option  | Type                               | Default | Description                                                                  |
-|---------|------------------------------------|---------|------------------------------------------------------------------------------|
-| enabled | *boolean*                          | `true`  | Toggle the plugin on or off                                                  |
+| Option   | Type       | Default | Description                                                          |
+|----------|------------|---------|----------------------------------------------------------------------|
+| hostname | *string*   | -       | The hostname of the site, used to build the full URLs in the sitemap |
+| enabled  | *boolean*  | `true`  | Toggle the plugin on or off                                          |
+| routes   | *string[]* | `['/']` | An array of routes to include in the sitemap                         |
 

package/dist/index.cjs

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -24,10 +34,69 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
+// src/plugin.ts
+var import_node_fs = __toESM(require("fs"), 1);
+var import_node_path = __toESM(require("path"), 1);
+
 // src/utils.ts
-var SITEMAP_CONTENT = `<?xml version="1.0" encoding="UTF-8"?>
-  <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+var SPACER = "  ";
+var DSPACER = SPACER + SPACER;
+var xmlHeader = `<?xml version="1.0" encoding="UTF-8"?>`;
+var xmlSchema = (content) => {
+  return `<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+${content}
 </urlset>`;
+};
+var escapeXml = (value) => {
+  return String(value).replace(/[&<>"']/g, (ch) => {
+    switch (ch) {
+      case "&":
+        return "&amp;";
+      case "<":
+        return "&lt;";
+      case ">":
+        return "&gt;";
+      case '"':
+        return "&quot;";
+      case "'":
+        return "&apos;";
+      default:
+        return ch;
+    }
+  });
+};
+var generateSitemap = (entries) => {
+  const urls = entries.map((entry) => {
+    let sitemapEntry = `${DSPACER}<loc>${escapeXml(entry.loc)}</loc>`;
+    if (entry.lastmod) {
+      sitemapEntry += `
+${DSPACER}<lastmod>${escapeXml(entry.lastmod)}</lastmod>`;
+    }
+    if (entry.changefreq) {
+      sitemapEntry += `
+${DSPACER}<changefreq>${escapeXml(entry.changefreq)}</changefreq>`;
+    }
+    if (entry.priority !== void 0) {
+      sitemapEntry += `
+${DSPACER}<priority>${escapeXml(entry.priority)}</priority>`;
+    }
+    return `${SPACER}<url>
+${sitemapEntry}
+${SPACER}</url>`;
+  }).join("\n");
+  return `${xmlHeader}
+${xmlSchema(urls)}`;
+};
+var buildSitemapEntries = (options) => {
+  const host = options.hostname.replace(/\/$/, "");
+  const lastmod = (/* @__PURE__ */ new Date()).toISOString();
+  return options.routes.map((route) => {
+    return {
+      loc: `${host}/${route.replace(/^\/+/, "")}`,
+      lastmod
+    };
+  });
+};
 var logColor = (color, text, bold = false) => {
   const colorCode = {
     red: bold ? "\x1B[1;31m" : "\x1B[31m",
@@ -45,11 +114,15 @@ var LOGGER_FAILURE = logColor("red", "\u2717", true);
 var BASE_PATH = "/";
 var FILE_NAME = "sitemap.xml";
 var SITEMAP_PATH = `${BASE_PATH}${FILE_NAME}`;
-function sitemap(options = {}) {
+function sitemap(options) {
   let config;
   let success = false;
-  const sitemapContent = SITEMAP_CONTENT;
   const enabled = options.enabled ?? true;
+  const host = options.hostname ?? void 0;
+  const routes = options.routes ?? ["/"];
+  if (!host) {
+    throw new Error("Sitemap hostname is not set and required to build the sitemap.");
+  }
   return {
     name: "vite-plugin-sitemap-ts",
     apply: () => enabled,
@@ -58,27 +131,30 @@ function sitemap(options = {}) {
     },
     configureServer(server) {
       server.middlewares.use(SITEMAP_PATH, (_req, res) => {
+        const entries = buildSitemapEntries({ hostname: host, routes });
+        const content = generateSitemap(entries);
         res.setHeader("Content-Type", "text/xml; charset=utf-8");
-        res.end(sitemapContent);
+        res.end(content);
       });
       config.logger.info(
         `${LOGGER_CLEAR}${LOGGER_SUCCESS} ${LOGGER_PREFIX} Exposed new route: ${logColor("green", SITEMAP_PATH)}`
       );
     },
-    generateBundle() {
-      if (this.environment?.name && this.environment.name !== "client") {
-        return;
+    closeBundle() {
+      if (this.environment) {
+        if (this.environment.name !== "client" || this.environment.mode === "dev") {
+          return;
+        }
       }
-      config.logger.info(
-        `
-- ${LOGGER_CLEAR}${LOGGER_PREFIX} Writing sitemap.xml at ${config.build.outDir}${SITEMAP_PATH}`
-      );
+      const outDir = config.build.outDir.replace("server", "client");
+      config.logger.info(`
+- ${LOGGER_CLEAR}${LOGGER_PREFIX} Writing sitemap.xml at ${outDir}${SITEMAP_PATH}`);
       try {
-        this.emitFile({
-          type: "asset",
-          fileName: FILE_NAME,
-          source: sitemapContent
-        });
+        const entries = buildSitemapEntries({ hostname: host, routes });
+        const content = generateSitemap(entries);
+        const outDirPath = import_node_path.default.resolve(config.root, outDir);
+        const filePath = import_node_path.default.join(outDirPath, FILE_NAME);
+        import_node_fs.default.writeFileSync(filePath, content, "utf-8");
         success = true;
       } catch (_err) {
         success = false;

package/dist/index.d.cts

@@ -1,5 +1,12 @@
 import { Plugin } from 'vite';
 
+type ChangeFreq = 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
+type SitemapEntry = {
+    loc: string;
+    lastmod?: string;
+    priority?: number;
+    changefreq?: ChangeFreq;
+};
 type Options = {
     /**
      * Toggle the plugin on or off. Useful if you want to disable the plugin, e.g. in development mode.
@@ -7,8 +14,20 @@ type Options = {
      * **Default: `true`**
      */
     enabled?: boolean;
+    /**
+     * The hostname of the site, used to build the full URLs in the sitemap.
+     *
+     * **Example: `'https://example.com'`**
+     */
+    hostname: string;
+    /**
+     * An array of routes to include in the sitemap.
+     *
+     * **Default: `['/']`**
+     */
+    routes?: string[];
 };
 
-declare function sitemap(options?: Options): Plugin;
+declare function sitemap(options: Options): Plugin;
 
-export { type Options, sitemap };
+export { type ChangeFreq, type Options, type SitemapEntry, sitemap };

package/dist/index.d.ts

@@ -1,5 +1,12 @@
 import { Plugin } from 'vite';
 
+type ChangeFreq = 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
+type SitemapEntry = {
+    loc: string;
+    lastmod?: string;
+    priority?: number;
+    changefreq?: ChangeFreq;
+};
 type Options = {
     /**
      * Toggle the plugin on or off. Useful if you want to disable the plugin, e.g. in development mode.
@@ -7,8 +14,20 @@ type Options = {
      * **Default: `true`**
      */
     enabled?: boolean;
+    /**
+     * The hostname of the site, used to build the full URLs in the sitemap.
+     *
+     * **Example: `'https://example.com'`**
+     */
+    hostname: string;
+    /**
+     * An array of routes to include in the sitemap.
+     *
+     * **Default: `['/']`**
+     */
+    routes?: string[];
 };
 
-declare function sitemap(options?: Options): Plugin;
+declare function sitemap(options: Options): Plugin;
 
-export { type Options, sitemap };
+export { type ChangeFreq, type Options, type SitemapEntry, sitemap };

package/dist/index.js

@@ -1,7 +1,66 @@
+// src/plugin.ts
+import fs from "fs";
+import path from "path";
+
 // src/utils.ts
-var SITEMAP_CONTENT = `<?xml version="1.0" encoding="UTF-8"?>
-  <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+var SPACER = "  ";
+var DSPACER = SPACER + SPACER;
+var xmlHeader = `<?xml version="1.0" encoding="UTF-8"?>`;
+var xmlSchema = (content) => {
+  return `<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+${content}
 </urlset>`;
+};
+var escapeXml = (value) => {
+  return String(value).replace(/[&<>"']/g, (ch) => {
+    switch (ch) {
+      case "&":
+        return "&amp;";
+      case "<":
+        return "&lt;";
+      case ">":
+        return "&gt;";
+      case '"':
+        return "&quot;";
+      case "'":
+        return "&apos;";
+      default:
+        return ch;
+    }
+  });
+};
+var generateSitemap = (entries) => {
+  const urls = entries.map((entry) => {
+    let sitemapEntry = `${DSPACER}<loc>${escapeXml(entry.loc)}</loc>`;
+    if (entry.lastmod) {
+      sitemapEntry += `
+${DSPACER}<lastmod>${escapeXml(entry.lastmod)}</lastmod>`;
+    }
+    if (entry.changefreq) {
+      sitemapEntry += `
+${DSPACER}<changefreq>${escapeXml(entry.changefreq)}</changefreq>`;
+    }
+    if (entry.priority !== void 0) {
+      sitemapEntry += `
+${DSPACER}<priority>${escapeXml(entry.priority)}</priority>`;
+    }
+    return `${SPACER}<url>
+${sitemapEntry}
+${SPACER}</url>`;
+  }).join("\n");
+  return `${xmlHeader}
+${xmlSchema(urls)}`;
+};
+var buildSitemapEntries = (options) => {
+  const host = options.hostname.replace(/\/$/, "");
+  const lastmod = (/* @__PURE__ */ new Date()).toISOString();
+  return options.routes.map((route) => {
+    return {
+      loc: `${host}/${route.replace(/^\/+/, "")}`,
+      lastmod
+    };
+  });
+};
 var logColor = (color, text, bold = false) => {
   const colorCode = {
     red: bold ? "\x1B[1;31m" : "\x1B[31m",
@@ -19,11 +78,15 @@ var LOGGER_FAILURE = logColor("red", "\u2717", true);
 var BASE_PATH = "/";
 var FILE_NAME = "sitemap.xml";
 var SITEMAP_PATH = `${BASE_PATH}${FILE_NAME}`;
-function sitemap(options = {}) {
+function sitemap(options) {
   let config;
   let success = false;
-  const sitemapContent = SITEMAP_CONTENT;
   const enabled = options.enabled ?? true;
+  const host = options.hostname ?? void 0;
+  const routes = options.routes ?? ["/"];
+  if (!host) {
+    throw new Error("Sitemap hostname is not set and required to build the sitemap.");
+  }
   return {
     name: "vite-plugin-sitemap-ts",
     apply: () => enabled,
@@ -32,27 +95,30 @@ function sitemap(options = {}) {
     },
     configureServer(server) {
       server.middlewares.use(SITEMAP_PATH, (_req, res) => {
+        const entries = buildSitemapEntries({ hostname: host, routes });
+        const content = generateSitemap(entries);
         res.setHeader("Content-Type", "text/xml; charset=utf-8");
-        res.end(sitemapContent);
+        res.end(content);
       });
       config.logger.info(
         `${LOGGER_CLEAR}${LOGGER_SUCCESS} ${LOGGER_PREFIX} Exposed new route: ${logColor("green", SITEMAP_PATH)}`
       );
     },
-    generateBundle() {
-      if (this.environment?.name && this.environment.name !== "client") {
-        return;
+    closeBundle() {
+      if (this.environment) {
+        if (this.environment.name !== "client" || this.environment.mode === "dev") {
+          return;
+        }
       }
-      config.logger.info(
-        `
-- ${LOGGER_CLEAR}${LOGGER_PREFIX} Writing sitemap.xml at ${config.build.outDir}${SITEMAP_PATH}`
-      );
+      const outDir = config.build.outDir.replace("server", "client");
+      config.logger.info(`
+- ${LOGGER_CLEAR}${LOGGER_PREFIX} Writing sitemap.xml at ${outDir}${SITEMAP_PATH}`);
       try {
-        this.emitFile({
-          type: "asset",
-          fileName: FILE_NAME,
-          source: sitemapContent
-        });
+        const entries = buildSitemapEntries({ hostname: host, routes });
+        const content = generateSitemap(entries);
+        const outDirPath = path.resolve(config.root, outDir);
+        const filePath = path.join(outDirPath, FILE_NAME);
+        fs.writeFileSync(filePath, content, "utf-8");
         success = true;
       } catch (_err) {
         success = false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-sitemap-ts",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Vite plugin to generate sitemap.xml. Works in dev mode.",
   "author": "Cornelius Weidmann <cornelius@kyco.io> (https://kyco.io)",
   "license": "MIT",
@@ -63,7 +63,7 @@
     "vite": ">=2"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.4.6",
+    "@biomejs/biome": "^2.4.7",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^12.0.6",