svelte-sitemap 3.2.0 → 3.3.0-next.1

package/README.md

@@ -9,7 +9,7 @@
 ---
 
 - ➡️ Designed for SvelteKit `adapter-static` with `prerender` option (SSG)
-- 🔷 TypeScript, JavaScript, CLI version
+- 🔷 TypeScript, JavaScript, CLI and **Vite plugin** version
 - 🔧 Useful [options](#%EF%B8%8F-options) for customizing your sitemap
 - 📡 [Ping](#-ping-google-search-console) Google Search Console after deploy
 - 🗂️ Support for [sitemap index](https://developers.google.com/search/docs/crawling-indexing/sitemaps/large-sitemaps) for large sites (50K+ pages)
@@ -26,9 +26,34 @@ npm install svelte-sitemap --save-dev
 
 ## 🚀 Usage
 
-> There are three ways to use this library. Pick the one that suits you best.
+We recommend using the **Vite plugin** (Method 1) as it integrates directly into your build pipeline. For other setups, you can use a config file, CLI, or the JS API.
 
-### ✨ Method 1: Config file (recommended)
+### ⚡ Method 1: Vite plugin (Recommended)
+
+If you're using SvelteKit with Vite (which is the default), you can integrate the sitemap generation directly into the Vite build pipeline.
+
+Add the plugin to your `vite.config.ts`:
+
+```typescript
+// vite.config.ts
+import { sveltekit } from '@sveltejs/kit/vite';
+import { svelteSitemap } from 'svelte-sitemap/vite'; // <-- Add svelte-sitemap vite plugin
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  plugins: [
+    sveltekit(),
+    svelteSitemap({ domain: 'https://example.com' }) // <-- Configure the plugin with your options
+  ]
+});
+```
+
+The sitemap is generated automatically at the end of every `vite build`. All [options](#%EF%B8%8F-options) are supported.
+
+---
+
+<details>
+<summary><b>✨ Method 2: Config file (Alternative)</b></summary>
 
 Create a config file `svelte-sitemap.config.ts` in the root of your project:
 
@@ -57,9 +82,10 @@ Then add `svelte-sitemap` as a `postbuild` script in `package.json`:
 
 That's it. After every `build`, the sitemap is automatically generated in your `build/` folder.
 
----
+</details>
 
-### ⌨️ Method 2: CLI (legacy)
+<details>
+<summary><b>⌨️ Method 3: CLI (legacy)</b></summary>
 
 Pass options directly as CLI flags — no config file needed:
 
@@ -73,9 +99,10 @@ Pass options directly as CLI flags — no config file needed:
 
 See all available flags in the [Options](#%EF%B8%8F-options) table below.
 
----
+</details>
 
-### 🔧 Method 3: JavaScript / TypeScript API
+<details>
+<summary><b>🔧 Method 4: JavaScript / TypeScript API</b></summary>
 
 Sometimes it's useful to call the script directly from code:
 
@@ -92,6 +119,8 @@ Run your script:
 node my-script.js
 ```
 
+</details>
+
 ---
 
 ## ⚙️ Options

package/package.js

@@ -1,5 +1,5 @@
 //#region package.json
-var version = "3.2.0";
+var version = "3.3.0-next.1";
 //#endregion
 export { version };
 

package/package.json

@@ -1,10 +1,18 @@
 {
   "name": "svelte-sitemap",
-  "version": "3.2.0",
+  "version": "3.3.0-next.1",
   "type": "module",
   "description": "Small helper which scans your Svelte routes folder and generates static sitemap.xml",
   "author": "BART! <bart@bartweb.cz>",
   "bin": "cli.js",
+  "peerDependencies": {
+    "vite": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "fast-glob": "^3.3.3",
     "jiti": "^2.7.0",
@@ -62,6 +70,7 @@
   "exports": {
     ".": "./index.js",
     "./cli": "./cli.js",
+    "./vite": "./vite.js",
     "./package.json": "./package.json"
   }
 }

package/vite.d.ts

@@ -0,0 +1,8 @@
+import { OptionsSvelteSitemap } from "./dto/global.interface.js";
+import { Plugin } from "vite";
+
+//#region src/vite.d.ts
+declare function svelteSitemap(options: OptionsSvelteSitemap): Plugin;
+//#endregion
+export { svelteSitemap };
+//# sourceMappingURL=vite.d.ts.map

package/vite.js

@@ -0,0 +1,15 @@
+import { createSitemap } from "./index.js";
+//#region src/vite.ts
+function svelteSitemap(options) {
+	return {
+		name: "svelte-sitemap",
+		apply: "build",
+		closeBundle: async () => {
+			await createSitemap(options);
+		}
+	};
+}
+//#endregion
+export { svelteSitemap };
+
+//# sourceMappingURL=vite.js.map

package/vite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite.js","names":[],"sources":["../src/vite.ts"],"sourcesContent":["import type { Plugin } from 'vite';\nimport type { OptionsSvelteSitemap } from './dto/index.js';\nimport { createSitemap } from './index.js';\n\nexport function svelteSitemap(options: OptionsSvelteSitemap): Plugin {\n  return {\n    name: 'svelte-sitemap',\n    apply: 'build',\n    closeBundle: async () => {\n      await createSitemap(options);\n    }\n  };\n}\n"],"mappings":";;AAIA,SAAgB,cAAc,SAAuC;CACnE,OAAO;EACL,MAAM;EACN,OAAO;EACP,aAAa,YAAY;GACvB,MAAM,cAAc,OAAO;EAC7B;CACF;AACF"}