@docusaurus/plugin-sitemap 2.0.0-beta.ff31de0ff → 2.0.0-rc.1

package/lib/createSitemap.d.ts

@@ -4,6 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { PluginOptions } from './types';
-import { DocusaurusConfig } from '@docusaurus/types';
-export default function createSitemap(siteConfig: DocusaurusConfig, routesPaths: string[], options: PluginOptions): Promise<string>;
+import type { DocusaurusConfig } from '@docusaurus/types';
+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 | null>;

package/lib/createSitemap.js

@@ -7,25 +7,37 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const sitemap_1 = require("sitemap");
+const utils_common_1 = require("@docusaurus/utils-common");
 const utils_1 = require("@docusaurus/utils");
-async function createSitemap(siteConfig, routesPaths, options) {
+async function createSitemap(siteConfig, routesPaths, head, 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,
+    const { changefreq, priority, ignorePatterns } = options;
+    const ignoreMatcher = (0, utils_1.createMatcher)(ignorePatterns);
+    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');
     });
-    routesPaths
-        .filter((route) => !route.endsWith('404.html'))
-        .map((routePath) => sitemapStream.write({
-        url: trailingSlash ? utils_1.addTrailingSlash(routePath) : routePath,
+    if (includedRoutes.length === 0) {
+        return null;
+    }
+    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,
+        }),
         changefreq,
         priority,
     }));
     sitemapStream.end();
-    const generatedSitemap = await 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

@@ -4,7 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { PluginOptions } from './types';
-import { LoadContext, OptionValidationContext, ValidationResult, Plugin } from '@docusaurus/types';
-export default function pluginSitemap(_context: LoadContext, options: PluginOptions): Plugin<void>;
-export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions>;
+import type { PluginOptions, Options } from './options';
+import type { LoadContext, Plugin } from '@docusaurus/types';
+export default function pluginSitemap(context: LoadContext, options: PluginOptions): Plugin<void>;
+export { validateOptions } from './options';
+export type { PluginOptions, Options };

package/lib/index.js

@@ -10,28 +10,32 @@ exports.validateOptions = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const createSitemap_1 = tslib_1.__importDefault(require("./createSitemap"));
-const pluginOptionSchema_1 = require("./pluginOptionSchema");
-function pluginSitemap(_context, options) {
+function pluginSitemap(context, options) {
     return {
         name: 'docusaurus-plugin-sitemap',
-        async postBuild({ siteConfig, routesPaths, outDir }) {
+        async postBuild({ siteConfig, routesPaths, outDir, head }) {
+            if (siteConfig.noIndex) {
+                return;
+            }
             // Generate sitemap.
-            const generatedSitemap = await createSitemap_1.default(siteConfig, routesPaths, options);
+            const generatedSitemap = await (0, createSitemap_1.default)(siteConfig, routesPaths, head, options);
+            if (!generatedSitemap) {
+                return;
+            }
             // Write sitemap file.
-            const sitemapPath = path_1.default.join(outDir, 'sitemap.xml');
+            const sitemapPath = path_1.default.join(outDir, options.filename);
             try {
                 await fs_extra_1.default.outputFile(sitemapPath, generatedSitemap);
             }
             catch (err) {
-                throw new Error(`Sitemap error: ${err}`);
+                logger_1.default.error('Writing sitemap failed.');
+                throw err;
             }
         },
     };
 }
 exports.default = pluginSitemap;
-function validateOptions({ validate, options, }) {
-    const validatedOptions = validate(pluginOptionSchema_1.PluginOptionSchema, options);
-    return validatedOptions;
-}
-exports.validateOptions = validateOptions;
+var options_1 = require("./options");
+Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/options.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { EnumChangefreq } from 'sitemap';
+import type { OptionValidationContext } from '@docusaurus/types';
+export declare type PluginOptions = {
+    /** @see https://www.sitemaps.org/protocol.html#xmlTagDefinitions */
+    changefreq: EnumChangefreq;
+    /** @see https://www.sitemaps.org/protocol.html#xmlTagDefinitions */
+    priority: number;
+    /**
+     * A list of glob patterns; matching route paths will be filtered from the
+     * sitemap. Note that you may need to include the base URL in here.
+     */
+    ignorePatterns: string[];
+    /**
+     * The path to the created sitemap file, relative to the output directory.
+     * Useful if you have two plugin instances outputting two files.
+     */
+    filename: string;
+};
+export declare type Options = Partial<PluginOptions>;
+export declare const DEFAULT_OPTIONS: PluginOptions;
+export declare function validateOptions({ validate, options, }: OptionValidationContext<Options, PluginOptions>): PluginOptions;

package/lib/{pluginOptionSchema.js → options.js}

@@ -6,16 +6,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PluginOptionSchema = exports.DEFAULT_OPTIONS = void 0;
+exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const sitemap_1 = require("sitemap");
 exports.DEFAULT_OPTIONS = {
     changefreq: sitemap_1.EnumChangefreq.WEEKLY,
     priority: 0.5,
-    trailingSlash: false,
+    ignorePatterns: [],
+    filename: 'sitemap.xml',
 };
-exports.PluginOptionSchema = utils_validation_1.Joi.object({
-    // TODO temporary (@alpha-71)
+const PluginOptionSchema = utils_validation_1.Joi.object({
+    // @ts-expect-error: forbidden
     cacheTime: utils_validation_1.Joi.forbidden().messages({
         'any.unknown': 'Option `cacheTime` in sitemap config is deprecated. Please remove it.',
     }),
@@ -23,5 +24,16 @@ 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),
+    ignorePatterns: utils_validation_1.Joi.array()
+        .items(utils_validation_1.Joi.string())
+        .default(exports.DEFAULT_OPTIONS.ignorePatterns),
+    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.',
+    }),
+    filename: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.filename),
 });
