npm - vite-plugin-sitemap-ts - Versions diffs - 0.1.0 - Mend

vite-plugin-sitemap-ts 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 Cornelius Weidmann
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,35 @@
+# vite-plugin-sitemap-ts
+A Vite plugin to generate `sitemap.xml`. Works in development mode by proxying middleware to `/sitemap.xml`.
+## Installation
+```bash
+npm install -D vite-plugin-sitemap-ts
+pnpm add -D vite-plugin-sitemap-ts
+yarn add -D vite-plugin-sitemap-ts
+bun add -D vite-plugin-sitemap-ts
+deno add -D npm:vite-plugin-sitemap-ts
+```
+## Usage
+```ts
+// vite.config.ts
+import { sitemap } from 'vite-plugin-sitemap-ts'
+export default {
+  plugins: [
+    sitemap(),
+  ],
+}
+```
+## Options
+All options are optional.
+| Option  | Type                               | Default | Description                                                                  |
+|---------|------------------------------------|---------|------------------------------------------------------------------------------|
+| enabled | *boolean*                          | `true`  | Toggle the plugin on or off                                                  |

package/dist/index.cjs ADDED Viewed

@@ -0,0 +1,95 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  sitemap: () => sitemap
+});
+module.exports = __toCommonJS(index_exports);
+// src/utils.ts
+var SITEMAP_CONTENT = `<?xml version="1.0" encoding="UTF-8"?>
+  <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+</urlset>`;
+var logColor = (color, text, bold = false) => {
+  const colorCode = {
+    red: bold ? "\x1B[1;31m" : "\x1B[31m",
+    green: bold ? "\x1B[1;32m" : "\x1B[32m",
+    yellow: bold ? "\x1B[1;33m" : "\x1B[33m"
+  };
+  return `${colorCode[color]}${text}${LOGGER_CLEAR}`;
+};
+var LOGGER_CLEAR = "\x1B[0m";
+var LOGGER_PREFIX = logColor("yellow", "[sitemap-ts]", true);
+var LOGGER_SUCCESS = logColor("green", "\u2713", true);
+var LOGGER_FAILURE = logColor("red", "\u2717", true);
+// src/plugin.ts
+var BASE_PATH = "/";
+var FILE_NAME = "sitemap.xml";
+var SITEMAP_PATH = `${BASE_PATH}${FILE_NAME}`;
+function sitemap(options = {}) {
+  let config;
+  let success = false;
+  const sitemapContent = SITEMAP_CONTENT;
+  const enabled = options.enabled ?? true;
+  return {
+    name: "vite-plugin-sitemap-ts",
+    apply: () => enabled,
+    configResolved(resolvedConfig) {
+      config = resolvedConfig;
+    },
+    configureServer(server) {
+      server.middlewares.use(SITEMAP_PATH, (_req, res) => {
+        res.setHeader("Content-Type", "text/xml; charset=utf-8");
+        res.end(sitemapContent);
+      });
+      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;
+      }
+      config.logger.info(
+        `
+- ${LOGGER_CLEAR}${LOGGER_PREFIX} Writing sitemap.xml at ${config.build.outDir}${SITEMAP_PATH}`
+      );
+      try {
+        this.emitFile({
+          type: "asset",
+          fileName: FILE_NAME,
+          source: sitemapContent
+        });
+        success = true;
+      } catch (_err) {
+        success = false;
+      }
+      config.logger.info(
+        `${LOGGER_CLEAR}${success ? LOGGER_SUCCESS : LOGGER_FAILURE} ${LOGGER_PREFIX} ${success ? `Success` : `Failed writing sitemap.xml!`}`
+      );
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  sitemap
+});

package/dist/index.d.cts ADDED Viewed

@@ -0,0 +1,14 @@
+import { Plugin } from 'vite';
+type Options = {
+    /**
+     * Toggle the plugin on or off. Useful if you want to disable the plugin, e.g. in development mode.
+     *
+     * **Default: `true`**
+     */
+    enabled?: boolean;
+};
+declare function sitemap(options?: Options): Plugin;
+export { type Options, sitemap };

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,14 @@
+import { Plugin } from 'vite';
+type Options = {
+    /**
+     * Toggle the plugin on or off. Useful if you want to disable the plugin, e.g. in development mode.
+     *
+     * **Default: `true`**
+     */
+    enabled?: boolean;
+};
+declare function sitemap(options?: Options): Plugin;
+export { type Options, sitemap };

