@docusaurus/plugin-sitemap 2.0.1 → 2.1.0

package/lib/createSitemap.js

@@ -9,6 +9,21 @@ 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");
+function isNoIndexMetaRoute({ head, route, }) {
+    const isNoIndexMetaTag = ({ name, content, }) => {
+        if (!name || !content) {
+            return false;
+        }
+        return (
+        // meta name is not case-sensitive
+        name.toLowerCase() === 'robots' &&
+            // Robots directives are not case-sensitive
+            content.toLowerCase().includes('noindex'));
+    };
+    // https://github.com/staylor/react-helmet-async/pull/167
+    const meta = head[route]?.meta.toComponent();
+    return meta?.some((tag) => isNoIndexMetaTag({ name: tag.props.name, content: tag.props.content }));
+}
 async function createSitemap(siteConfig, routesPaths, head, options) {
     const { url: hostname } = siteConfig;
     if (!hostname) {
@@ -16,14 +31,12 @@ async function createSitemap(siteConfig, routesPaths, head, options) {
     }
     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');
-    });
+    function isRouteExcluded(route) {
+        return (route.endsWith('404.html') ||
+            ignoreMatcher(route) ||
+            isNoIndexMetaRoute({ head, route }));
+    }
+    const includedRoutes = routesPaths.filter((route) => !isRouteExcluded(route));
     if (includedRoutes.length === 0) {
         return null;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-sitemap",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Simple sitemap generation plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -18,19 +18,16 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.1",
-    "@docusaurus/logger": "2.0.1",
-    "@docusaurus/types": "2.0.1",
-    "@docusaurus/utils": "2.0.1",
-    "@docusaurus/utils-common": "2.0.1",
-    "@docusaurus/utils-validation": "2.0.1",
+    "@docusaurus/core": "2.1.0",
+    "@docusaurus/logger": "2.1.0",
+    "@docusaurus/types": "2.1.0",
+    "@docusaurus/utils": "2.1.0",
+    "@docusaurus/utils-common": "2.1.0",
+    "@docusaurus/utils-validation": "2.1.0",
     "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"
@@ -38,5 +35,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "1ddee1c29cabf9bb52e4d78af6ebfaaabb1bc1f9"
+  "gitHead": "be9b0942641184213485eba7fd75ceb0b328d3f4"
 }

package/src/createSitemap.ts

@@ -13,6 +13,40 @@ import type {DocusaurusConfig} from '@docusaurus/types';
 import type {HelmetServerState} from 'react-helmet-async';
 import type {PluginOptions} from './options';
 
+function isNoIndexMetaRoute({
+  head,
+  route,
+}: {
+  head: {[location: string]: HelmetServerState};
+  route: string;
+}) {
+  const isNoIndexMetaTag = ({
+    name,
+    content,
+  }: {
+    name?: string;
+    content?: string;
+  }): boolean => {
+    if (!name || !content) {
+      return false;
+    }
+    return (
+      // meta name is not case-sensitive
+      name.toLowerCase() === 'robots' &&
+      // Robots directives are not case-sensitive
+      content.toLowerCase().includes('noindex')
+    );
+  };
+
+  // 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) =>
+    isNoIndexMetaTag({name: tag.props.name, content: tag.props.content}),
+  );
+}
+
 export default async function createSitemap(
   siteConfig: DocusaurusConfig,
   routesPaths: string[],
@@ -27,18 +61,15 @@ export default async function createSitemap(
 
   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',
+  function isRouteExcluded(route: string) {
+    return (
+      route.endsWith('404.html') ||
+      ignoreMatcher(route) ||
+      isNoIndexMetaRoute({head, route})
     );
-  });
+  }
+
+  const includedRoutes = routesPaths.filter((route) => !isRouteExcluded(route));
 
   if (includedRoutes.length === 0) {
     return null;