@docusaurus/plugin-content-docs 0.0.0-4610 → 0.0.0-4611

package/lib/cli.js

@@ -26,8 +26,8 @@ async function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, vers
     if (shouldCreateVersionedSidebarFile) {
         const versionedSidebarsDir = (0, versions_1.getVersionedSidebarsDirPath)(siteDir, pluginId);
         const newSidebarFile = path_1.default.join(versionedSidebarsDir, `version-${version}-sidebars.json`);
-        fs_extra_1.default.ensureDirSync(path_1.default.dirname(newSidebarFile));
-        fs_extra_1.default.writeFileSync(newSidebarFile, `${JSON.stringify(sidebars, null, 2)}\n`, 'utf8');
+        await fs_extra_1.default.ensureDir(path_1.default.dirname(newSidebarFile));
+        await fs_extra_1.default.writeFile(newSidebarFile, `${JSON.stringify(sidebars, null, 2)}\n`, 'utf8');
     }
 }
 // Tests depend on non-default export for mocking.
@@ -56,8 +56,8 @@ async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     // Load existing versions.
     let versions = [];
     const versionsJSONFile = (0, versions_1.getVersionsFilePath)(siteDir, pluginId);
-    if (fs_extra_1.default.existsSync(versionsJSONFile)) {
-        versions = JSON.parse(fs_extra_1.default.readFileSync(versionsJSONFile, 'utf8'));
+    if (await fs_extra_1.default.pathExists(versionsJSONFile)) {
+        versions = JSON.parse(await fs_extra_1.default.readFile(versionsJSONFile, 'utf8'));
     }
     // Check if version already exists.
     if (versions.includes(version)) {
@@ -66,10 +66,11 @@ async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     const { path: docsPath, sidebarPath } = options;
     // Copy docs files.
     const docsDir = path_1.default.join(siteDir, docsPath);
-    if (fs_extra_1.default.existsSync(docsDir) && fs_extra_1.default.readdirSync(docsDir).length > 0) {
+    if ((await fs_extra_1.default.pathExists(docsDir)) &&
+        (await fs_extra_1.default.readdir(docsDir)).length > 0) {
         const versionedDir = (0, versions_1.getVersionedDocsDirPath)(siteDir, pluginId);
         const newVersionDir = path_1.default.join(versionedDir, `version-${version}`);
-        fs_extra_1.default.copySync(docsDir, newVersionDir);
+        await fs_extra_1.default.copy(docsDir, newVersionDir);
     }
     else {
         throw new Error(`${pluginIdLogPrefix}: there is no docs to version!`);
@@ -82,8 +83,8 @@ async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     });
     // Update versions.json file.
     versions.unshift(version);
-    fs_extra_1.default.ensureDirSync(path_1.default.dirname(versionsJSONFile));
-    fs_extra_1.default.writeFileSync(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
+    await fs_extra_1.default.ensureDir(path_1.default.dirname(versionsJSONFile));
+    await fs_extra_1.default.writeFile(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
     logger_1.default.success `name=${pluginIdLogPrefix}: version name=${version} created!`;
 }
 exports.cliDocsVersionCommand = cliDocsVersionCommand;

package/lib/sidebars/index.js

@@ -69,7 +69,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 (!fs_extra_1.default.existsSync(sidebarFilePath)) {
+    if (!(await fs_extra_1.default.pathExists(sidebarFilePath))) {
         return exports.DisabledSidebars;
     }
     // We don't want sidebars to be cached because of hot reloading.

package/lib/versions.js

@@ -236,11 +236,11 @@ function createVersionMetadata({ versionName, versionNames, lastVersionName, con
         contentPathLocalized,
     };
 }
-function checkVersionMetadataPaths({ versionMetadata, context, }) {
+async function checkVersionMetadataPaths({ versionMetadata, context, }) {
     const { versionName, contentPath, sidebarFilePath } = versionMetadata;
     const { siteDir } = context;
     const isCurrentVersion = versionName === constants_1.CURRENT_VERSION_NAME;
-    if (!fs_extra_1.default.existsSync(contentPath)) {
+    if (!(await fs_extra_1.default.pathExists(contentPath))) {
         throw new Error(`The docs folder does not exist for version "${versionName}". A docs folder is expected to be found at ${path_1.default.relative(siteDir, contentPath)}.`);
     }
     // If the current version defines a path to a sidebar file that does not
@@ -250,7 +250,7 @@ function checkVersionMetadataPaths({ versionMetadata, context, }) {
     // See https://github.com/facebook/docusaurus/pull/4775
     if (isCurrentVersion &&
         typeof sidebarFilePath === 'string' &&
-        !fs_extra_1.default.existsSync(sidebarFilePath)) {
+        !(await fs_extra_1.default.pathExists(sidebarFilePath))) {
         throw new Error(`The path to the sidebar file does not exist at "${path_1.default.relative(siteDir, sidebarFilePath)}".
 Please set the docs "sidebarPath" field in your config file to:
 - a sidebars path that exists
@@ -316,7 +316,7 @@ async function readVersionsMetadata({ context, options, }) {
         context,
         options,
     }));
-    versionsMetadata.forEach((versionMetadata) => checkVersionMetadataPaths({ versionMetadata, context }));
+    await Promise.all(versionsMetadata.map((versionMetadata) => checkVersionMetadataPaths({ versionMetadata, context })));
     return versionsMetadata;
 }
 exports.readVersionsMetadata = readVersionsMetadata;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4610",
+  "version": "0.0.0-4611",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4610",
-    "@docusaurus/logger": "0.0.0-4610",
-    "@docusaurus/mdx-loader": "0.0.0-4610",
-    "@docusaurus/utils": "0.0.0-4610",
-    "@docusaurus/utils-validation": "0.0.0-4610",
+    "@docusaurus/core": "0.0.0-4611",
+    "@docusaurus/logger": "0.0.0-4611",
+    "@docusaurus/mdx-loader": "0.0.0-4611",
+    "@docusaurus/utils": "0.0.0-4611",
+    "@docusaurus/utils-validation": "0.0.0-4611",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.0",
     "import-fresh": "^3.3.0",
@@ -39,8 +39,8 @@
     "webpack": "^5.69.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4610",
-    "@docusaurus/types": "0.0.0-4610",
+    "@docusaurus/module-type-aliases": "0.0.0-4611",
+    "@docusaurus/types": "0.0.0-4611",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "3208d225c0366f7a46f6f9ecf622cf2e1f9a3018"
+  "gitHead": "6a09283902da2fc8e205f36a018b80d8c8140d1f"
 }

package/src/cli.ts

@@ -47,8 +47,8 @@ async function createVersionedSidebarFile({
       versionedSidebarsDir,
       `version-${version}-sidebars.json`,
     );
-    fs.ensureDirSync(path.dirname(newSidebarFile));
-    fs.writeFileSync(
+    await fs.ensureDir(path.dirname(newSidebarFile));
+    await fs.writeFile(
       newSidebarFile,
       `${JSON.stringify(sidebars, null, 2)}\n`,
       'utf8',
@@ -104,8 +104,8 @@ export async function cliDocsVersionCommand(
   // Load existing versions.
   let versions = [];
   const versionsJSONFile = getVersionsFilePath(siteDir, pluginId);
-  if (fs.existsSync(versionsJSONFile)) {
-    versions = JSON.parse(fs.readFileSync(versionsJSONFile, 'utf8'));
+  if (await fs.pathExists(versionsJSONFile)) {
+    versions = JSON.parse(await fs.readFile(versionsJSONFile, 'utf8'));
   }
 
   // Check if version already exists.
@@ -120,10 +120,13 @@ export async function cliDocsVersionCommand(
   // Copy docs files.
   const docsDir = path.join(siteDir, docsPath);
 
-  if (fs.existsSync(docsDir) && fs.readdirSync(docsDir).length > 0) {
+  if (
+    (await fs.pathExists(docsDir)) &&
+    (await fs.readdir(docsDir)).length > 0
+  ) {
     const versionedDir = getVersionedDocsDirPath(siteDir, pluginId);
     const newVersionDir = path.join(versionedDir, `version-${version}`);
-    fs.copySync(docsDir, newVersionDir);
+    await fs.copy(docsDir, newVersionDir);
   } else {
     throw new Error(`${pluginIdLogPrefix}: there is no docs to version!`);
   }
@@ -137,8 +140,11 @@ export async function cliDocsVersionCommand(
 
   // Update versions.json file.
   versions.unshift(version);
-  fs.ensureDirSync(path.dirname(versionsJSONFile));
-  fs.writeFileSync(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
+  await fs.ensureDir(path.dirname(versionsJSONFile));
+  await fs.writeFile(
+    versionsJSONFile,
+    `${JSON.stringify(versions, null, 2)}\n`,
+  );
 
   logger.success`name=${pluginIdLogPrefix}: version name=${version} created!`;
 }

package/src/sidebars/index.ts

@@ -85,7 +85,7 @@ export 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 (!fs.existsSync(sidebarFilePath)) {
+  if (!(await fs.pathExists(sidebarFilePath))) {
     return DisabledSidebars;
   }
 

package/src/versions.ts

@@ -418,7 +418,7 @@ function createVersionMetadata({
   };
 }
 
-function checkVersionMetadataPaths({
+async function checkVersionMetadataPaths({
   versionMetadata,
   context,
 }: {
@@ -429,7 +429,7 @@ function checkVersionMetadataPaths({
   const {siteDir} = context;
   const isCurrentVersion = versionName === CURRENT_VERSION_NAME;
 
-  if (!fs.existsSync(contentPath)) {
+  if (!(await fs.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(
         siteDir,
@@ -446,7 +446,7 @@ function checkVersionMetadataPaths({
   if (
     isCurrentVersion &&
     typeof sidebarFilePath === 'string' &&
-    !fs.existsSync(sidebarFilePath)
+    !(await fs.pathExists(sidebarFilePath))
   ) {
     throw new Error(`The path to the sidebar file does not exist at "${path.relative(
       siteDir,
@@ -585,8 +585,10 @@ export async function readVersionsMetadata({
       options,
     }),
   );
-  versionsMetadata.forEach((versionMetadata) =>
-    checkVersionMetadataPaths({versionMetadata, context}),
+  await Promise.all(
+    versionsMetadata.map((versionMetadata) =>
+      checkVersionMetadataPaths({versionMetadata, context}),
+    ),
   );
   return versionsMetadata;
 }