@docusaurus/plugin-sitemap 2.0.0-beta.14 → 2.0.0-beta.15

package/lib/createSitemap.d.ts

@@ -5,5 +5,5 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Options } from '@docusaurus/plugin-sitemap';
-import { DocusaurusConfig } from '@docusaurus/types';
+import type { DocusaurusConfig } from '@docusaurus/types';
 export default function createSitemap(siteConfig: DocusaurusConfig, routesPaths: string[], options: Options): Promise<string>;

package/lib/createSitemap.js

@@ -7,7 +7,6 @@
  */
 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;
@@ -15,31 +14,19 @@ async function createSitemap(siteConfig, routesPaths, options) {
         throw new Error('URL in docusaurus.config.js cannot be empty/undefined.');
     }
     const { changefreq, priority } = 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 (0, utils_1.addTrailingSlash)(routePath);
-        }
-        else {
-            return (0, utils_common_1.applyTrailingSlash)(routePath, {
-                trailingSlash: siteConfig.trailingSlash,
-                baseUrl: siteConfig.baseUrl,
-            });
-        }
-    }
+    const sitemapStream = new sitemap_1.SitemapStream({ hostname });
     routesPaths
         .filter((route) => !route.endsWith('404.html'))
-        .map((routePath) => sitemapStream.write({
-        url: applySitemapTrailingSlash(routePath),
+        .forEach((routePath) => sitemapStream.write({
+        url: (0, utils_common_1.applyTrailingSlash)(routePath, {
+            trailingSlash: siteConfig.trailingSlash,
+            baseUrl: siteConfig.baseUrl,
+        }),
         changefreq,
         priority,
     }));
     sitemapStream.end();
-    const generatedSitemap = await (0, sitemap_1.streamToPromise)(sitemapStream).then((sm) => sm.toString());
+    const generatedSitemap = (await (0, sitemap_1.streamToPromise)(sitemapStream)).toString();
     return generatedSitemap;
 }
 exports.default = createSitemap;

package/lib/index.d.ts

@@ -5,6 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Options } from '@docusaurus/plugin-sitemap';
-import { LoadContext, OptionValidationContext, ValidationResult, Plugin } from '@docusaurus/types';
+import type { LoadContext, OptionValidationContext, ValidationResult, Plugin } from '@docusaurus/types';
 export default function pluginSitemap(_context: LoadContext, options: Options): Plugin<void>;
 export declare function validateOptions({ validate, options, }: OptionValidationContext<Options>): ValidationResult<Options>;

package/lib/index.js

@@ -16,6 +16,9 @@ function pluginSitemap(_context, options) {
     return {
         name: 'docusaurus-plugin-sitemap',
         async postBuild({ siteConfig, routesPaths, outDir }) {
+            if (siteConfig.noIndex) {
+                return;
+            }
             // Generate sitemap.
             const generatedSitemap = await (0, createSitemap_1.default)(siteConfig, routesPaths, options);
             // Write sitemap file.

package/lib/pluginOptionSchema.js

@@ -12,7 +12,6 @@ const sitemap_1 = require("sitemap");
 exports.DEFAULT_OPTIONS = {
     changefreq: sitemap_1.EnumChangefreq.WEEKLY,
     priority: 0.5,
-    trailingSlash: false,
 };
 exports.PluginOptionSchema = utils_validation_1.Joi.object({
     // TODO temporary (@alpha-71)
@@ -23,9 +22,7 @@ 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).warning('deprecate.error', {
-        msg: 'Please use the new Docusaurus global trailingSlash config instead, and the sitemaps plugin will use it.',
+    trailingSlash: utils_validation_1.Joi.forbidden().messages({
+        '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}',
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-sitemap",
-  "version": "2.0.0-beta.14",
+  "version": "2.0.0-beta.15",
   "description": "Simple sitemap generation plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-sitemap.d.ts",
@@ -18,16 +18,16 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.14",
-    "@docusaurus/utils": "2.0.0-beta.14",
-    "@docusaurus/utils-common": "2.0.0-beta.14",
-    "@docusaurus/utils-validation": "2.0.0-beta.14",
+    "@docusaurus/core": "2.0.0-beta.15",
+    "@docusaurus/utils": "2.0.0-beta.15",
+    "@docusaurus/utils-common": "2.0.0-beta.15",
+    "@docusaurus/utils-validation": "2.0.0-beta.15",
     "fs-extra": "^10.0.0",
     "sitemap": "^7.0.0",
     "tslib": "^2.3.1"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.14"
+    "@docusaurus/types": "2.0.0-beta.15"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -36,5 +36,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "c4824a8937d8f1aa0806667749cbc74058e2b294"
+  "gitHead": "6cfad16436c07d8d11e5c2e1486dc59afd483e33"
 }

package/src/createSitemap.ts

@@ -7,8 +7,7 @@
 
 import {SitemapStream, streamToPromise} from 'sitemap';
 import type {Options} from '@docusaurus/plugin-sitemap';
-import {DocusaurusConfig} from '@docusaurus/types';
-import {addTrailingSlash} from '@docusaurus/utils';
+import type {DocusaurusConfig} from '@docusaurus/types';
 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({
-    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,
-      });
-    }
-  }
+  const sitemapStream = new SitemapStream({hostname});
 
   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) =>
-    sm.toString(),
-  );
+  const generatedSitemap = (await streamToPromise(sitemapStream)).toString();
 
   return generatedSitemap;
 }

package/src/index.ts

@@ -9,7 +9,7 @@ import fs from 'fs-extra';
 import path from 'path';
 import type {Options} from '@docusaurus/plugin-sitemap';
 import createSitemap from './createSitemap';
-import {
+import type {
   LoadContext,
   Props,
   OptionValidationContext,
@@ -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,

package/src/plugin-sitemap.d.ts

@@ -5,10 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {EnumChangefreq} from 'sitemap';
+import type {EnumChangefreq} from 'sitemap';
 
 export type Options = {
   changefreq?: EnumChangefreq;
   priority?: number;
-  trailingSlash?: boolean;
 };

package/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', {
-    msg: 'Please use the new Docusaurus global trailingSlash config instead, and the sitemaps plugin will use it.',
+  trailingSlash: Joi.forbidden().messages({
+    '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}',
 });