@docusaurus/plugin-content-docs 4.0.0-canary-6884 → 4.0.0-canary-6888

package/lib/cli.js

@@ -7,10 +7,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
+const fs_1 = require("@docusaurus/fs");
 const files_1 = require("./versions/files");
 const validation_1 = require("./versions/validation");
 const sidebars_1 = require("./sidebars");
@@ -25,7 +26,7 @@ async function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, vers
     // or sidebars are disabled/false)
     const shouldCreateVersionedSidebarFile = Object.keys(sidebars).length > 0;
     if (shouldCreateVersionedSidebarFile) {
-        await fs_extra_1.default.outputFile((0, files_1.getVersionSidebarsPath)(siteDir, pluginId, version), `${JSON.stringify(sidebars, null, 2)}\n`, 'utf8');
+        await (0, fs_1.outputFile)((0, files_1.getVersionSidebarsPath)(siteDir, pluginId, version), `${JSON.stringify(sidebars, null, 2)}\n`, 'utf8');
     }
 }
 // Tests depend on non-default export for mocking.
@@ -58,8 +59,8 @@ async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, si
                 pluginId,
                 versionName: constants_1.CURRENT_VERSION_NAME,
             });
-        if (!(await fs_extra_1.default.pathExists(docsDir)) ||
-            (await fs_extra_1.default.readdir(docsDir)).length === 0) {
+        if (!(await (0, fs_1.pathExists)(docsDir)) ||
+            (await promises_1.default.readdir(docsDir)).length === 0) {
             if (locale === i18n.defaultLocale) {
                 throw new Error(logger_1.default.interpolate `${pluginIdLogPrefix}: no docs found in path=${docsDir}.`);
             }
@@ -75,7 +76,11 @@ async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, si
                 pluginId,
                 versionName: version,
             });
-        await fs_extra_1.default.copy(docsDir, newVersionDir);
+        // verbatimSymlinks: keep relative symlinks relative
+        await promises_1.default.cp(docsDir, newVersionDir, {
+            recursive: true,
+            verbatimSymlinks: true,
+        });
         // Copy version JSON translation file for this locale
         // i18n/<l>/docusaurus-plugin-content-docs/current.json => version-v1.json
         // See https://docusaurus.io/docs/next/api/plugins/@docusaurus/plugin-content-docs#translation-files-location
@@ -86,8 +91,8 @@ async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, si
             });
             const sourceFile = node_path_1.default.join(dir, 'current.json');
             const dest = node_path_1.default.join(dir, `version-${version}.json`);
-            if (await fs_extra_1.default.pathExists(sourceFile)) {
-                await fs_extra_1.default.copy(sourceFile, dest);
+            if (await (0, fs_1.pathExists)(sourceFile)) {
+                await promises_1.default.cp(sourceFile, dest, { verbatimSymlinks: true });
             }
             else {
                 logger_1.default.warn `${pluginIdLogPrefix}: i18n translation file does not exist in path=${sourceFile}. Skipping.`;
@@ -102,7 +107,7 @@ async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, si
     });
     // Update versions.json file.
     versions.unshift(version);
-    await fs_extra_1.default.outputFile((0, files_1.getVersionsFilePath)(siteDir, pluginId), `${JSON.stringify(versions, null, 2)}\n`);
+    await (0, fs_1.outputFile)((0, files_1.getVersionsFilePath)(siteDir, pluginId), `${JSON.stringify(versions, null, 2)}\n`);
     logger_1.default.success `name=${pluginIdLogPrefix}: version name=${version} created!`;
 }
 // TODO try to remove this workaround

package/lib/docs.js

@@ -16,10 +16,11 @@ exports.toCategoryIndexMatcherParam = toCategoryIndexMatcherParam;
 exports.createDocsByIdIndex = createDocsByIdIndex;
 const tslib_1 = require("tslib");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
 const glob_1 = require("@docusaurus/glob");
+const fs_1 = require("@docusaurus/fs");
 const frontMatter_1 = require("./frontMatter");
 const slug_1 = tslib_1.__importDefault(require("./slug"));
 const numberPrefix_1 = require("./numberPrefix");