+function validateOptions({ validate, options, }) {
+    const validatedOptions = validate(PluginOptionSchema, options);
+    return validatedOptions;
+}
+exports.validateOptions = validateOptions;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@docusaurus/plugin-sitemap",
-  "version": "2.0.0-beta.ff31de0ff",
+  "version": "2.0.0-rc.1",
   "description": "Simple sitemap generation plugin for Docusaurus.",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
     "build": "tsc",
     "watch": "tsc --watch"
@@ -17,20 +18,25 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.ff31de0ff",
-    "@docusaurus/types": "2.0.0-beta.ff31de0ff",
-    "@docusaurus/utils": "2.0.0-beta.ff31de0ff",
-    "@docusaurus/utils-validation": "2.0.0-beta.ff31de0ff",
-    "fs-extra": "^10.0.0",
-    "sitemap": "^7.0.0",
-    "tslib": "^2.2.0"
+    "@docusaurus/core": "2.0.0-rc.1",
+    "@docusaurus/logger": "2.0.0-rc.1",
+    "@docusaurus/types": "2.0.0-rc.1",
+    "@docusaurus/utils": "2.0.0-rc.1",
+    "@docusaurus/utils-common": "2.0.0-rc.1",
+    "@docusaurus/utils-validation": "2.0.0-rc.1",
+    "fs-extra": "^10.1.0",
+    "sitemap": "^7.1.1",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@docusaurus/types": "2.0.0-beta.21"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=16.14"
   },
-  "gitHead": "6cacb313da4a21283fe08176097df89df836ee23"
+  "gitHead": "c8ddd02a8e68dfaf515c20465a049a83153bd205"
 }

package/src/createSitemap.ts

@@ -5,41 +5,61 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import type {ReactElement} from 'react';
 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';
+import {createMatcher} from '@docusaurus/utils';
+import type {DocusaurusConfig} from '@docusaurus/types';
+import type {HelmetServerState} from 'react-helmet-async';
+import type {PluginOptions} from './options';
 
 export default async function createSitemap(
   siteConfig: DocusaurusConfig,
   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');
+    throw new Error('URL in docusaurus.config.js cannot be empty/undefined.');
   }
-  const {changefreq, priority, trailingSlash} = options;
+  const {changefreq, priority, ignorePatterns} = options;
 
-  const sitemapStream = new SitemapStream({
-    hostname,
+  const ignoreMatcher = createMatcher(ignorePatterns);
+
+  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() as unknown as
+      | ReactElement<{name?: string; content?: string}>[]
+      | undefined;
+    return !meta?.some(
+      (tag) => tag.props.name === 'robots' && tag.props.content === 'noindex',
+    );
   });
 
