@docusaurus/plugin-sitemap 0.0.0-5198 → 0.0.0-5202

package/lib/createSitemap.d.ts

@@ -9,4 +9,4 @@ import type { HelmetServerState } from 'react-helmet-async';
 import type { PluginOptions } from './options';
 export default function createSitemap(siteConfig: DocusaurusConfig, routesPaths: string[], head: {
     [location: string]: HelmetServerState;
-}, options: PluginOptions): Promise<string>;
+}, options: PluginOptions): Promise<string | null>;

package/lib/createSitemap.js

@@ -16,16 +16,19 @@ async function createSitemap(siteConfig, routesPaths, head, options) {
     }
     const { changefreq, priority, ignorePatterns } = options;
     const ignoreMatcher = (0, utils_1.createMatcher)(ignorePatterns);
-    const sitemapStream = new sitemap_1.SitemapStream({ hostname });
-    function routeShouldBeIncluded(route) {
+    const includedRoutes = routesPaths.filter((route) => {
         if (route.endsWith('404.html') || ignoreMatcher(route)) {
             return false;
         }
         // https://github.com/staylor/react-helmet-async/pull/167
         const meta = head[route]?.meta.toComponent();
         return !meta?.some((tag) => tag.props.name === 'robots' && tag.props.content === 'noindex');
+    });
+    if (includedRoutes.length === 0) {
+        return null;
     }
-    routesPaths.filter(routeShouldBeIncluded).forEach((routePath) => sitemapStream.write({
+    const sitemapStream = new sitemap_1.SitemapStream({ hostname });
+    includedRoutes.forEach((routePath) => sitemapStream.write({
         url: (0, utils_common_1.applyTrailingSlash)(routePath, {
             trailingSlash: siteConfig.trailingSlash,
             baseUrl: siteConfig.baseUrl,

package/lib/index.js

@@ -21,6 +21,9 @@ function pluginSitemap(context, options) {
             }
             // Generate sitemap.
             const generatedSitemap = await (0, createSitemap_1.default)(siteConfig, routesPaths, head, options);
+            if (!generatedSitemap) {
+                return;
+            }
             // Write sitemap file.
             const sitemapPath = path_1.default.join(outDir, options.filename);
             try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-sitemap",
-  "version": "0.0.0-5198",
+  "version": "0.0.0-5202",
   "description": "Simple sitemap generation plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -18,12 +18,12 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5198",
-    "@docusaurus/logger": "0.0.0-5198",
-    "@docusaurus/types": "0.0.0-5198",
-    "@docusaurus/utils": "0.0.0-5198",
-    "@docusaurus/utils-common": "0.0.0-5198",
-    "@docusaurus/utils-validation": "0.0.0-5198",
+    "@docusaurus/core": "0.0.0-5202",
+    "@docusaurus/logger": "0.0.0-5202",
+    "@docusaurus/types": "0.0.0-5202",
+    "@docusaurus/utils": "0.0.0-5202",
+    "@docusaurus/utils-common": "0.0.0-5202",
+    "@docusaurus/utils-validation": "0.0.0-5202",
     "fs-extra": "^10.1.0",
     "sitemap": "^7.1.1",
     "tslib": "^2.4.0"
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "fa05cb6f54018d631ea8fa546d7c9bb80716adb3"
+  "gitHead": "8fdf5bb62596a5c639458ef9adb13698ee632f43"
 }

package/src/createSitemap.ts

@@ -18,7 +18,7 @@ export default async function createSitemap(
   routesPaths: string[],
   head: {[location: string]: HelmetServerState},
   options: PluginOptions,
-): Promise<string> {
+): Promise<string | null> {
   const {url: hostname} = siteConfig;
   if (!hostname) {
     throw new Error('URL in docusaurus.config.js cannot be empty/undefined.');
@@ -27,9 +27,7 @@ export default async function createSitemap(
 
   const ignoreMatcher = createMatcher(ignorePatterns);
 
-  const sitemapStream = new SitemapStream({hostname});
-
-  function routeShouldBeIncluded(route: string) {
+  const includedRoutes = routesPaths.filter((route) => {
     if (route.endsWith('404.html') || ignoreMatcher(route)) {
       return false;
     }
@@ -40,9 +38,15 @@ export default async function createSitemap(
     return !meta?.some(
       (tag) => tag.props.name === 'robots' && tag.props.content === 'noindex',
     );
+  });
+
+  if (includedRoutes.length === 0) {
+    return null;
   }
 
-  routesPaths.filter(routeShouldBeIncluded).forEach((routePath) =>
+  const sitemapStream = new SitemapStream({hostname});
+
+  includedRoutes.forEach((routePath) =>
     sitemapStream.write({
       url: applyTrailingSlash(routePath, {
         trailingSlash: siteConfig.trailingSlash,

package/src/index.ts

@@ -30,6 +30,9 @@ export default function pluginSitemap(
         head,
         options,
       );
+      if (!generatedSitemap) {
+        return;
+      }
 
       // Write sitemap file.
       const sitemapPath = path.join(outDir, options.filename);