@@ -27,7 +28,7 @@ const utils_2 = require("./sidebars/utils");
 async function readDocFile(versionMetadata, source) {
     const contentPath = await (0, utils_1.getFolderContainingFile)((0, utils_1.getContentPathList)(versionMetadata), source);
     const filePath = node_path_1.default.join(contentPath, source);
-    const content = await fs_extra_1.default.readFile(filePath, 'utf-8');
+    const content = await (0, fs_1.queueFileOperation)(() => promises_1.default.readFile(filePath, 'utf-8'));
     return { source, content, contentPath, filePath };
 }
 async function readVersionDocs(versionMetadata, options) {

package/lib/index.js

@@ -10,7 +10,7 @@ exports.validateOptions = void 0;
 exports.default = pluginContentDocs;
 const tslib_1 = require("tslib");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
 const utils_1 = require("@docusaurus/utils");
 const glob_1 = require("@docusaurus/glob");
 const utils_validation_1 = require("@docusaurus/utils-validation");
@@ -41,8 +41,8 @@ async function createMdxLoaderDependencyFile({ dataDir, options, versionsMetadat
         options,
         versionsMetadata,
     };
-    await fs_extra_1.default.ensureDir(dataDir);
-    await fs_extra_1.default.writeFile(filePath, JSON.stringify(fileContent));
+    await promises_1.default.mkdir(dataDir, { recursive: true });
+    await promises_1.default.writeFile(filePath, JSON.stringify(fileContent));
     return filePath;
 }
 async function pluginContentDocs(context, options) {

package/lib/sidebars/index.js

@@ -11,7 +11,7 @@ exports.resolveSidebarPathOption = resolveSidebarPathOption;
 exports.loadSidebarsFile = loadSidebarsFile;
 exports.loadSidebars = loadSidebars;
 const tslib_1 = require("tslib");
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
@@ -19,6 +19,7 @@ const utils_1 = require("@docusaurus/utils");
 const glob_1 = require("@docusaurus/glob");
 const Yaml = tslib_1.__importStar(require("js-yaml"));
 const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
+const fs_1 = require("@docusaurus/fs");
 const validation_1 = require("./validation");
 const normalization_1 = require("./normalization");
 const processor_1 = require("./processor");
@@ -48,7 +49,7 @@ async function readCategoriesMetadata(contentPath) {
         if (files.length > 1) {
             logger_1.default.warn `There are more than one category metadata files for path=${folder}: ${files.join(', ')}. The behavior is undetermined.`;
         }
-        const content = await fs_extra_1.default.readFile(node_path_1.default.join(contentPath, filePath), 'utf-8');
+        const content = await promises_1.default.readFile(node_path_1.default.join(contentPath, filePath), 'utf-8');
         try {
             return (0, validation_1.validateCategoryMetadataFile)(Yaml.load(content));
         }
@@ -70,7 +71,7 @@ async function loadSidebarsFileUnsafe(sidebarFilePath) {
     // Non-existent sidebars file: no sidebars
     // Note: this edge case can happen on versioned docs, not current version
     // We avoid creating empty versioned sidebars file with the CLI
-    if (!(await fs_extra_1.default.pathExists(sidebarFilePath))) {
+    if (!(await (0, fs_1.pathExists)(sidebarFilePath))) {
         return exports.DisabledSidebars;
     }
     // We don't want sidebars to be cached because of hot reloading.

package/lib/versions/files.js

@@ -16,8 +16,8 @@ exports.readVersionNames = readVersionNames;
 exports.getVersionMetadataPaths = getVersionMetadataPaths;
 const tslib_1 = require("tslib");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const utils_1 = require("@docusaurus/utils");
+const fs_1 = require("@docusaurus/fs");
 const constants_1 = require("../constants");
 const validation_1 = require("./validation");
 /** Add a prefix like `community_version-1.0.0`. No-op for default instance. */
@@ -66,8 +66,8 @@ function getVersionsFilePath(siteDir, pluginId) {
  */
 async function readVersionsFile(siteDir, pluginId) {
     const versionsFilePath = getVersionsFilePath(siteDir, pluginId);
-    if (await fs_extra_1.default.pathExists(versionsFilePath)) {
-        const content = await fs_extra_1.default.readJSON(versionsFilePath);
+    if (await (0, fs_1.pathExists)(versionsFilePath)) {
+        const content = await (0, fs_1.readJSON)(versionsFilePath);
         (0, validation_1.validateVersionNames)(content);
         return content;
     }
@@ -131,7 +131,7 @@ async function getVersionMetadataPaths({ versionName, context, options, }) {
     const sidebarFilePath = isCurrent
         ? options.sidebarPath
         : getVersionSidebarsPath(context.siteDir, options.id, versionName);
-    if (!(await fs_extra_1.default.pathExists(contentPath))) {
+    if (!(await (0, fs_1.pathExists)(contentPath))) {
         throw new Error(`The docs folder does not exist for version "${versionName}". A docs folder is expected to be found at ${node_path_1.default.relative(context.siteDir, contentPath)}.`);
     }
     // If the current version defines a path to a sidebar file that does not
@@ -141,7 +141,7 @@ async function getVersionMetadataPaths({ versionName, context, options, }) {
     // See https://github.com/facebook/docusaurus/pull/4775
     if (versionName === constants_1.CURRENT_VERSION_NAME &&
         typeof sidebarFilePath === 'string' &&
-        !(await fs_extra_1.default.pathExists(sidebarFilePath))) {
+        !(await (0, fs_1.pathExists)(sidebarFilePath))) {
         throw new Error(`The path to the sidebar file does not exist at "${node_path_1.default.relative(context.siteDir, sidebarFilePath)}".
 Please set the docs "sidebarPath" field in your config file to:
 - a sidebars path that exists

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "4.0.0-canary-6884",
+  "version": "4.0.0-canary-6888",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,19 +35,19 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "4.0.0-canary-6884",
-    "@docusaurus/glob": "4.0.0-canary-6884",
-    "@docusaurus/logger": "4.0.0-canary-6884",
-    "@docusaurus/mdx-loader": "4.0.0-canary-6884",
-    "@docusaurus/module-type-aliases": "4.0.0-canary-6884",
-    "@docusaurus/theme-common": "4.0.0-canary-6884",
-    "@docusaurus/types": "4.0.0-canary-6884",
-    "@docusaurus/utils": "4.0.0-canary-6884",
-    "@docusaurus/utils-common": "4.0.0-canary-6884",
-    "@docusaurus/utils-validation": "4.0.0-canary-6884",
+    "@docusaurus/core": "4.0.0-canary-6888",
+    "@docusaurus/fs": "4.0.0-canary-6888",
+    "@docusaurus/glob": "4.0.0-canary-6888",
+    "@docusaurus/logger": "4.0.0-canary-6888",
+    "@docusaurus/mdx-loader": "4.0.0-canary-6888",
+    "@docusaurus/module-type-aliases": "4.0.0-canary-6888",
+    "@docusaurus/theme-common": "4.0.0-canary-6888",
+    "@docusaurus/types": "4.0.0-canary-6888",
+    "@docusaurus/utils": "4.0.0-canary-6888",
+    "@docusaurus/utils-common": "4.0.0-canary-6888",
+    "@docusaurus/utils-validation": "4.0.0-canary-6888",
     "@types/react-router-config": "^5.0.11",
     "combine-promises": "^1.2.0",
-    "fs-extra": "^11.4.0",
     "js-yaml": "^5.4.1",
     "lodash": "^4.18.1",
     "schema-dts": "^1.1.5",
@@ -69,5 +69,5 @@
   "engines": {
     "node": ">=24.21"
   },
-  "gitHead": "f3c3fe7b0244f65763127507f50449ad2c7bd7b1"
+  "gitHead": "5019a662590dcb2722926890c1ade27194bc3b70"
 }

package/src/cli.ts

@@ -5,10 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import fs from 'fs-extra';
+import fs from 'node:fs/promises';
 import path from 'node:path';
 import logger from '@docusaurus/logger';
 import {DEFAULT_PLUGIN_ID, getLocaleConfig} from '@docusaurus/utils';
+import {pathExists, outputFile} from '@docusaurus/fs';
 import {
   getVersionsFilePath,
   getVersionDocsDirPath,
@@ -45,7 +46,7 @@ async function createVersionedSidebarFile({
   const shouldCreateVersionedSidebarFile = Object.keys(sidebars).length > 0;
 
   if (shouldCreateVersionedSidebarFile) {
-    await fs.outputFile(
+    await outputFile(
       getVersionSidebarsPath(siteDir, pluginId, version),
       `${JSON.stringify(sidebars, null, 2)}\n`,
       'utf8',
@@ -102,7 +103,7 @@ async function cliDocsVersionCommand(
             });
 
       if (
-        !(await fs.pathExists(docsDir)) ||
+        !(await pathExists(docsDir)) ||
         (await fs.readdir(docsDir)).length === 0
       ) {
         if (locale === i18n.defaultLocale) {
@@ -123,7 +124,11 @@ async function cliDocsVersionCommand(
               pluginId,
               versionName: version,
             });
-      await fs.copy(docsDir, newVersionDir);
+      // verbatimSymlinks: keep relative symlinks relative
+      await fs.cp(docsDir, newVersionDir, {
+        recursive: true,
+        verbatimSymlinks: true,
+      });
 
       // Copy version JSON translation file for this locale
       // i18n/<l>/docusaurus-plugin-content-docs/current.json => version-v1.json
@@ -135,8 +140,8 @@ async function cliDocsVersionCommand(
         });
         const sourceFile = path.join(dir, 'current.json');
         const dest = path.join(dir, `version-${version}.json`);
-        if (await fs.pathExists(sourceFile)) {
-          await fs.copy(sourceFile, dest);
+        if (await pathExists(sourceFile)) {
+          await fs.cp(sourceFile, dest, {verbatimSymlinks: true});
         } else {
           logger.warn`${pluginIdLogPrefix}: i18n translation file does not exist in path=${sourceFile}. Skipping.`;
         }
@@ -153,7 +158,7 @@ async function cliDocsVersionCommand(
 
   // Update versions.json file.
   versions.unshift(version);
-  await fs.outputFile(
+  await outputFile(
     getVersionsFilePath(siteDir, pluginId),
     `${JSON.stringify(versions, null, 2)}\n`,
   );

package/src/docs.ts

@@ -6,7 +6,7 @@
  */
 
 import path from 'node:path';
-import fs from 'fs-extra';
+import fs from 'node:fs/promises';
 import _ from 'lodash';
 import {
   aliasedSitePath,
@@ -22,6 +22,7 @@ import {
   normalizeTags,
 } from '@docusaurus/utils';
 import {glob} from '@docusaurus/glob';
+import {queueFileOperation} from '@docusaurus/fs';
 import {validateDocFrontMatter} from './frontMatter';
 import getSlug from './slug';
 import {stripPathNumberPrefixes} from './numberPrefix';
@@ -55,7 +56,9 @@ export async function readDocFile(
 
   const filePath = path.join(contentPath, source);
 
-  const content = await fs.readFile(filePath, 'utf-8');
+  const content = await queueFileOperation(() =>
+    fs.readFile(filePath, 'utf-8'),
+  );
   return {source, content, contentPath, filePath};
 }
 

package/src/index.ts

@@ -6,7 +6,7 @@
  */
 
 import path from 'node:path';
-import fs from 'fs-extra';
+import fs from 'node:fs/promises';
 import {
   normalizeUrl,
   docuHash,
@@ -74,7 +74,7 @@ async function createMdxLoaderDependencyFile({
     options,
     versionsMetadata,
   };
-  await fs.ensureDir(dataDir);
+  await fs.mkdir(dataDir, {recursive: true});
   await fs.writeFile(filePath, JSON.stringify(fileContent));
   return filePath;
 }

package/src/sidebars/index.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import fs from 'fs-extra';
+import fs from 'node:fs/promises';
 import path from 'node:path';
 import _ from 'lodash';
 import logger from '@docusaurus/logger';
@@ -13,6 +13,7 @@ import {loadFreshModule} from '@docusaurus/utils';
 import {glob} from '@docusaurus/glob';
 import * as Yaml from 'js-yaml';
 import combinePromises from 'combine-promises';
+import {pathExists} from '@docusaurus/fs';
 import {validateSidebars, validateCategoryMetadataFile} from './validation';
 import {normalizeSidebars} from './normalization';
 import {processSidebars} from './processor';
@@ -84,7 +85,7 @@ async function loadSidebarsFileUnsafe(
   // Non-existent sidebars file: no sidebars
   // Note: this edge case can happen on versioned docs, not current version
   // We avoid creating empty versioned sidebars file with the CLI
-  if (!(await fs.pathExists(sidebarFilePath))) {
+  if (!(await pathExists(sidebarFilePath))) {
     return DisabledSidebars;
   }
 

package/src/versions/files.ts

@@ -6,12 +6,12 @@
  */
 
 import path from 'node:path';
-import fs from 'fs-extra';
 import {
   getPluginI18nPath,
   getLocaleConfig,
   DEFAULT_PLUGIN_ID,
 } from '@docusaurus/utils';
+import {pathExists, readJSON} from '@docusaurus/fs';
 import {
   VERSIONS_JSON_FILE,
   VERSIONED_DOCS_DIR,
@@ -110,8 +110,8 @@ export async function readVersionsFile(
   pluginId: string,
 ): Promise<string[] | null> {
   const versionsFilePath = getVersionsFilePath(siteDir, pluginId);
-  if (await fs.pathExists(versionsFilePath)) {
-    const content: unknown = await fs.readJSON(versionsFilePath);
+  if (await pathExists(versionsFilePath)) {
+    const content: unknown = await readJSON(versionsFilePath);
     validateVersionNames(content);
     return content;
   }
@@ -207,7 +207,7 @@ export async function getVersionMetadataPaths({
     ? options.sidebarPath
     : getVersionSidebarsPath(context.siteDir, options.id, versionName);
 
-  if (!(await fs.pathExists(contentPath))) {
+  if (!(await pathExists(contentPath))) {
     throw new Error(
       `The docs folder does not exist for version "${versionName}". A docs folder is expected to be found at ${path.relative(
         context.siteDir,
@@ -224,7 +224,7 @@ export async function getVersionMetadataPaths({
   if (
     versionName === CURRENT_VERSION_NAME &&
     typeof sidebarFilePath === 'string' &&
-    !(await fs.pathExists(sidebarFilePath))
+    !(await pathExists(sidebarFilePath))
   ) {
     throw new Error(`The path to the sidebar file does not exist at "${path.relative(
       context.siteDir,