@docusaurus/plugin-content-docs 0.0.0-4524 → 0.0.0-4525

package/lib/cli.d.ts

@@ -5,4 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { PathOptions, SidebarOptions } from '@docusaurus/plugin-content-docs';
-export declare function cliDocsVersionCommand(version: string | null | undefined, siteDir: string, pluginId: string, options: PathOptions & SidebarOptions): void;
+export declare function cliDocsVersionCommand(version: string | null | undefined, siteDir: string, pluginId: string, options: PathOptions & SidebarOptions): Promise<void>;

package/lib/cli.js

@@ -14,11 +14,11 @@ const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const sidebars_1 = require("./sidebars");
 const utils_1 = require("@docusaurus/utils");
 const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
-function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, version, }) {
+async function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, version, }) {
     // Load current sidebar and create a new versioned sidebars file (if needed).
     // Note: we don't need the sidebars file to be normalized: it's ok to let
     // plugin option changes to impact older, versioned sidebars
-    const sidebars = (0, sidebars_1.loadSidebarsFile)(sidebarPath);
+    const sidebars = await (0, sidebars_1.loadSidebarsFile)(sidebarPath);
     // Do not create a useless versioned sidebars file if sidebars file is empty
     // or sidebars are disabled/false)
     const shouldCreateVersionedSidebarFile = Object.keys(sidebars).length > 0;
@@ -30,7 +30,7 @@ function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, version, }
     }
 }
 // Tests depend on non-default export for mocking.
