@docusaurus/core 4.0.0-canary-6888 → 4.0.0-canary-6892

package/lib/commands/build/buildLocale.js

@@ -8,11 +8,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildLocale = buildLocale;
 const tslib_1 = require("tslib");
-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 bundler_1 = require("@docusaurus/bundler");
 const logger_1 = tslib_1.__importStar(require("@docusaurus/logger"));
+const fs_1 = require("@docusaurus/fs");
 const site_1 = require("../../server/site");
 const brokenLinks_1 = require("../../server/brokenLinks");
 const client_1 = require("../../webpack/client");
@@ -164,7 +164,7 @@ async function cleanupServerBundle(serverBundlePath) {
         await logger_1.PerfLogger.async('Deleting server bundle', async () => {
             // For now we assume server entry is at the root of the server out dir
             const serverDir = node_path_1.default.dirname(serverBundlePath);
-            await promises_1.default.rm(serverDir, { recursive: true, force: true });
+            await fs_1.fs.rm(serverDir, { recursive: true, force: true });
         });
     }
 }

package/lib/commands/deploy.js

@@ -8,7 +8,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deploy = deploy;
 const tslib_1 = require("tslib");
-const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const node_os_1 = tslib_1.__importDefault(require("node:os"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
@@ -147,7 +146,7 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
     const runDeploy = async (outputDirectory) => {
         const targetDirectory = cliOptions.targetDir ?? '.';
         const fromPath = outputDirectory;
-        const toPath = await promises_1.default.mkdtemp(node_path_1.default.join(node_os_1.default.tmpdir(), `${projectName}-${deploymentBranch}`));
+        const toPath = await fs_1.fs.mkdtemp(node_path_1.default.join(node_os_1.default.tmpdir(), `${projectName}-${deploymentBranch}`));
         process.chdir(toPath);
         // Clones the repo into the temp folder and checks out the target branch.
         // If the branch doesn't exist, it creates a new one based on the
@@ -170,7 +169,7 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
         const targetPath = node_path_1.default.join(toPath, targetDirectory);
         try {
             // verbatimSymlinks: keep relative symlinks relative
-            await promises_1.default.cp(fromPath, targetPath, {
+            await fs_1.fs.cp(fromPath, targetPath, {
                 recursive: true,
                 verbatimSymlinks: true,
             });

package/lib/commands/swizzle/actions.js

@@ -11,7 +11,6 @@ exports.getAction = getAction;
 exports.eject = eject;
 exports.wrap = wrap;
 const tslib_1 = require("tslib");
-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"));
@@ -30,7 +29,7 @@ async function getAction(componentConfig, options) {
     return (0, prompts_1.askSwizzleAction)(componentConfig);
 }
 async function isDir(dirPath) {
-    return (await (0, fs_1.pathExists)(dirPath)) && (await promises_1.default.stat(dirPath)).isDirectory();
+    return (await (0, fs_1.pathExists)(dirPath)) && (await fs_1.fs.stat(dirPath)).isDirectory();
 }
 async function eject({ siteDir, themePath, componentName, typescript, }) {
     const fromPath = node_path_1.default.join(themePath, componentName);
@@ -59,11 +58,11 @@ async function eject({ siteDir, themePath, componentName, typescript, }) {
         throw new Error(logger_1.default.interpolate `No files to copy from path=${fromPath} with glob code=${globPatternPosix}`);
     }
     const toPath = node_path_1.default.join(siteDir, utils_1.THEME_PATH);
-    await promises_1.default.mkdir(toPath, { recursive: true });
+    await fs_1.fs.mkdir(toPath, { recursive: true });
     const createdFiles = await Promise.all(filesToCopy.map(async (sourceFile) => {
         const targetFile = node_path_1.default.join(toPath, node_path_1.default.relative(themePath, sourceFile));
         try {
-            const fileContents = await promises_1.default.readFile(sourceFile, 'utf-8');
+            const fileContents = await fs_1.fs.readFile(sourceFile, 'utf-8');
             await (0, fs_1.outputFile)(targetFile, fileContents.trimStart().replace(/^\/\*.+?\*\/\s*/ms, ''));
         }
         catch (err) {
@@ -80,7 +79,7 @@ async function wrap({ siteDir, themePath, componentName: themeComponentName, typ
     const componentName = lodash_1.default.last(themeComponentName.split('/'));
     const wrapperComponentName = `${componentName}Wrapper`;
     const wrapperFileName = `${themeComponentName}${isDirectory ? '/index' : ''}${typescript ? '.tsx' : '.js'}`;
-    await promises_1.default.mkdir(node_path_1.default.resolve(siteDir, utils_1.THEME_PATH), { recursive: true });
+    await fs_1.fs.mkdir(node_path_1.default.resolve(siteDir, utils_1.THEME_PATH), { recursive: true });
     const toPath = node_path_1.default.resolve(siteDir, utils_1.THEME_PATH, wrapperFileName);
     const content = typescript
         ? `import type {ReactNode} from 'react';

package/lib/commands/swizzle/components.js

@@ -11,7 +11,6 @@ exports.readComponentNames = readComponentNames;
 exports.getThemeComponents = getThemeComponents;
 exports.getComponentName = getComponentName;
 const tslib_1 = require("tslib");
-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"));
@@ -47,9 +46,9 @@ async function readComponentNames(themePath) {
         return [];
     }
     async function walk(dir) {
-        const files = await Promise.all((await promises_1.default.readdir(dir)).flatMap(async (file) => {
+        const files = await Promise.all((await fs_1.fs.readdir(dir)).flatMap(async (file) => {
             const fullPath = node_path_1.default.join(dir, file);
-            const stat = await promises_1.default.stat(fullPath);
+            const stat = await fs_1.fs.stat(fullPath);
             const isDir = stat.isDirectory();
             return { file, fullPath, isDir };
         }));

package/lib/commands/utils/clearPath.js

@@ -9,13 +9,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = clearPath;
 const tslib_1 = require("tslib");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const promises_1 = require("node:fs/promises");
 const logger_1 = require("@docusaurus/logger");
+const fs_1 = require("@docusaurus/fs");
 /**
  * @param pathToClear
  */
 async function clearPath(pathToClear) {
     return logger_1.PerfLogger.async(`clearPath ${node_path_1.default.relative(process.cwd(), pathToClear)}`, async () => {
-        await (0, promises_1.rm)(pathToClear, { recursive: true, force: true });
+        await fs_1.fs.rm(pathToClear, { recursive: true, force: true });
     });
 }

package/lib/commands/writeHeadingIds.js

@@ -8,7 +8,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.writeHeadingIds = writeHeadingIds;
 const tslib_1 = require("tslib");
-const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const glob_1 = require("@docusaurus/glob");
@@ -28,14 +27,14 @@ function getHeadingIdSyntax(filepath, options) {
     return options?.syntax ?? inferFallbackSyntax(filepath);
 }
 async function transformMarkdownFile(filepath, options) {
-    const content = await promises_1.default.readFile(filepath, 'utf8');
+    const content = await fs_1.fs.readFile(filepath, 'utf8');
     const syntax = getHeadingIdSyntax(filepath, options);
     const updatedContent = (0, utils_1.writeMarkdownHeadingId)(content, {
         ...options,
         syntax,
     });
     if (content !== updatedContent) {
-        await promises_1.default.writeFile(filepath, updatedContent);
+        await fs_1.fs.writeFile(filepath, updatedContent);
         return filepath;
     }
     return undefined;
@@ -74,7 +73,7 @@ async function writeHeadingIds(siteDirParam = '.', files = [], options = {}) {
         logger_1.default.warn `No markdown files found in siteDir path=${siteDir} for patterns: ${patterns}`;
         return;
     }
-    const result = await Promise.all(markdownFiles.map((p) => (0, fs_1.queueFileOperation)(() => transformMarkdownFile(p, options))));
+    const result = await Promise.all(markdownFiles.map((p) => transformMarkdownFile(p, options)));
     const pathsModified = result.filter(Boolean);
     if (pathsModified.length) {
         logger_1.default.success `Heading ids added to Markdown files (number=${`${pathsModified.length}/${markdownFiles.length}`} files): ${pathsModified}`;

package/lib/server/siteMetadata.js

@@ -10,7 +10,6 @@ exports.tryLoadSitePackageJson = tryLoadSitePackageJson;
 exports.loadPluginVersion = loadPluginVersion;
 exports.createSiteMetadata = createSiteMetadata;
 const tslib_1 = require("tslib");
-const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const utils_1 = require("@docusaurus/utils");
 const fs_1 = require("@docusaurus/fs");
@@ -35,7 +34,7 @@ async function loadPluginVersion(pluginPath, siteDir) {
     while (potentialPluginPackageJsonDirectory !== '/') {
         const packageJsonPath = node_path_1.default.join(potentialPluginPackageJsonDirectory, 'package.json');
         if ((await (0, fs_1.pathExists)(packageJsonPath)) &&
-            (await promises_1.default.lstat(packageJsonPath)).isFile()) {
+            (await fs_1.fs.lstat(packageJsonPath)).isFile()) {
             if (potentialPluginPackageJsonDirectory === siteDir) {
                 // If the plugin belongs to the same docusaurus project, we classify it
                 // as local plugin.

package/lib/ssg/ssgRenderer.js

@@ -11,10 +11,10 @@ const tslib_1 = require("tslib");
 const node_module_1 = require("node:module");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const node_vm_1 = require("node:vm");
-const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
 const p_map_1 = tslib_1.__importDefault(require("p-map"));
 const logger_1 = tslib_1.__importStar(require("@docusaurus/logger"));
 const bundler_1 = require("@docusaurus/bundler");
+const fs_1 = require("@docusaurus/fs");
 const ssgTemplate_1 = require("./ssgTemplate");
 const ssgEnv_1 = require("./ssgEnv");
 const ssgUtils_1 = require("./ssgUtils");
@@ -29,7 +29,7 @@ function evaluateServerBundle({ source, serverBundlePath, }) {
     return module.exports;
 }
 async function loadAppRenderer({ serverBundlePath, }) {
-    const source = await logger_1.PerfLogger.async(`Load server bundle`, () => promises_1.default.readFile(serverBundlePath, 'utf8'));
+    const source = await logger_1.PerfLogger.async(`Load server bundle`, () => fs_1.fs.readFile(serverBundlePath, 'utf8'));
     const serverEntry = await logger_1.PerfLogger.async(`Evaluate server bundle`, () => evaluateServerBundle({ source, serverBundlePath }));
     if (!serverEntry?.default || typeof serverEntry.default !== 'function') {
         throw new Error(`Docusaurus Bug: server bundle export from "${serverBundlePath}" must be a function that renders the Docusaurus React app, not ${typeof serverEntry?.default}`);

package/lib/ssg/ssgUtils.js

@@ -9,8 +9,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateHashRouterEntrypoint = generateHashRouterEntrypoint;
 exports.writeStaticFile = writeStaticFile;
 const tslib_1 = require("tslib");
-const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const fs_1 = require("@docusaurus/fs");
 function pathnameToFilename({ pathname, trailingSlash, }) {
     const outputFileName = pathname.replace(/^[/\\]/, ''); // Remove leading slashes for webpack-dev-server
     // Paths ending with .html are left untouched
@@ -44,6 +44,6 @@ async function writeStaticFile({ content, pathname, params, }) {
         trailingSlash: params.trailingSlash,
     });
     const filePath = node_path_1.default.join(params.outDir, filename);
-    await promises_1.default.mkdir(node_path_1.default.dirname(filePath), { recursive: true });
-    await promises_1.default.writeFile(filePath, content);
+    await fs_1.fs.mkdir(node_path_1.default.dirname(filePath), { recursive: true });
+    await fs_1.fs.writeFile(filePath, content);
 }

package/lib/webpack/aliases/index.js

@@ -11,7 +11,6 @@ exports.createAliasesForTheme = createAliasesForTheme;
 exports.loadThemeAliases = loadThemeAliases;
 exports.loadDocusaurusAliases = loadDocusaurusAliases;
 const tslib_1 = require("tslib");
-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 utils_1 = require("@docusaurus/utils");
@@ -103,7 +102,7 @@ async function loadDocusaurusAliases() {
     const dirPath = node_path_1.default.resolve(__dirname, '../../client/exports');
     const extensions = ['.js', '.ts', '.tsx'];
     const aliases = {};
-    (await promises_1.default.readdir(dirPath))
+    (await fs_1.fs.readdir(dirPath))
         .filter((fileName) => extensions.includes(node_path_1.default.extname(fileName)))
         .forEach((fileName) => {
         const fileNameWithoutExtension = node_path_1.default.basename(fileName, node_path_1.default.extname(fileName));

package/lib/webpack/plugins/BundlerCPUProfilerPlugin.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BundlerCPUProfilerPlugin = void 0;
 const tslib_1 = require("tslib");
 const node_inspector_1 = tslib_1.__importDefault(require("node:inspector"));
-const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
+const fs_1 = require("@docusaurus/fs");
 // Bundle CPU profiling plugin, contributed by the Rspack team
 // Can be opened in https://www.speedscope.app/
 // See also https://github.com/jerrykingxyz/docusaurus/pull/1
@@ -33,7 +33,7 @@ class BundlerCPUProfilerPlugin {
                     console.error('Failed to generate JS CPU profile:', error);
                     return;
                 }
-                promises_1.default.writeFile(this.output, JSON.stringify(param.profile)).catch(console.error);
+                fs_1.fs.writeFile(this.output, JSON.stringify(param.profile)).catch(console.error);
             });
         });
     }

package/lib/webpack/plugins/StaticDirectoriesCopyPlugin.js

@@ -9,7 +9,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createStaticDirectoriesCopyPlugin = createStaticDirectoriesCopyPlugin;
 const tslib_1 = require("tslib");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
 const bundler_1 = require("@docusaurus/bundler");
 const fs_1 = require("@docusaurus/fs");
 async function createStaticDirectoriesCopyPlugin({ props, }) {
@@ -24,7 +23,7 @@ async function createStaticDirectoriesCopyPlugin({ props, }) {
     const staticDirectories = (await Promise.all(staticDirectoriesOption.map(async (dir) => {
         const staticDir = node_path_1.default.resolve(siteDir, dir);
         if ((await (0, fs_1.pathExists)(staticDir)) &&
-            (await promises_1.default.readdir(staticDir)).length > 0) {
+            (await fs_1.fs.readdir(staticDir)).length > 0) {
             return staticDir;
         }
         return '';

package/lib/webpack/utils/getHttpsConfig.js

@@ -8,7 +8,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = getHttpsConfig;
 const tslib_1 = require("tslib");
-const promises_1 = tslib_1.__importDefault(require("node:fs/promises"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const node_crypto_1 = tslib_1.__importDefault(require("node:crypto"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
@@ -55,7 +54,7 @@ async function readCryptoFile(filepath, source) {
         return {
             path: filepath,
             source,
-            content: await promises_1.default.readFile(filepath),
+            content: await fs_1.fs.readFile(filepath),
         };
     }
     catch (error) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "4.0.0-canary-6888",
+  "version": "4.0.0-canary-6892",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -24,24 +24,24 @@
     "docusaurus": "bin/docusaurus.mjs"
   },
   "scripts": {
-    "build": "tsc --build && node ../../admin/scripts/copyUntypedFiles.js",
+    "build": "tsc --build && copy-untyped-files",
     "watch": "run-p -c copy:watch build:watch",
     "build:watch": "tsc --build --watch",
-    "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
+    "copy:watch": "copy-untyped-files --watch"
   },
   "bugs": {
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "4.0.0-canary-6888",
-    "@docusaurus/bundler": "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/utils": "4.0.0-canary-6888",
-    "@docusaurus/utils-common": "4.0.0-canary-6888",
-    "@docusaurus/utils-validation": "4.0.0-canary-6888",
+    "@docusaurus/babel": "4.0.0-canary-6892",
+    "@docusaurus/bundler": "4.0.0-canary-6892",
+    "@docusaurus/fs": "4.0.0-canary-6892",
+    "@docusaurus/glob": "4.0.0-canary-6892",
+    "@docusaurus/logger": "4.0.0-canary-6892",
+    "@docusaurus/mdx-loader": "4.0.0-canary-6892",
+    "@docusaurus/utils": "4.0.0-canary-6892",
+    "@docusaurus/utils-common": "4.0.0-canary-6892",
+    "@docusaurus/utils-validation": "4.0.0-canary-6892",
     "boxen": "^9.0.0",
     "cli-table3": "^0.6.5",
     "combine-promises": "^1.2.0",
@@ -72,8 +72,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "4.0.0-canary-6888",
-    "@docusaurus/types": "4.0.0-canary-6888",
+    "@docusaurus/module-type-aliases": "4.0.0-canary-6892",
+    "@docusaurus/types": "4.0.0-canary-6892",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/escape-html": "^1.0.4",
     "@types/history": "^4.7.11",
@@ -87,7 +87,7 @@
     "utility-types": "^3.11.0"
   },
   "peerDependencies": {
-    "@docusaurus/faster": "4.0.0-canary-6888",
+    "@docusaurus/faster": "4.0.0-canary-6892",
     "@mdx-js/react": "^3.1.1",
     "react": "^19.3.0",
     "react-dom": "^19.3.0"
@@ -100,5 +100,5 @@
   "engines": {
     "node": ">=24.21"
   },
-  "gitHead": "5019a662590dcb2722926890c1ade27194bc3b70"
+  "gitHead": "a28eee9700a9a7eab87344e7144546bfd0b57961"
 }