package/dist/index.js ADDED Viewed

@@ -0,0 +1,68 @@
+// src/utils.ts
+var SITEMAP_CONTENT = `<?xml version="1.0" encoding="UTF-8"?>
+  <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+</urlset>`;
+var logColor = (color, text, bold = false) => {
+  const colorCode = {
+    red: bold ? "\x1B[1;31m" : "\x1B[31m",
+    green: bold ? "\x1B[1;32m" : "\x1B[32m",
+    yellow: bold ? "\x1B[1;33m" : "\x1B[33m"
+  };
+  return `${colorCode[color]}${text}${LOGGER_CLEAR}`;
+};
+var LOGGER_CLEAR = "\x1B[0m";
+var LOGGER_PREFIX = logColor("yellow", "[sitemap-ts]", true);
+var LOGGER_SUCCESS = logColor("green", "\u2713", true);
+var LOGGER_FAILURE = logColor("red", "\u2717", true);
+// src/plugin.ts
+var BASE_PATH = "/";
+var FILE_NAME = "sitemap.xml";
+var SITEMAP_PATH = `${BASE_PATH}${FILE_NAME}`;
+function sitemap(options = {}) {
+  let config;
+  let success = false;
+  const sitemapContent = SITEMAP_CONTENT;
+  const enabled = options.enabled ?? true;
+  return {
+    name: "vite-plugin-sitemap-ts",
+    apply: () => enabled,
+    configResolved(resolvedConfig) {
+      config = resolvedConfig;
+    },
+    configureServer(server) {
+      server.middlewares.use(SITEMAP_PATH, (_req, res) => {
+        res.setHeader("Content-Type", "text/xml; charset=utf-8");
+        res.end(sitemapContent);
+      });
+      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;
+      }
+      config.logger.info(
+        `
+- ${LOGGER_CLEAR}${LOGGER_PREFIX} Writing sitemap.xml at ${config.build.outDir}${SITEMAP_PATH}`
+      );
+      try {
+        this.emitFile({
+          type: "asset",
+          fileName: FILE_NAME,
+          source: sitemapContent
+        });
+        success = true;
+      } catch (_err) {
+        success = false;
+      }
+      config.logger.info(
+        `${LOGGER_CLEAR}${success ? LOGGER_SUCCESS : LOGGER_FAILURE} ${LOGGER_PREFIX} ${success ? `Success` : `Failed writing sitemap.xml!`}`
+      );
+    }
+  };
+}
+export {
+  sitemap
+};

package/package.json ADDED Viewed

@@ -0,0 +1,78 @@
+{
+  "name": "vite-plugin-sitemap-ts",
+  "version": "0.1.0",
+  "description": "Vite plugin to generate sitemap.xml. Works in dev mode.",
+  "author": "Cornelius Weidmann <cornelius@kyco.io> (https://kyco.io)",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "provenance": true
+  },
+  "keywords": [
+    "vite",
+    "vite-plugin",
+    "sitemap",
+    "sitemap.xml",
+    "typescript"
+  ],
+  "homepage": "https://github.com/kyco/vite-plugin-sitemap-ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kyco/vite-plugin-sitemap-ts.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kyco/vite-plugin-sitemap-ts/issues"
+  },
+  "scripts": {
+    "build": "tsup",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "tsup",
+    "demo:dev": "pnpm --filter basic dev",
+    "demo:build": "pnpm --filter basic build",
+    "demo:preview": "pnpm --filter basic preview",
+    "demo:tanstack:dev": "pnpm --filter tanstack dev",
+    "demo:tanstack:build": "pnpm --filter tanstack build",
+    "demo:tanstack:preview": "pnpm --filter tanstack preview",
+    "clean": "rm -rf dist node_modules demo/*/dist demo/*/node_modules",
+    "update-packages": "pnpm dlx npm-check-updates --format group -i"
+  },
+  "packageManager": "pnpm@10.32.1",
+  "peerDependencies": {
+    "vite": ">=2"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.6",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.6",
+    "@semantic-release/npm": "^13.1.5",
+    "conventional-changelog-conventionalcommits": "^9.3.0",
+    "semantic-release": "^25.0.3",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.1",
+    "vitest": "^4.1.0"
+  }
+}