-function cliDocsVersionCommand(version, siteDir, pluginId, options) {
+async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     // It wouldn't be very user-friendly to show a [default] log prefix,
     // so we use [docs] instead of [default]
     const pluginIdLogPrefix = pluginId === utils_1.DEFAULT_PLUGIN_ID ? '[docs]' : `[${pluginId}]`;
@@ -73,7 +73,7 @@ function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     else {
         throw new Error(`${pluginIdLogPrefix}: there is no docs to version!`);
     }
-    createVersionedSidebarFile({
+    await createVersionedSidebarFile({
         siteDir,
         pluginId,
         version,

package/lib/sidebars/index.d.ts

@@ -11,6 +11,6 @@ import type { PluginOptions } from '@docusaurus/plugin-content-docs';
 export declare const DefaultSidebars: SidebarsConfig;
 export declare const DisabledSidebars: SidebarsConfig;
 export declare function resolveSidebarPathOption(siteDir: string, sidebarPathOption: PluginOptions['sidebarPath']): PluginOptions['sidebarPath'];
-export declare function loadSidebarsFile(sidebarFilePath: string | false | undefined): SidebarsConfig;
-export declare function loadNormalizedSidebars(sidebarFilePath: string | false | undefined, params: NormalizeSidebarsParams): NormalizedSidebars;
+export declare function loadSidebarsFile(sidebarFilePath: string | false | undefined): Promise<SidebarsConfig>;
+export declare function loadNormalizedSidebars(sidebarFilePath: string | false | undefined, params: NormalizeSidebarsParams): Promise<NormalizedSidebars>;
 export declare function loadSidebars(sidebarFilePath: string | false | undefined, options: SidebarProcessorParams): Promise<Sidebars>;

package/lib/sidebars/index.js

@@ -32,7 +32,7 @@ function resolveSidebarPathOption(siteDir, sidebarPathOption) {
         : sidebarPathOption;
 }
 exports.resolveSidebarPathOption = resolveSidebarPathOption;
-function loadSidebarsFileUnsafe(sidebarFilePath) {
+async function loadSidebarsFileUnsafe(sidebarFilePath) {
     // false => no sidebars
     if (sidebarFilePath === false) {
         return exports.DisabledSidebars;
@@ -50,14 +50,14 @@ function loadSidebarsFileUnsafe(sidebarFilePath) {
     // We don't want sidebars to be cached because of hot reloading.
     return (0, import_fresh_1.default)(sidebarFilePath);
 }
-function loadSidebarsFile(sidebarFilePath) {
-    const sidebarsConfig = loadSidebarsFileUnsafe(sidebarFilePath);
+async function loadSidebarsFile(sidebarFilePath) {
+    const sidebarsConfig = await loadSidebarsFileUnsafe(sidebarFilePath);
     (0, validation_1.validateSidebars)(sidebarsConfig);
     return sidebarsConfig;
 }
 exports.loadSidebarsFile = loadSidebarsFile;
-function loadNormalizedSidebars(sidebarFilePath, params) {
-    return (0, normalization_1.normalizeSidebars)(loadSidebarsFile(sidebarFilePath), params);
+async function loadNormalizedSidebars(sidebarFilePath, params) {
+    return (0, normalization_1.normalizeSidebars)(await loadSidebarsFile(sidebarFilePath), params);
 }
 exports.loadNormalizedSidebars = loadNormalizedSidebars;
 // Note: sidebarFilePath must be absolute, use resolveSidebarPathOption
@@ -67,7 +67,7 @@ async function loadSidebars(sidebarFilePath, options) {
         version: options.version,
         categoryLabelSlugger: (0, utils_1.createSlugger)(),
     };
-    const normalizedSidebars = loadNormalizedSidebars(sidebarFilePath, normalizeSidebarsParams);
+    const normalizedSidebars = await loadNormalizedSidebars(sidebarFilePath, normalizeSidebarsParams);
     return (0, processor_1.processSidebars)(normalizedSidebars, options);
 }
 exports.loadSidebars = loadSidebars;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4524",
+  "version": "0.0.0-4525",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -22,11 +22,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4524",
-    "@docusaurus/logger": "0.0.0-4524",
-    "@docusaurus/mdx-loader": "0.0.0-4524",
-    "@docusaurus/utils": "0.0.0-4524",
-    "@docusaurus/utils-validation": "0.0.0-4524",
+    "@docusaurus/core": "0.0.0-4525",
+    "@docusaurus/logger": "0.0.0-4525",
+    "@docusaurus/mdx-loader": "0.0.0-4525",
+    "@docusaurus/utils": "0.0.0-4525",
+    "@docusaurus/utils-validation": "0.0.0-4525",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.0",
     "import-fresh": "^3.2.2",
@@ -39,8 +39,8 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4524",
-    "@docusaurus/types": "0.0.0-4524",
+    "@docusaurus/module-type-aliases": "0.0.0-4525",
+    "@docusaurus/types": "0.0.0-4525",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "41a6bff3a67446f7d2a2972cbe4d05fec7378a15"
+  "gitHead": "c1122ee21d114f85261bed9b8296ab3501454098"
 }

package/src/cli.ts

@@ -20,7 +20,7 @@ import {loadSidebarsFile, resolveSidebarPathOption} from './sidebars';
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
 import logger from '@docusaurus/logger';
 
-function createVersionedSidebarFile({
+async function createVersionedSidebarFile({
   siteDir,
   pluginId,
   sidebarPath,
@@ -34,7 +34,7 @@ function createVersionedSidebarFile({
   // Load current sidebar and create a new versioned sidebars file (if needed).
   // Note: we don't need the sidebars file to be normalized: it's ok to let
   // plugin option changes to impact older, versioned sidebars
-  const sidebars = loadSidebarsFile(sidebarPath);
+  const sidebars = await loadSidebarsFile(sidebarPath);
 
   // Do not create a useless versioned sidebars file if sidebars file is empty
   // or sidebars are disabled/false)
@@ -56,12 +56,12 @@ function createVersionedSidebarFile({
 }
 
 // Tests depend on non-default export for mocking.
-export function cliDocsVersionCommand(
+export async function cliDocsVersionCommand(
   version: string | null | undefined,
   siteDir: string,
   pluginId: string,
   options: PathOptions & SidebarOptions,
-): void {
+): Promise<void> {
   // It wouldn't be very user-friendly to show a [default] log prefix,
   // so we use [docs] instead of [default]
   const pluginIdLogPrefix =
@@ -127,7 +127,7 @@ export function cliDocsVersionCommand(
     throw new Error(`${pluginIdLogPrefix}: there is no docs to version!`);
   }
 
-  createVersionedSidebarFile({
+  await createVersionedSidebarFile({
     siteDir,
     pluginId,
     version,

package/src/sidebars/index.ts

@@ -38,9 +38,9 @@ export function resolveSidebarPathOption(
     : sidebarPathOption;
 }
 
-function loadSidebarsFileUnsafe(
+async function loadSidebarsFileUnsafe(
   sidebarFilePath: string | false | undefined,
-): SidebarsConfig {
+): Promise<SidebarsConfig> {
   // false => no sidebars
   if (sidebarFilePath === false) {
     return DisabledSidebars;
@@ -62,19 +62,19 @@ function loadSidebarsFileUnsafe(
   return importFresh(sidebarFilePath);
 }
 
-export function loadSidebarsFile(
+export async function loadSidebarsFile(
   sidebarFilePath: string | false | undefined,
-): SidebarsConfig {
-  const sidebarsConfig = loadSidebarsFileUnsafe(sidebarFilePath);
+): Promise<SidebarsConfig> {
+  const sidebarsConfig = await loadSidebarsFileUnsafe(sidebarFilePath);
   validateSidebars(sidebarsConfig);
   return sidebarsConfig;
 }
 
-export function loadNormalizedSidebars(
+export async function loadNormalizedSidebars(
   sidebarFilePath: string | false | undefined,
   params: NormalizeSidebarsParams,
-): NormalizedSidebars {
-  return normalizeSidebars(loadSidebarsFile(sidebarFilePath), params);
+): Promise<NormalizedSidebars> {
+  return normalizeSidebars(await loadSidebarsFile(sidebarFilePath), params);
 }
 
 // Note: sidebarFilePath must be absolute, use resolveSidebarPathOption
@@ -87,7 +87,7 @@ export async function loadSidebars(
     version: options.version,
     categoryLabelSlugger: createSlugger(),
   };
-  const normalizedSidebars = loadNormalizedSidebars(
+  const normalizedSidebars = await loadNormalizedSidebars(
     sidebarFilePath,
     normalizeSidebarsParams,
   );