feat(sitemap): remove trailingSlash option; respect noIndex config (#6248)

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

@@ -19,7 +19,6 @@ describe('createSitemap', () => {
       {
         changefreq: EnumChangefreq.DAILY,
         priority: 0.7,
-        trailingSlash: false,
       },
     );
     expect(sitemap).toContain(
@@ -43,7 +42,6 @@ describe('createSitemap', () => {
       {
         changefreq: EnumChangefreq.DAILY,
         priority: 0.7,
-        trailingSlash: false,
       },
     );
     expect(sitemap).not.toContain('404');
@@ -105,23 +103,4 @@ describe('createSitemap', () => {
     expect(sitemap).toContain('<loc>https://example.com/nested/test</loc>');
     expect(sitemap).toContain('<loc>https://example.com/nested/test2</loc>');
   });
-
-  test('add trailing slash (deprecated plugin option)', async () => {
-    const sitemap = await createSitemap(
-      {
-        url: 'https://example.com',
-      } as DocusaurusConfig,
-      ['/', '/test', '/nested/test', '/nested/test2/'],
-      {
-        changefreq: EnumChangefreq.DAILY,
-        priority: 0.7,
-        trailingSlash: true,
-      },
-    );
-
-    expect(sitemap).toContain('<loc>https://example.com/</loc>');
-    expect(sitemap).toContain('<loc>https://example.com/test/</loc>');
-    expect(sitemap).toContain('<loc>https://example.com/nested/test/</loc>');
-    expect(sitemap).toContain('<loc>https://example.com/nested/test2/</loc>');
-  });
 });

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

@@ -28,15 +28,9 @@ describe('normalizeSitemapPluginOptions', () => {
     const userOptions = {
       changefreq: 'yearly',
       priority: 0.9,
-      trailingSlash: false,
     };
-    const {value, warning} = await PluginOptionSchema.validate(userOptions);
+    const {value} = await PluginOptionSchema.validate(userOptions);
     expect(value).toEqual(userOptions);
-
-    expect(warning?.details?.length).toEqual(1);
-    expect(warning?.details[0].message).toMatchInlineSnapshot(
-      `"Option \\"trailingSlash\\" of the sitemap plugin is deprecated: Please use the new Docusaurus global trailingSlash config instead, and the sitemaps plugin will use it."`,
-    );
   });
 
   test('should reject out-of-range priority inputs', () => {

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

@@ -8,7 +8,6 @@
 import {SitemapStream, streamToPromise} from 'sitemap';
 import type {Options} from '@docusaurus/plugin-sitemap';
 import type {DocusaurusConfig} from '@docusaurus/types';
-import {addTrailingSlash} from '@docusaurus/utils';
 import {applyTrailingSlash} from '@docusaurus/utils-common';
 
 export default async function createSitemap(
@@ -22,28 +21,16 @@ export default async function createSitemap(
   }
   const {changefreq, priority} = options;
 
-  const sitemapStream = new SitemapStream({
+  const sitemapStream = new SitemapStream({hostname});
-    hostname,
-  });
-
-  function applySitemapTrailingSlash(routePath: string): string {
-    // kept for retrocompatibility
-    // TODO remove deprecated trailingSlash option before 2022
-    if (options.trailingSlash) {
-      return addTrailingSlash(routePath);
-    } else {
-      return applyTrailingSlash(routePath, {
-        trailingSlash: siteConfig.trailingSlash,
-        baseUrl: siteConfig.baseUrl,
-      });
-    }
-  }
 
   routesPaths
     .filter((route) => !route.endsWith('404.html'))
-    .map((routePath) =>
+    .forEach((routePath) =>
       sitemapStream.write({
-        url: applySitemapTrailingSlash(routePath),
+        url: applyTrailingSlash(routePath, {
+          trailingSlash: siteConfig.trailingSlash,
+          baseUrl: siteConfig.baseUrl,
+        }),
         changefreq,
         priority,
       }),
@@ -51,9 +38,7 @@ export default async function createSitemap(
 
   sitemapStream.end();
 
-  const generatedSitemap = await streamToPromise(sitemapStream).then((sm) =>
+  const generatedSitemap = (await streamToPromise(sitemapStream)).toString();
-    sm.toString(),
-  );
 
   return generatedSitemap;
 }

packages/docusaurus-plugin-sitemap/src/index.ts

@@ -26,6 +26,9 @@ export default function pluginSitemap(
     name: 'docusaurus-plugin-sitemap',
 
     async postBuild({siteConfig, routesPaths, outDir}: Props) {
+      if (siteConfig.noIndex) {
+        return;
+      }
       // Generate sitemap.
       const generatedSitemap = await createSitemap(
         siteConfig,

packages/docusaurus-plugin-sitemap/src/plugin-sitemap.d.ts

@@ -10,5 +10,4 @@ import type {EnumChangefreq} from 'sitemap';
 export type Options = {
   changefreq?: EnumChangefreq;
   priority?: number;
-  trailingSlash?: boolean;
 };

packages/docusaurus-plugin-sitemap/src/pluginOptionSchema.ts

@@ -12,7 +12,6 @@ import type {Options} from '@docusaurus/plugin-sitemap';
 export const DEFAULT_OPTIONS: Required<Options> = {
   changefreq: EnumChangefreq.WEEKLY,
   priority: 0.5,
-  trailingSlash: false,
 };
 
 export const PluginOptionSchema = Joi.object({
@@ -25,10 +24,8 @@ export const PluginOptionSchema = Joi.object({
     .valid(...Object.values(EnumChangefreq))
     .default(DEFAULT_OPTIONS.changefreq),
   priority: Joi.number().min(0).max(1).default(DEFAULT_OPTIONS.priority),
-  trailingSlash: Joi.bool().default(false).warning('deprecate.error', {
+  trailingSlash: Joi.forbidden().messages({
-    msg: 'Please use the new Docusaurus global trailingSlash config instead, and the sitemaps plugin will use it.',
+    'any.unknown':
+      'Please use the new Docusaurus global trailingSlash config instead, and the sitemaps plugin will use it.',
   }),
-}).messages({
-  'deprecate.error':
-    'Option {#label} of the sitemap plugin is deprecated: {#msg}',
 });

website/docs/api/plugins/plugin-sitemap.md

@@ -42,6 +42,15 @@ Accepted fields:
 
 </APITable>
 
+:::info
+
+This plugin also respects some site config:
+
+- [`noIndex`](../docusaurus.config.js.md#noindex): results in no sitemap generated
+- [`trailingSlash`](../docusaurus.config.js.md#trailing-slash): determines if the URLs in the sitemap have trailing slashes
+
+:::
+
 ### Example configuration {#ex-config}
 
 You can configure this plugin through preset options or plugin options.