@docusaurus/plugin-content-docs 3.0.0-beta.0 → 3.0.0-rc.1

package/lib/cli.js

@@ -21,7 +21,7 @@ async function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, vers
     // Note: we don't need the sidebars file to be normalized: it's ok to let
     // plugin option changes to impact older, versioned sidebars
     // We don't validate here, assuming the user has already built the version
-    const sidebars = await (0, sidebars_1.loadSidebarsFileUnsafe)(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;

package/lib/sidebars/index.d.ts

@@ -9,5 +9,5 @@ import type { SidebarsConfig, Sidebars, SidebarProcessorParams } from './types';
 export declare const DefaultSidebars: SidebarsConfig;
 export declare const DisabledSidebars: SidebarsConfig;
 export declare function resolveSidebarPathOption(siteDir: string, sidebarPathOption: PluginOptions['sidebarPath']): PluginOptions['sidebarPath'];
-export declare function loadSidebarsFileUnsafe(sidebarFilePath: string | false | undefined): Promise<SidebarsConfig>;
+export declare function loadSidebarsFile(sidebarFilePath: string | false | undefined): Promise<SidebarsConfig>;
 export declare function loadSidebars(sidebarFilePath: string | false | undefined, options: SidebarProcessorParams): Promise<Sidebars>;

package/lib/sidebars/index.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadSidebars = exports.loadSidebarsFileUnsafe = exports.resolveSidebarPathOption = exports.DisabledSidebars = exports.DefaultSidebars = void 0;
+exports.loadSidebars = exports.loadSidebarsFile = exports.resolveSidebarPathOption = exports.DisabledSidebars = exports.DefaultSidebars = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -15,7 +15,6 @@ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
-const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
 const validation_1 = require("./validation");
 const normalization_1 = require("./normalization");
 const processor_1 = require("./processor");
@@ -72,9 +71,16 @@ async function loadSidebarsFileUnsafe(sidebarFilePath) {
         return exports.DisabledSidebars;
     }
     // We don't want sidebars to be cached because of hot reloading.
-    return (0, import_fresh_1.default)(sidebarFilePath);
+    const module = await (0, utils_1.loadFreshModule)(sidebarFilePath);
+    // TODO unsafe, need to refactor and improve validation
+    return module;
 }
-exports.loadSidebarsFileUnsafe = loadSidebarsFileUnsafe;
+async function loadSidebarsFile(sidebarFilePath) {
+    const sidebars = await loadSidebarsFileUnsafe(sidebarFilePath);
+    // TODO unsafe, need to refactor and improve validation
+    return sidebars;
+}
+exports.loadSidebarsFile = loadSidebarsFile;
 async function loadSidebars(sidebarFilePath, options) {
     try {
         const sidebarsConfig = await loadSidebarsFileUnsafe(sidebarFilePath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "3.0.0-beta.0",
+  "version": "3.0.0-rc.1",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,17 +35,16 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.0.0-beta.0",
-    "@docusaurus/logger": "3.0.0-beta.0",
-    "@docusaurus/mdx-loader": "3.0.0-beta.0",
-    "@docusaurus/module-type-aliases": "3.0.0-beta.0",
-    "@docusaurus/types": "3.0.0-beta.0",
-    "@docusaurus/utils": "3.0.0-beta.0",
-    "@docusaurus/utils-validation": "3.0.0-beta.0",
+    "@docusaurus/core": "3.0.0-rc.1",
+    "@docusaurus/logger": "3.0.0-rc.1",
+    "@docusaurus/mdx-loader": "3.0.0-rc.1",
+    "@docusaurus/module-type-aliases": "3.0.0-rc.1",
+    "@docusaurus/types": "3.0.0-rc.1",
+    "@docusaurus/utils": "3.0.0-rc.1",
+    "@docusaurus/utils-validation": "3.0.0-rc.1",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.1.1",
-    "import-fresh": "^3.3.0",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "tslib": "^2.6.0",
@@ -64,7 +63,7 @@
     "react-dom": "^18.0.0"
   },
   "engines": {
-    "node": ">=16.14"
+    "node": ">=18.0"
   },
-  "gitHead": "27a1e90d9fff88af90ecad35bea16d4d7230482a"
+  "gitHead": "a51cc6fd7660d47ea08349f723cec9c017af0b4e"
 }

package/src/cli.ts

@@ -17,7 +17,7 @@ import {
   readVersionsFile,
 } from './versions/files';
 import {validateVersionName} from './versions/validation';
-import {loadSidebarsFileUnsafe} from './sidebars';
+import {loadSidebarsFile} from './sidebars';
 import {CURRENT_VERSION_NAME} from './constants';
 import type {PluginOptions} from '@docusaurus/plugin-content-docs';
 import type {LoadContext} from '@docusaurus/types';
@@ -37,7 +37,7 @@ async function createVersionedSidebarFile({
   // Note: we don't need the sidebars file to be normalized: it's ok to let
   // plugin option changes to impact older, versioned sidebars
   // We don't validate here, assuming the user has already built the version
-  const sidebars = await loadSidebarsFileUnsafe(sidebarPath);
+  const sidebars = await loadSidebarsFile(sidebarPath);
 
   // Do not create a useless versioned sidebars file if sidebars file is empty
   // or sidebars are disabled/false)

package/src/sidebars/index.ts

@@ -9,10 +9,9 @@ import fs from 'fs-extra';
 import path from 'path';
 import _ from 'lodash';
 import logger from '@docusaurus/logger';
-import {Globby} from '@docusaurus/utils';
+import {loadFreshModule, Globby} from '@docusaurus/utils';
 import Yaml from 'js-yaml';
 import combinePromises from 'combine-promises';
-import importFresh from 'import-fresh';
 import {validateSidebars, validateCategoryMetadataFile} from './validation';
 import {normalizeSidebars} from './normalization';
 import {processSidebars} from './processor';
@@ -68,7 +67,7 @@ async function readCategoriesMetadata(contentPath: string) {
   );
 }
 
-export async function loadSidebarsFileUnsafe(
+async function loadSidebarsFileUnsafe(
   sidebarFilePath: string | false | undefined,
 ): Promise<SidebarsConfig> {
   // false => no sidebars
@@ -89,7 +88,19 @@ export async function loadSidebarsFileUnsafe(
   }
 
   // We don't want sidebars to be cached because of hot reloading.
-  return importFresh(sidebarFilePath);
+  const module = await loadFreshModule(sidebarFilePath);
+
+  // TODO unsafe, need to refactor and improve validation
+  return module as SidebarsConfig;
+}
+
+export async function loadSidebarsFile(
+  sidebarFilePath: string | false | undefined,
+): Promise<SidebarsConfig> {
+  const sidebars = await loadSidebarsFileUnsafe(sidebarFilePath);
+
+  // TODO unsafe, need to refactor and improve validation
+  return sidebars as SidebarsConfig;
 }
 
 export async function loadSidebars(