@docusaurus/plugin-content-docs 0.0.0-4428 → 0.0.0-4433

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-4428",
+  "version": "0.0.0-4433",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -22,11 +22,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4428",
-    "@docusaurus/logger": "0.0.0-4428",
-    "@docusaurus/mdx-loader": "0.0.0-4428",
-    "@docusaurus/utils": "0.0.0-4428",
-    "@docusaurus/utils-validation": "0.0.0-4428",
+    "@docusaurus/core": "0.0.0-4433",
+    "@docusaurus/logger": "0.0.0-4433",
+    "@docusaurus/mdx-loader": "0.0.0-4433",
+    "@docusaurus/utils": "0.0.0-4433",
+    "@docusaurus/utils-validation": "0.0.0-4433",
     "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-4428",
-    "@docusaurus/types": "0.0.0-4428",
+    "@docusaurus/module-type-aliases": "0.0.0-4433",
+    "@docusaurus/types": "0.0.0-4433",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
@@ -57,5 +57,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "db57493754afaf674482b15cc704ef8d5424e7ec"
+  "gitHead": "ffbadadb02dbb89e253b79dfb6c06609cae500b5"
 }

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;