perf: 移除子进程重启的代码，将文件操作改为异步，并加锁

Author: edwinhuish

packages/core/package.json

@@ -59,6 +59,7 @@
   "dependencies": {
     "@babel/generator": "^7.28.3",
     "@babel/types": "^7.28.2",
+    "@types/proper-lockfile": "^4.1.4",
     "@uni-helper/uni-env": "^0.1.4",
     "@vue/compiler-sfc": "3.4.21",
     "ast-kit": "1.4.3",
@@ -72,6 +73,7 @@
     "kolorist": "^1.8.0",
     "lodash.groupby": "^4.6.0",
     "magic-string": "^0.30.11",
+    "proper-lockfile": "^4.1.2",
     "typescript": "5.9.2",
     "unconfig": "^7.3.2",
     "yaml": "^2.5.0"

packages/core/src/context.ts

@@ -3,6 +3,7 @@ import type { Logger, ViteDevServer } from 'vite'
 import type { TabBar, TabBarItem } from './config'
 import type { PagesConfig } from './config/types'
 import type { PageMetaDatum, PagePath, ResolvedOptions, SubPageMetaDatum, UserOptions } from './types'
+import fs from 'node:fs'
 import path from 'node:path'
 import process from 'node:process'
 import { slash } from '@antfu/utils'
@@ -11,11 +12,12 @@ import { stringify as cjStringify } from 'comment-json'
 import dbg from 'debug'
 import detectIndent from 'detect-indent'
 import detectNewline from 'detect-newline'
-import { loadConfig } from 'unconfig'
+import lockfile from 'proper-lockfile'
 
+import { loadConfig } from 'unconfig'
 import { OUTPUT_NAME } from './constant'
 import { writeDeclaration } from './declaration'
-import { checkPagesJsonFile, getPageFiles, readFileSync, writeFileSync } from './files'
+import { checkPagesJsonFile, getPageFiles } from './files'
 import { resolveOptions } from './options'
 import { Page } from './page'
 import {
@@ -39,9 +41,9 @@ export class PageContext {
   subPageMetaData: SubPageMetaDatum[] = []
 
   resolvedPagesJSONPath = ''
-  resolvedPagesJSONIndent = '  '
-  resolvedPagesJSONNewline = '\n'
-  resolvedPagesJSONEofNewline = true
+  private resolvedPagesJSONIndent?: string // '  '
+  private resolvedPagesJSONNewline?: string // '\n'
+  private resolvedPagesJSONEofNewline?: boolean // true
 
   rawOptions: UserOptions
   root: string
@@ -63,10 +65,6 @@ export class PageContext {
       dbg.enable(`${prefix}${suffix}`)
     }
     this.resolvedPagesJSONPath = path.join(this.root, this.options.outDir, OUTPUT_NAME)
-    const resolvedPagesJSONContent = readFileSync(this.resolvedPagesJSONPath)
-    this.resolvedPagesJSONIndent = detectIndent(resolvedPagesJSONContent).indent || '  '
-    this.resolvedPagesJSONNewline = detectNewline(resolvedPagesJSONContent) || '\n'
-    this.resolvedPagesJSONEofNewline = (resolvedPagesJSONContent.at(-1) ?? '\n') === this.resolvedPagesJSONNewline
     debug.options(this.options)
   }
 
@@ -337,7 +335,7 @@ export class PageContext {
       }
     }
 
-    checkPagesJsonFile(this.resolvedPagesJSONPath)
+    await checkPagesJsonFile(this.resolvedPagesJSONPath)
     this.options.onBeforeLoadUserConfig(this)
     await this.loadUserPagesConfig()
     this.options.onAfterLoadUserConfig(this)
@@ -376,17 +374,26 @@ export class PageContext {
     const pagesJson = cjStringify(
       data,
       null,
-      this.options.minify ? undefined : this.resolvedPagesJSONIndent,
+      this.options.minify ? undefined : await this.getIndent(),
     ) + (
-      this.resolvedPagesJSONEofNewline ? this.resolvedPagesJSONNewline : ''
+      await this.getEndOfLine() ? await this.getNewline() : ''
     )
     this.generateDeclaration()
     if (lsatPagesJson === pagesJson) {
       debug.pages('PagesJson Not have change')
       return false
     }
 
-    writeFileSync(this.resolvedPagesJSONPath, pagesJson)
+    // 获取文件锁，如果文件不存在则创建
+    const relase = await lockfile.lock(this.resolvedPagesJSONPath, { realpath: false })
+
+    try {
+      await fs.promises.writeFile(this.resolvedPagesJSONPath, pagesJson, { encoding: 'utf-8' }) // 执行写入操作
+    }
+    finally {
+      await relase() // 释放文件锁
+    }
+
     lsatPagesJson = pagesJson
 
     this.options.onAfterWriteFile(this)
@@ -414,6 +421,37 @@ export class PageContext {
     debug.declaration('generating')
     return writeDeclaration(this, this.options.dts)
   }
+
+  private async readInfoFromPagesJSON(): Promise<void> {
+    const resolvedPagesJSONContent = await fs.promises.readFile(this.resolvedPagesJSONPath, { encoding: 'utf-8' }).catch(() => '')
+    this.resolvedPagesJSONIndent = detectIndent(resolvedPagesJSONContent).indent || '  '
+    this.resolvedPagesJSONNewline = detectNewline(resolvedPagesJSONContent) || '\n'
+    this.resolvedPagesJSONEofNewline = (resolvedPagesJSONContent.at(-1) ?? '\n') === this.resolvedPagesJSONNewline
+  }
+
+  private async getIndent() {
+    if (!this.resolvedPagesJSONIndent) {
+      await this.readInfoFromPagesJSON()
+    }
+
+    return this.resolvedPagesJSONIndent!
+  }
+
+  private async getNewline() {
+    if (!this.resolvedPagesJSONNewline) {
+      await this.readInfoFromPagesJSON()
+    }
+
+    return this.resolvedPagesJSONNewline!
+  }
+
+  private async getEndOfLine() {
+    if (!this.resolvedPagesJSONEofNewline) {
+      await this.readInfoFromPagesJSON()
+    }
+
+    return this.resolvedPagesJSONEofNewline!
+  }
 }
 
 function getPagePaths(dir: string, options: ResolvedOptions) {

packages/core/src/files.ts

@@ -1,6 +1,5 @@
 import type { ResolvedOptions } from './types'
 import fs from 'node:fs'
-import { stringify as cjStringify } from 'comment-json'
 import fg from 'fast-glob'
 
 import { FILE_EXTENSIONS } from './constant'
@@ -23,23 +22,46 @@ export function getPageFiles(path: string, options: ResolvedOptions): string[] {
   return files
 }
 
-export function checkPagesJsonFile(path: string) {
-  if (!fs.existsSync(path)) {
-    writeFileSync(path, cjStringify({ pages: [{ path: '' }] }, null, 2))
-    return false
+/**
+ * 检查指定路径的pages.json文件，如果文件不存在或不是有效文件则创建一个空的pages.json文件
+ * @param path - 要检查的文件路径
+ * @returns Promise<void> - 无返回值的异步函数
+ */
+export async function checkPagesJsonFile(path: fs.PathLike): Promise<boolean> {
+  const createEmptyFile = (path: fs.PathLike) => {
+    return fs.promises.writeFile(path, JSON.stringify({ pages: [{ path: '' }] }, null, 2), { encoding: 'utf-8' }).then(() => true).catch(() => false)
+  }
+
+  const unlink = (path: fs.PathLike) => {
+    return fs.promises.unlink(path).then(() => true).catch(() => false)
   }
-  return true
-}
 
-export function readFileSync(path: string) {
   try {
-    return fs.readFileSync(path, { encoding: 'utf-8' })
+    const stat = await fs.promises.stat(path)
+
+    if (!stat.isFile()) {
+      // 不是文件，尝试删除
+      if (!await unlink(path)) {
+        return false
+      }
+
+      return createEmptyFile(path) // 创建空文件
+    }
+    // 是文件
+
+    const access = await fs.promises.access(path, fs.constants.W_OK | fs.constants.R_OK).then(() => true).catch(() => false)
+    if (!access) {
+      // 无权限，尝试删除
+      if (!await unlink(path)) {
+        return false
+      }
+
+      return createEmptyFile(path) // 创建空文件
+    }
+    return true
   }
   catch {
-    return ''
+    // stat 出错，证明没此文件
+    return createEmptyFile(path) // 创建空文件
   }
 }
-
-export function writeFileSync(path: string, content: string) {
-  fs.writeFileSync(path, content, { encoding: 'utf-8' })
-}

packages/core/src/index.ts

@@ -1,7 +1,6 @@
 import type { CallExpression } from '@babel/types'
 import type { Plugin } from 'vite'
 import type { UserOptions } from './types'
-import { spawn } from 'node:child_process'
 import path from 'node:path'
 import process from 'node:process'
 import { babelParse } from 'ast-kit'
@@ -29,22 +28,7 @@ export * from './page'
 export * from './types'
 export * from './utils'
 
-async function restart() {
-  return new Promise((resolve) => {
-    const build = spawn(process.argv.shift()!, process.argv, {
-      cwd: process.env.VITE_ROOT_DIR || process.cwd(),
-      detached: true,
-      env: process.env,
-    })
-    build.stdout?.pipe(process.stdout)
-    build.stderr?.pipe(process.stderr)
-    build.on('close', (code) => {
-      resolve(process.exit(code!))
-    })
-  })
-}
-
-export function VitePluginUniPages(userOptions: UserOptions = {}): Plugin {
+export async function VitePluginUniPages(userOptions: UserOptions = {}): Promise<Plugin> {
   let ctx: PageContext
 
   // TODO: check if the pages.json file is valid
@@ -53,7 +37,7 @@ export function VitePluginUniPages(userOptions: UserOptions = {}): Plugin {
     userOptions.outDir ?? 'src',
     OUTPUT_NAME,
   )
-  const isValidated = checkPagesJsonFile(resolvedPagesJSONPath)
+  await checkPagesJsonFile(resolvedPagesJSONPath)
 
   return {
     name: 'vite-plugin-uni-pages',
@@ -71,13 +55,6 @@ export function VitePluginUniPages(userOptions: UserOptions = {}): Plugin {
       await ctx.updatePagesJSON()
 
       if (config.command === 'build') {
-        if (!isValidated) {
-          ctx.logger?.warn('In build mode, if `pages.json` does not exist, the plugin cannot create the complete `pages.json` before the uni-app, so it restarts the build.', {
-            timestamp: true,
-          })
-          await restart()
-        }
-
         if (config.build.watch)
           ctx.setupWatcher(chokidar.watch([...ctx.options.dirs, ...ctx.options.subPackages]))
       }

packages/core/src/page.ts

@@ -2,7 +2,7 @@ import type { SFCDescriptor, SFCParseOptions } from '@vue/compiler-sfc'
 import type { TabBarItem } from './config'
 import type { PageContext } from './context'
 import type { PageMetaDatum, PagePath, RouteBlockLang, UserPageMeta } from './types'
-import { readFileSync } from 'node:fs'
+import fs from 'node:fs'
 import { extname } from 'node:path'
 import * as t from '@babel/types'
 import { parse as VueParser } from '@vue/compiler-sfc'
@@ -89,7 +89,7 @@ export class Page {
 
   private async readPageMetaFromFile(): Promise<UserPageMeta> {
     try {
-      const content = readFileSync(this.path.absolutePath, 'utf-8')
+      const content = await fs.promises.readFile(this.path.absolutePath, { encoding: 'utf-8' })
       const sfc = parseSFC(content, { filename: this.path.absolutePath })
 
       const meta = await tryPageMetaFromMacro(sfc)