@docusaurus/plugin-content-docs 0.0.0-4425 → 0.0.0-4429

package/lib/globalData.d.ts

@@ -5,8 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Sidebars } from './sidebars/types';
-import type { DocMetadata, LoadedVersion } from './types';
+import type { CategoryGeneratedIndexMetadata, DocMetadata, LoadedVersion } from './types';
 import type { GlobalVersion, GlobalSidebar, GlobalDoc } from '@docusaurus/plugin-content-docs/client';
 export declare function toGlobalDataDoc(doc: DocMetadata): GlobalDoc;
+export declare function toGlobalDataGeneratedIndex(doc: CategoryGeneratedIndexMetadata): GlobalDoc;
 export declare function toGlobalSidebars(sidebars: Sidebars, version: LoadedVersion): Record<string, GlobalSidebar>;
 export declare function toGlobalDataVersion(version: LoadedVersion): GlobalVersion;

package/lib/globalData.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toGlobalDataVersion = exports.toGlobalSidebars = exports.toGlobalDataDoc = void 0;
+exports.toGlobalDataVersion = exports.toGlobalSidebars = exports.toGlobalDataGeneratedIndex = exports.toGlobalDataDoc = void 0;
 const lodash_1 = require("lodash");
 const utils_1 = require("@docusaurus/utils");
 const utils_2 = require("./sidebars/utils");
@@ -18,6 +18,14 @@ function toGlobalDataDoc(doc) {
     };
 }
 exports.toGlobalDataDoc = toGlobalDataDoc;
