refactor: remove fs-extra in @rspress/shared (#1805)

Author: SoonIter

e2e/tests/public-dir.test.ts

@@ -1,32 +1,41 @@
+import { access, readFile } from 'node:fs/promises';
 import path from 'node:path';
 import { expect, test } from '@playwright/test';
-import { exists, readFile } from 'fs-extra';
 import { runBuildCommand } from '../utils/runCommands';
 
 const fixtureDir = path.resolve(__dirname, '../fixtures');
 
+async function pathExists(path: string): Promise<boolean> {
+  try {
+    await access(path);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
 test.describe('basic test', async () => {
   test('should not generate the routes for html/js/mdx files in publicDir', async () => {
     const appDir = path.join(fixtureDir, 'public-dir');
     await runBuildCommand(appDir);
 
-    const existsImg = exists(
+    const existsImg = pathExists(
       path.resolve(appDir, 'doc_build', 'rspress-icon.png'),
     );
     expect(existsImg).toBeTruthy();
 
-    const existsTestHtml = await exists(
+    const existsTestHtml = await pathExists(
       path.resolve(appDir, 'doc_build', 'test.html'),
     );
     expect(existsTestHtml).toBeTruthy();
 
     const testJsPath = path.resolve(appDir, 'doc_build', 'test.js');
-    const existsTestJs = await exists(testJsPath);
+    const existsTestJs = await pathExists(testJsPath);
     const testJsRaw = await readFile(testJsPath, 'utf-8');
     expect(existsTestJs).toBeTruthy();
     expect(testJsRaw.startsWith("console.log('test.js');")).toBeTruthy();
 
-    const existsTestMDX = await exists(
+    const existsTestMDX = await pathExists(
       path.resolve(appDir, 'doc_build', 'test.mdx'),
     );
     expect(existsTestMDX).toBeTruthy();

e2e/tests/title-suffix.test.ts

@@ -1,6 +1,6 @@
+import { readFileSync } from 'node:fs';
 import path from 'node:path';
 import { expect, test } from '@playwright/test';
-import { readFileSync } from 'fs-extra';
 import { runBuildCommand } from '../utils/runCommands';
 
 const appDir = path.resolve(__dirname, '../fixtures/title-suffix');

package.json

@@ -38,13 +38,11 @@
     "@modern-js/tsconfig": "2.64.0",
     "@playwright/test": "1.47.2",
     "@types/cross-spawn": "^6.0.6",
-    "@types/fs-extra": "11.0.4",
     "@types/node": "^18.11.17",
     "check-dependency-version-consistency": "^5.0.0",
     "cross-env": "^7.0.3",
     "cross-spawn": "^7.0.6",
     "cspell-ban-words": "^0.0.4",
-    "fs-extra": "11.3.0",
     "get-port": "5.1.1",
     "heading-case": "^0.1.4",
     "husky": "^9.1.7",

packages/cli/src/update.ts

@@ -1,9 +1,17 @@
 import { spawn } from 'node:child_process';
 import fs from 'node:fs/promises';
 import path from 'node:path';
-import fse from '@rspress/shared/fs-extra';
 import { logger } from '@rspress/shared/logger';
 
+async function pathExists(path: string): Promise<boolean> {
+  try {
+    await fs.access(path);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
 type PackageManager = 'npm' | 'yarn' | 'pnpm' | 'bun';
 
 const lockfileMap: Record<string, PackageManager> = {
@@ -16,7 +24,7 @@ const lockfileMap: Record<string, PackageManager> = {
 async function getPackageManager(rootPath: string) {
   let packageManager: PackageManager = 'npm';
   for (const file of Object.keys(lockfileMap)) {
-    if (await fse.pathExists(path.join(rootPath, file))) {
+    if (await pathExists(path.join(rootPath, file))) {
       packageManager = lockfileMap[file];
       break;
     }

packages/core/src/node/build.ts

@@ -1,3 +1,4 @@
+import fs from 'node:fs/promises';
 import { dirname, join } from 'node:path';
 import { pathToFileURL } from 'node:url';
 import type { Route } from '@/node/route/RouteService';
@@ -11,7 +12,6 @@ import {
   withBase,
 } from '@rspress/shared';
 import chalk from '@rspress/shared/chalk';
-import fs from '@rspress/shared/fs-extra';
 import { logger } from '@rspress/shared/logger';
 import type { HelmetData } from 'react-helmet-async';
 import { PluginDriver } from './PluginDriver';
@@ -50,13 +50,18 @@ export async function bundle(
       pluginDriver,
       enableSSG,
     );
+
     await rsbuild.build();
   } finally {
     await writeSearchIndex(config);
     await checkLanguageParity(config);
   }
 }
 
+function emptyDir(path: string): Promise<void> {
+  return fs.rm(path, { force: true, recursive: true });
+}
+
 export interface SSRBundleExports {
   render: (
     url: string,
@@ -77,7 +82,6 @@ export async function renderPages(
   const ssrBundlePath = join(outputPath, 'ssr', 'main.cjs');
 
   try {
-    const { default: fs } = await import('@rspress/shared/fs-extra');
     const { version } = await import('../../package.json');
     // There are two cases where we will fallback to CSR:
     // 1. ssr bundle load failed
@@ -204,15 +208,17 @@ export async function renderPages(
             return `${path}.html`.replace(normalizedBase, '');
           };
           const fileName = normalizeHtmlFilePath(routePath);
-          await fs.ensureDir(join(outputPath, dirname(fileName)));
+          await fs.mkdir(join(outputPath, dirname(fileName)), {
+            recursive: true,
+          });
           await fs.writeFile(join(outputPath, fileName), html);
         }),
     );
     // Remove ssr bundle
     if (!isDebugMode()) {
-      await fs.remove(join(outputPath, 'ssr'));
+      await emptyDir(join(outputPath, 'ssr'));
     }
-    await fs.remove(join(outputPath, 'html'));
+    await emptyDir(join(outputPath, 'html'));
 
     const totalTime = Date.now() - startTime;
     logger.success(`Pages rendered in ${chalk.yellow(totalTime)} ms.`);
@@ -227,13 +233,15 @@ export async function build(options: BuildOptions) {
   const pluginDriver = new PluginDriver(config, true);
   await pluginDriver.init();
   const modifiedConfig = await pluginDriver.modifyConfig();
+
   await pluginDriver.beforeBuild();
   const ssgConfig = modifiedConfig.ssg ?? true;
 
   // empty temp dir before build
-  await fs.emptyDir(TEMP_DIR);
+  await emptyDir(TEMP_DIR);
 
   await bundle(docDirectory, modifiedConfig, pluginDriver, Boolean(ssgConfig));
+
   await renderPages(appDirectory, modifiedConfig, pluginDriver, ssgConfig);
   await pluginDriver.afterBuild();
 }

packages/core/src/node/dev.ts

@@ -27,7 +27,6 @@ export async function dev(options: DevOptions): Promise<ServerInstance> {
     await pluginDriver.beforeBuild();
 
     // empty temp dir before build
-    // await fs.emptyDir( TEMP_DIR);
     const builder = await initRsbuild(
       docDirectory,
       modifiedConfig,

packages/core/src/node/initRsbuild.ts

@@ -1,3 +1,4 @@
+import fs from 'node:fs/promises';
 import path from 'node:path';
 import type {
   RsbuildConfig,
@@ -15,7 +16,6 @@ import {
   removeLeadingSlash,
   removeTrailingSlash,
 } from '@rspress/shared';
-import fs from '@rspress/shared/fs-extra';
 import type { PluginDriver } from './PluginDriver';
 import {
   CLIENT_ENTRY,
@@ -321,7 +321,7 @@ export async function initRsbuild(
   // and we should empty temp dir before build
   const runtimeTempDir = path.join(RSPRESS_TEMP_DIR, 'runtime');
   const runtimeAbsTempDir = path.join(cwd, 'node_modules', runtimeTempDir);
-  await fs.ensureDir(runtimeAbsTempDir);
+  await fs.mkdir(runtimeAbsTempDir, { recursive: true });
 
   const routeService = await initRouteService({
     config,

packages/core/src/node/mdx/loader.ts

@@ -1,8 +1,8 @@
+import fs from 'node:fs/promises';
 import path from 'node:path';
 import { pathToFileURL } from 'node:url';
 import { createProcessor } from '@mdx-js/mdx';
 import { isProduction } from '@rspress/shared';
-import fs from '@rspress/shared/fs-extra';
 import { logger } from '@rspress/shared/logger';
 import { loadFrontMatter } from '@rspress/shared/node-utils';
 import type { PluginDriver } from '../PluginDriver';

packages/core/src/node/route/RouteService.ts

@@ -1,3 +1,4 @@
+import fs from 'node:fs/promises';
 import path from 'node:path';
 import {
   type PageModule,
@@ -7,7 +8,6 @@ import {
   addTrailingSlash,
   withBase,
 } from '@rspress/shared';
-import fs from '@rspress/shared/fs-extra';
 import type { ComponentType } from 'react';
 import { glob } from 'tinyglobby';
 import type { PluginDriver } from '../PluginDriver';

packages/core/src/node/runtimeModule/globalStyles.ts

@@ -1,4 +1,4 @@
-import fs from '@rspress/shared/fs-extra';
+import fs from 'node:fs/promises';
 import { type FactoryContext, RuntimeModuleID } from '.';
 
 export async function globalStylesVMPlugin(context: FactoryContext) {