fix(sitemap): complete gracefully when all pages have noIndex meta (#7774)

packages/docusaurus-plugin-sitemap/src/__tests__/createSitemap.test.ts

@@ -172,4 +172,39 @@ describe('createSitemap', () => {
 
     expect(sitemap).not.toContain('/noindex');
   });
+
+  it('does not generate anything for all pages with noindex', async () => {
+    const sitemap = await createSitemap(
+      {
+        url: 'https://example.com',
+        trailingSlash: false,
+      } as DocusaurusConfig,
+      ['/', '/noindex'],
+      {
+        '/': {
+          meta: {
+            // @ts-expect-error: bad lib def
+            toComponent: () => [
+              React.createElement('meta', {name: 'robots', content: 'noindex'}),
+            ],
+          },
+        },
+        '/noindex': {
+          meta: {
+            // @ts-expect-error: bad lib def
+            toComponent: () => [
+              React.createElement('meta', {name: 'robots', content: 'noindex'}),
+            ],
+          },
+        },
+      },
+      {
+        changefreq: EnumChangefreq.DAILY,
+        priority: 0.7,
+        ignorePatterns: [],
+      },
+    );
+
+    expect(sitemap).toBeNull();
+  });
 });

packages/docusaurus-plugin-sitemap/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,

packages/docusaurus-plugin-sitemap/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);