+function toGlobalDataGeneratedIndex(doc) {
+    return {
+        id: doc.slug,
+        path: doc.permalink,
+        sidebar: doc.sidebar,
+    };
+}
+exports.toGlobalDataGeneratedIndex = toGlobalDataGeneratedIndex;
 function toGlobalSidebars(sidebars, version) {
     const { getFirstLink } = (0, utils_2.createSidebarsUtils)(sidebars);
     return (0, lodash_1.mapValues)(sidebars, (sidebar, sidebarId) => {
@@ -43,7 +51,9 @@ function toGlobalDataVersion(version) {
         isLast: version.isLast,
         path: version.versionPath,
         mainDocId: version.mainDocId,
-        docs: version.docs.map(toGlobalDataDoc),
+        docs: version.docs
+            .map(toGlobalDataDoc)
+            .concat(version.categoryGeneratedIndices.map(toGlobalDataGeneratedIndex)),
         sidebars: toGlobalSidebars(version.sidebars, version),
     };
 }

package/lib/routes.d.ts

@@ -6,10 +6,11 @@
  */
 import type { PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
 import type { DocMetadata, LoadedVersion } from './types';
-export declare function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, }: {
+export declare function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, aliasedSource, }: {
     version: LoadedVersion;
     actions: PluginContentLoadedActions;
     docCategoryGeneratedIndexComponent: string;
+    aliasedSource: (str: string) => string;
 }): Promise<RouteConfig[]>;
 export declare function createDocRoutes({ docs, actions, docItemComponent, }: {
     docs: DocMetadata[];

package/lib/routes.js

@@ -11,7 +11,7 @@ const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
 const props_1 = require("./props");
 const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
-async function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, }) {
+async function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, aliasedSource, }) {
     const slugs = (0, utils_1.createSlugger)();
     async function createCategoryGeneratedIndexRoute(categoryGeneratedIndex) {
         const { sidebar, title, description, slug, permalink, previous, next, image, keywords, } = categoryGeneratedIndex;
@@ -34,7 +34,7 @@ async function createCategoryGeneratedIndexRoutes({ version, actions, docCategor
             component: docCategoryGeneratedIndexComponent,
             exact: true,
             modules: {
-                categoryGeneratedIndex: propData,
+                categoryGeneratedIndex: aliasedSource(propData),
             },
             // Same as doc, this sidebar route attribute permits to associate this subpage to the given sidebar
             ...(sidebar && { sidebar }),
@@ -77,6 +77,7 @@ async function createVersionRoutes({ loadedVersion, actions, docItemComponent, d
                     version,
                     actions,
                     docCategoryGeneratedIndexComponent,
+                    aliasedSource,
                 }),
             ]);
             const routes = [...docRoutes, ...sidebarsRoutes];

package/lib/sidebars/generator.js

@@ -41,15 +41,8 @@ async function readCategoryMetadataFile(categoryDirPath) {
             throw e;
         }
     }
-    // eslint-disable-next-line no-restricted-syntax
-    for (const ext of ['.json', '.yml', '.yaml']) {
-        // Simpler to use only posix paths for mocking file metadata in tests
-        const filePath = (0, utils_1.posixPath)(path_1.default.join(categoryDirPath, `${exports.CategoryMetadataFilenameBase}${ext}`));
-        if (await fs_extra_1.default.pathExists(filePath)) {
-            return tryReadFile(filePath);
-        }
-    }
-    return null;
+    const filePath = await (0, utils_1.findAsyncSequential)(['.json', '.yml', '.yaml'].map((ext) => (0, utils_1.posixPath)(path_1.default.join(categoryDirPath, `${exports.CategoryMetadataFilenameBase}${ext}`))), fs_extra_1.default.pathExists);
+    return filePath ? tryReadFile(filePath) : null;
 }
 // Comment for this feature: https://github.com/facebook/docusaurus/issues/3464#issuecomment-818670449
 const DefaultSidebarItemsGenerator = async ({ numberPrefixParser, docs: allDocs, options, item: { dirName: autogenDir }, version, }) => {
@@ -101,13 +94,12 @@ const DefaultSidebarItemsGenerator = async ({ numberPrefixParser, docs: allDocs,
         docs.forEach((doc) => {
             const breadcrumb = getRelativeBreadcrumb(doc);
             let currentDir = treeRoot; // We walk down the file's path to generate the fs structure
-            // eslint-disable-next-line no-restricted-syntax
-            for (const dir of breadcrumb) {
+            breadcrumb.forEach((dir) => {
                 if (typeof currentDir[dir] === 'undefined') {
                     currentDir[dir] = {}; // Create new folder.
                 }
                 currentDir = currentDir[dir]; // Go into the subdirectory.
-            }
+            });
             currentDir[`${docIdPrefix}${doc.id}`] = null; // We've walked through the file path. Register the file in this directory.
         });
         return treeRoot;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4425",
+  "version": "0.0.0-4429",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -22,11 +22,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4425",
-    "@docusaurus/logger": "0.0.0-4425",
-    "@docusaurus/mdx-loader": "0.0.0-4425",
-    "@docusaurus/utils": "0.0.0-4425",
-    "@docusaurus/utils-validation": "0.0.0-4425",
+    "@docusaurus/core": "0.0.0-4429",
+    "@docusaurus/logger": "0.0.0-4429",
+    "@docusaurus/mdx-loader": "0.0.0-4429",
+    "@docusaurus/utils": "0.0.0-4429",
+    "@docusaurus/utils-validation": "0.0.0-4429",
     "combine-promises": "^1.1.0",
     "escape-string-regexp": "^4.0.0",
     "fs-extra": "^10.0.0",
@@ -42,8 +42,8 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4425",
-    "@docusaurus/types": "0.0.0-4425",
+    "@docusaurus/module-type-aliases": "0.0.0-4429",
+    "@docusaurus/types": "0.0.0-4429",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
@@ -57,5 +57,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "acef255de5b1a7629e84e68b38951fad8e4773ec"
+  "gitHead": "138cc67980738455ec85abbc6470cdd02c14bcd5"
 }

package/src/globalData.ts

@@ -9,7 +9,11 @@ import {mapValues} from 'lodash';
 import {normalizeUrl} from '@docusaurus/utils';
 import type {Sidebars} from './sidebars/types';
 import {createSidebarsUtils} from './sidebars/utils';
-import type {DocMetadata, LoadedVersion} from './types';
+import type {
+  CategoryGeneratedIndexMetadata,
+  DocMetadata,
+  LoadedVersion,
+} from './types';
 import type {
   GlobalVersion,
   GlobalSidebar,
@@ -24,6 +28,16 @@ export function toGlobalDataDoc(doc: DocMetadata): GlobalDoc {
   };
 }
 
+export function toGlobalDataGeneratedIndex(
+  doc: CategoryGeneratedIndexMetadata,
+): GlobalDoc {
+  return {
+    id: doc.slug,
+    path: doc.permalink,
+    sidebar: doc.sidebar,
+  };
+}
+
 export function toGlobalSidebars(
   sidebars: Sidebars,
   version: LoadedVersion,
@@ -56,7 +70,9 @@ export function toGlobalDataVersion(version: LoadedVersion): GlobalVersion {
     isLast: version.isLast,
     path: version.versionPath,
     mainDocId: version.mainDocId,
-    docs: version.docs.map(toGlobalDataDoc),
+    docs: version.docs
+      .map(toGlobalDataDoc)
+      .concat(version.categoryGeneratedIndices.map(toGlobalDataGeneratedIndex)),
     sidebars: toGlobalSidebars(version.sidebars, version),
   };
 }

package/src/routes.ts

@@ -20,10 +20,12 @@ export async function createCategoryGeneratedIndexRoutes({
   version,
   actions,
   docCategoryGeneratedIndexComponent,
+  aliasedSource,
 }: {
   version: LoadedVersion;
   actions: PluginContentLoadedActions;
   docCategoryGeneratedIndexComponent: string;
+  aliasedSource: (str: string) => string;
 }): Promise<RouteConfig[]> {
   const slugs = createSlugger();
 
@@ -69,7 +71,7 @@ export async function createCategoryGeneratedIndexRoutes({
       component: docCategoryGeneratedIndexComponent,
       exact: true,
       modules: {
-        categoryGeneratedIndex: propData,
+        categoryGeneratedIndex: aliasedSource(propData),
       },
       // Same as doc, this sidebar route attribute permits to associate this subpage to the given sidebar
       ...(sidebar && {sidebar}),
@@ -149,6 +151,7 @@ export async function createVersionRoutes({
           version,
           actions,
           docCategoryGeneratedIndexComponent,
+          aliasedSource,
         }),
       ]);
 

package/src/sidebars/generator.ts

@@ -15,7 +15,11 @@ import type {
   SidebarItemCategoryLinkConfig,
 } from './types';
 import {sortBy, last} from 'lodash';
-import {addTrailingSlash, posixPath} from '@docusaurus/utils';
+import {
+  addTrailingSlash,
+  posixPath,
+  findAsyncSequential,
+} from '@docusaurus/utils';
 import logger from '@docusaurus/logger';
 import path from 'path';
 import fs from 'fs-extra';
@@ -76,17 +80,15 @@ async function readCategoryMetadataFile(
       throw e;
     }
   }
-  // eslint-disable-next-line no-restricted-syntax
-  for (const ext of ['.json', '.yml', '.yaml']) {
-    // Simpler to use only posix paths for mocking file metadata in tests
-    const filePath = posixPath(
-      path.join(categoryDirPath, `${CategoryMetadataFilenameBase}${ext}`),
-    );
-    if (await fs.pathExists(filePath)) {
-      return tryReadFile(filePath);
-    }
-  }
-  return null;
+  const filePath = await findAsyncSequential(
+    ['.json', '.yml', '.yaml'].map((ext) =>
+      posixPath(
+        path.join(categoryDirPath, `${CategoryMetadataFilenameBase}${ext}`),
+      ),
+    ),
+    fs.pathExists,
+  );
+  return filePath ? tryReadFile(filePath) : null;
 }
 
 // Comment for this feature: https://github.com/facebook/docusaurus/issues/3464#issuecomment-818670449
@@ -154,13 +156,12 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
     docs.forEach((doc) => {
       const breadcrumb = getRelativeBreadcrumb(doc);
       let currentDir = treeRoot; // We walk down the file's path to generate the fs structure
-      // eslint-disable-next-line no-restricted-syntax
-      for (const dir of breadcrumb) {
+      breadcrumb.forEach((dir) => {
         if (typeof currentDir[dir] === 'undefined') {
           currentDir[dir] = {}; // Create new folder.
         }
         currentDir = currentDir[dir]!; // Go into the subdirectory.
-      }
+      });
       currentDir[`${docIdPrefix}${doc.id}`] = null; // We've walked through the file path. Register the file in this directory.
     });
     return treeRoot;