-  routesPaths
-    .filter((route) => !route.endsWith('404.html'))
-    .map((routePath) =>
-      sitemapStream.write({
-        url: trailingSlash ? addTrailingSlash(routePath) : routePath,
-        changefreq,
-        priority,
+  if (includedRoutes.length === 0) {
+    return null;
+  }
+
+  const sitemapStream = new SitemapStream({hostname});
+
+  includedRoutes.forEach((routePath) =>
+    sitemapStream.write({
+      url: applyTrailingSlash(routePath, {
+        trailingSlash: siteConfig.trailingSlash,
+        baseUrl: siteConfig.baseUrl,
       }),
-    );
+      changefreq,
+      priority,
+    }),
+  );
 
   sitemapStream.end();
 
-  const generatedSitemap = await streamToPromise(sitemapStream).then((sm) =>
-    sm.toString(),
-  );
+  const generatedSitemap = (await streamToPromise(sitemapStream)).toString();
 
   return generatedSitemap;
 }

package/src/index.ts

@@ -7,47 +7,44 @@
 
 import fs from 'fs-extra';
 import path from 'path';
-import {PluginOptions} from './types';
+import logger from '@docusaurus/logger';
 import createSitemap from './createSitemap';
-import {
-  LoadContext,
-  Props,
-  OptionValidationContext,
-  ValidationResult,
-  Plugin,
-} from '@docusaurus/types';
-import {PluginOptionSchema} from './pluginOptionSchema';
+import type {PluginOptions, Options} from './options';
+import type {LoadContext, Plugin} from '@docusaurus/types';
 
 export default function pluginSitemap(
-  _context: LoadContext,
+  context: LoadContext,
   options: PluginOptions,
 ): Plugin<void> {
   return {
     name: 'docusaurus-plugin-sitemap',
 
-    async postBuild({siteConfig, routesPaths, outDir}: Props) {
+    async postBuild({siteConfig, routesPaths, outDir, head}) {
+      if (siteConfig.noIndex) {
+        return;
+      }
       // Generate sitemap.
       const generatedSitemap = await createSitemap(
         siteConfig,
         routesPaths,
+        head,
         options,
       );
+      if (!generatedSitemap) {
+        return;
+      }
 
       // Write sitemap file.
-      const sitemapPath = path.join(outDir, 'sitemap.xml');
+      const sitemapPath = path.join(outDir, options.filename);
       try {
         await fs.outputFile(sitemapPath, generatedSitemap);
       } catch (err) {
-        throw new Error(`Sitemap error: ${err}`);
+        logger.error('Writing sitemap failed.');
+        throw err;
       }
     },
   };
 }
 
-export function validateOptions({
-  validate,
-  options,
-}: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions> {
-  const validatedOptions = validate(PluginOptionSchema, options);
-  return validatedOptions;
-}
+export {validateOptions} from './options';
+export type {PluginOptions, Options};

package/src/options.ts

@@ -0,0 +1,64 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {Joi} from '@docusaurus/utils-validation';
+import {EnumChangefreq} from 'sitemap';
+import type {OptionValidationContext} from '@docusaurus/types';
+
+export type PluginOptions = {
+  /** @see https://www.sitemaps.org/protocol.html#xmlTagDefinitions */
+  changefreq: EnumChangefreq;
+  /** @see https://www.sitemaps.org/protocol.html#xmlTagDefinitions */
+  priority: number;
+  /**
+   * A list of glob patterns; matching route paths will be filtered from the
+   * sitemap. Note that you may need to include the base URL in here.
+   */
+  ignorePatterns: string[];
+  /**
+   * The path to the created sitemap file, relative to the output directory.
+   * Useful if you have two plugin instances outputting two files.
+   */
+  filename: string;
+};
+
+export type Options = Partial<PluginOptions>;
+
+export const DEFAULT_OPTIONS: PluginOptions = {
+  changefreq: EnumChangefreq.WEEKLY,
+  priority: 0.5,
+  ignorePatterns: [],
+  filename: 'sitemap.xml',
+};
+
+const PluginOptionSchema = Joi.object<PluginOptions>({
+  // @ts-expect-error: forbidden
+  cacheTime: Joi.forbidden().messages({
+    'any.unknown':
+      'Option `cacheTime` in sitemap config is deprecated. Please remove it.',
+  }),
+  changefreq: Joi.string()
+    .valid(...Object.values(EnumChangefreq))
+    .default(DEFAULT_OPTIONS.changefreq),
+  priority: Joi.number().min(0).max(1).default(DEFAULT_OPTIONS.priority),
+  ignorePatterns: Joi.array()
+    .items(Joi.string())
+    .default(DEFAULT_OPTIONS.ignorePatterns),
+  trailingSlash: Joi.forbidden().messages({
+    'any.unknown':
+      'Please use the new Docusaurus global trailingSlash config instead, and the sitemaps plugin will use it.',
+  }),
+  filename: Joi.string().default(DEFAULT_OPTIONS.filename),
+});
+
+export function validateOptions({
+  validate,
+  options,
+}: OptionValidationContext<Options, PluginOptions>): PluginOptions {
+  const validatedOptions = validate(PluginOptionSchema, options);
+  return validatedOptions;
+}