@docusaurus/plugin-sitemap 2.0.0-beta.1ab8aa0af → 2.0.0-beta.2

package/lib/createSitemap.js

@@ -8,19 +8,30 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const sitemap_1 = require("sitemap");
 const utils_1 = require("@docusaurus/utils");
+const utils_common_1 = require("@docusaurus/utils-common");
 async function createSitemap(siteConfig, routesPaths, options) {
     const { url: hostname } = siteConfig;
     if (!hostname) {
-        throw new Error('url in docusaurus.config.js cannot be empty/undefined');
+        throw new Error('URL in docusaurus.config.js cannot be empty/undefined.');
     }
     const { changefreq, priority, trailingSlash } = options;
     const sitemapStream = new sitemap_1.SitemapStream({
         hostname,
     });
+    function applySitemapTrailingSlash(routePath) {
+        // kept for retrocompatibility
+        // TODO remove deprecated trailingSlash option before 2022
+        if (options.trailingSlash) {
+            return utils_1.addTrailingSlash(routePath);
+        }
+        else {
+            return utils_common_1.applyTrailingSlash(routePath, trailingSlash);
+        }
+    }
     routesPaths
         .filter((route) => !route.endsWith('404.html'))
         .map((routePath) => sitemapStream.write({
-        url: trailingSlash ? utils_1.addTrailingSlash(routePath) : routePath,
+        url: applySitemapTrailingSlash(routePath),
         changefreq,
         priority,
     }));

package/lib/index.js

@@ -24,7 +24,7 @@ function pluginSitemap(_context, options) {
                 await fs_extra_1.default.outputFile(sitemapPath, generatedSitemap);
             }
             catch (err) {
-                throw new Error(`Sitemap error: ${err}`);
+                throw new Error(`Writing sitemap failed: ${err}`);
             }
         },
     };

package/lib/pluginOptionSchema.js

@@ -23,5 +23,9 @@ exports.PluginOptionSchema = utils_validation_1.Joi.object({
         .valid(...Object.values(sitemap_1.EnumChangefreq))
         .default(exports.DEFAULT_OPTIONS.changefreq),
     priority: utils_validation_1.Joi.number().min(0).max(1).default(exports.DEFAULT_OPTIONS.priority),
-    trailingSlash: utils_validation_1.Joi.bool().default(false),
+    trailingSlash: utils_validation_1.Joi.bool().default(false).warning('deprecate.error', {
+        msg: '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}',
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-sitemap",
-  "version": "2.0.0-beta.1ab8aa0af",
+  "version": "2.0.0-beta.2",
   "description": "Simple sitemap generation plugin for Docusaurus.",
   "main": "lib/index.js",
   "scripts": {
@@ -17,13 +17,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.1ab8aa0af",
-    "@docusaurus/types": "2.0.0-beta.1ab8aa0af",
-    "@docusaurus/utils": "2.0.0-beta.1ab8aa0af",
-    "@docusaurus/utils-validation": "2.0.0-beta.1ab8aa0af",
-    "fs-extra": "^9.1.0",
-    "sitemap": "^6.3.6",
-    "tslib": "^2.1.0"
+    "@docusaurus/core": "2.0.0-beta.2",
+    "@docusaurus/types": "2.0.0-beta.2",
+    "@docusaurus/utils": "2.0.0-beta.2",
+    "@docusaurus/utils-common": "2.0.0-beta.2",
+    "@docusaurus/utils-validation": "2.0.0-beta.2",
+    "fs-extra": "^10.0.0",
+    "sitemap": "^7.0.0",
+    "tslib": "^2.2.0"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -32,5 +33,5 @@
   "engines": {
     "node": ">=12.13.0"
   },
-  "gitHead": "63c06baac39707a1a4c3cc4c0031cb2163f256c4"
+  "gitHead": "883f07fddffaf1657407c8e202e370cc436e25f7"
 }

package/src/__tests__/createSitemap.test.ts

@@ -29,7 +29,9 @@ describe('createSitemap', () => {
   test('empty site', () => {
     return expect(async () => {
       await createSitemap({} as DocusaurusConfig, [], {});
-    }).rejects.toThrow('url in docusaurus.config.js cannot be empty/undefined');
+    }).rejects.toThrow(
+      'URL in docusaurus.config.js cannot be empty/undefined.',
+    );
   });
 
   test('exclusion of 404 page', async () => {

package/src/__tests__/pluginOptionSchema.test.ts

@@ -30,8 +30,13 @@ describe('normalizeSitemapPluginOptions', () => {
       priority: 0.9,
       trailingSlash: false,
     };
-    const {value} = await PluginOptionSchema.validate(userOptions);
+    const {value, warning} = 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', () => {

package/src/createSitemap.ts

@@ -9,6 +9,7 @@ import {SitemapStream, streamToPromise} from 'sitemap';
 import {PluginOptions} from './types';
 import {DocusaurusConfig} from '@docusaurus/types';
 import {addTrailingSlash} from '@docusaurus/utils';
+import {applyTrailingSlash} from '@docusaurus/utils-common';
 
 export default async function createSitemap(
   siteConfig: DocusaurusConfig,
@@ -17,7 +18,7 @@ export default async function createSitemap(
 ): Promise<string> {
   const {url: hostname} = siteConfig;
   if (!hostname) {
-    throw new Error('url in docusaurus.config.js cannot be empty/undefined');
+    throw new Error('URL in docusaurus.config.js cannot be empty/undefined.');
   }
   const {changefreq, priority, trailingSlash} = options;
 
@@ -25,11 +26,21 @@ export default async function createSitemap(
     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);
+    }
+  }
+
   routesPaths
     .filter((route) => !route.endsWith('404.html'))
     .map((routePath) =>
       sitemapStream.write({
-        url: trailingSlash ? addTrailingSlash(routePath) : routePath,
+        url: applySitemapTrailingSlash(routePath),
         changefreq,
         priority,
       }),

package/src/index.ts

@@ -38,7 +38,7 @@ export default function pluginSitemap(
       try {
         await fs.outputFile(sitemapPath, generatedSitemap);
       } catch (err) {
-        throw new Error(`Sitemap error: ${err}`);
+        throw new Error(`Writing sitemap failed: ${err}`);
       }
     },
   };

package/src/pluginOptionSchema.ts

@@ -25,5 +25,11 @@ 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),
+  trailingSlash: Joi.bool().default(false).warning('deprecate.error', {
+    msg:
+      '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}',
 });