@docusaurus/plugin-sitemap 0.0.0-4860 → 0.0.0-4865

package/lib/createSitemap.d.ts

@@ -6,4 +6,7 @@
  */
 import type { PluginOptions } from '@docusaurus/plugin-sitemap';
 import type { DocusaurusConfig } from '@docusaurus/types';
-export default function createSitemap(siteConfig: DocusaurusConfig, routesPaths: string[], options: PluginOptions): Promise<string>;
+import type { HelmetServerState } from 'react-helmet-async';
+export default function createSitemap(siteConfig: DocusaurusConfig, routesPaths: string[], head: {
+    [location: string]: HelmetServerState;
+}, options: PluginOptions): Promise<string>;

package/lib/createSitemap.js

@@ -9,7 +9,7 @@ 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.');
@@ -17,9 +17,15 @@ async function createSitemap(siteConfig, routesPaths, options) {
     const { changefreq, priority, ignorePatterns } = options;
     const ignoreMatcher = (0, utils_1.createMatcher)(ignorePatterns);
     const sitemapStream = new sitemap_1.SitemapStream({ hostname });
-    routesPaths
-        .filter((route) => !route.endsWith('404.html') && !ignoreMatcher(route))
-        .forEach((routePath) => sitemapStream.write({
+    function routeShouldBeIncluded(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(routeShouldBeIncluded).forEach((routePath) => sitemapStream.write({
         url: (0, utils_common_1.applyTrailingSlash)(routePath, {
             trailingSlash: siteConfig.trailingSlash,
             baseUrl: siteConfig.baseUrl,

package/lib/index.js

@@ -14,12 +14,12 @@ const createSitemap_1 = tslib_1.__importDefault(require("./createSitemap"));
 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 (0, createSitemap_1.default)(siteConfig, routesPaths, options);
+            const generatedSitemap = await (0, createSitemap_1.default)(siteConfig, routesPaths, head, options);
             // Write sitemap file.
             const sitemapPath = path_1.default.join(outDir, 'sitemap.xml');
             try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-sitemap",
-  "version": "0.0.0-4860",
+  "version": "0.0.0-4865",
   "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": "0.0.0-4860",
-    "@docusaurus/utils": "0.0.0-4860",
-    "@docusaurus/utils-common": "0.0.0-4860",
-    "@docusaurus/utils-validation": "0.0.0-4860",
+    "@docusaurus/core": "0.0.0-4865",
+    "@docusaurus/utils": "0.0.0-4865",
+    "@docusaurus/utils-common": "0.0.0-4865",
+    "@docusaurus/utils-validation": "0.0.0-4865",
     "fs-extra": "^10.0.1",
     "sitemap": "^7.1.1",
     "tslib": "^2.3.1"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4860"
+    "@docusaurus/types": "0.0.0-4865"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -36,5 +36,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "dd89ce688ef649f835f2bf6be614c6997ba47165"
+  "gitHead": "3bfec620587180f9e7dad2bf2a2713172be65fe7"
 }

package/src/createSitemap.ts

@@ -10,10 +10,13 @@ import type {PluginOptions} from '@docusaurus/plugin-sitemap';
 import type {DocusaurusConfig} from '@docusaurus/types';
 import {applyTrailingSlash} from '@docusaurus/utils-common';
 import {createMatcher} from '@docusaurus/utils';
+import type {HelmetServerState} from 'react-helmet-async';
+import type {ReactElement} from 'react';
 
 export default async function createSitemap(
   siteConfig: DocusaurusConfig,
   routesPaths: string[],
+  head: {[location: string]: HelmetServerState},
   options: PluginOptions,
 ): Promise<string> {
   const {url: hostname} = siteConfig;
@@ -26,18 +29,29 @@ export default async function createSitemap(
 
   const sitemapStream = new SitemapStream({hostname});
 
-  routesPaths
-    .filter((route) => !route.endsWith('404.html') && !ignoreMatcher(route))
-    .forEach((routePath) =>
-      sitemapStream.write({
-        url: applyTrailingSlash(routePath, {
-          trailingSlash: siteConfig.trailingSlash,
-          baseUrl: siteConfig.baseUrl,
-        }),
-        changefreq,
-        priority,
-      }),
+  function routeShouldBeIncluded(route: string) {
+    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[]
+      | undefined;
+    return !meta?.some(
+      (tag) => tag.props.name === 'robots' && tag.props.content === 'noindex',
     );
+  }
+
+  routesPaths.filter(routeShouldBeIncluded).forEach((routePath) =>
+    sitemapStream.write({
+      url: applyTrailingSlash(routePath, {
+        trailingSlash: siteConfig.trailingSlash,
+        baseUrl: siteConfig.baseUrl,
+      }),
+      changefreq,
+      priority,
+    }),
+  );
 
   sitemapStream.end();
 

package/src/index.ts

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