@uni-helper/vite-plugin-uni-pages 0.4.3 → 0.4.6

package/README.md

@@ -246,6 +246,19 @@ export default defineConfig({
 
 更多上下文参考 <https://github.com/uni-helper/vite-plugin-uni-pages/issues/271>。
 
+## 多终端并发开发
+
+同一项目里同时运行到多个平台时（例如，两个终端分别运行 `pnpm run dev:mp-weixin` 和 `pnpm run dev:mp-alipay`），多个进程会读写同一个 `pages.json`。
+
+本插件默认会：
+
+- 通过文件锁串行化对 `pages.json` 的「读取已有内容 → 合并当前平台配置 → 写回」整个流程，避免并发写入互相覆盖；
+- 保留其他平台已经写入的条件编译块（`#ifdef H5` / `#ifndef MP-WEIXIN` 等），只更新当前平台对应的条目。
+
+这样每个终端都能保留各自的平台配置。条件编译注释基于 `comment-json` 写入，最终 `pages.json` 同时包含所有平台的分支。
+
+> 注意：每个终端只生成「当前平台」的条目并合并到 `pages.json`，并不会主动列出所有平台。`pages.json` 里出现哪些平台的条件编译块，取决于哪些终端正在运行、以及历史写入过的内容。若需要在单次构建中就输出全部平台的条件编译语句，请关注后续基于 [`pages-json`](https://github.com/uni-ku/pages-json) 条件编译的方案。
+
 ## 感谢
 
 - [hannoeru/vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages)

package/dist/index.cjs

@@ -45,12 +45,12 @@ detect_indent = __toESM(detect_indent, 1);
 let detect_newline = require("detect-newline");
 detect_newline = __toESM(detect_newline, 1);
 let unconfig = require("unconfig");
+let write_file_atomic = require("write-file-atomic");
+write_file_atomic = __toESM(write_file_atomic, 1);
 let node_fs_promises = require("node:fs/promises");
 let proper_lockfile = require("proper-lockfile");
 proper_lockfile = __toESM(proper_lockfile, 1);
 let tinyglobby = require("tinyglobby");
-let write_file_atomic = require("write-file-atomic");
-write_file_atomic = __toESM(write_file_atomic, 1);
 let node_module = require("node:module");
 let node_vm = require("node:vm");
 node_vm = __toESM(node_vm, 1);
@@ -316,6 +316,23 @@ function stripType(item) {
 	const { type, ...rest } = item;
 	return rest;
 }
+/**
+* Remove the internal `type` marker (`'home'` / `'page'`) from every element of
+* a `CommentArray` *in place* and return the same array.
+*
+* Unlike `items.map(stripType)`, this preserves the `Symbol.for('before:N')` /
+* `Symbol.for('after:N')` comment slots that `comment-json` attaches to the
+* array, so multi-platform `#ifdef` / `#endif` conditional-compilation blocks
+* survive serialization into pages.json. `.map()` rebuilds the array and drops
+* those symbol-keyed comments.
+*
+* @param items - CommentArray (or plain array) of page/tabBar metadata
+* @returns The same array reference, with `type` removed from each element
+*/
+function stripTypeInPlace(items) {
+	for (const item of items) if (item && "type" in item) delete item.type;
+	return items;
+}
 //#endregion
 //#region src/files.ts
 /**
@@ -383,17 +400,22 @@ function checkPagesJsonFileSync(path) {
 	}
 }
 /**
-* Safely write file using file lock
-* Avoid data corruption caused by concurrent writes through file lock
-* Use atomic write to ensure file write integrity
+* Run a task while holding an exclusive file lock.
 *
-* @param path - File path
-* @param content - File content
+* Unlike {@link writeFileWithLock}, this protects the whole read-modify-write
+* critical section. The lock is held from the moment `task` starts until it
+* resolves, so concurrent processes cannot observe or overwrite a half-written
+* state. This is required by pages.json generation, where the new content
+* depends on the current content (other platforms' `#ifdef` blocks).
+*
+* @param path - File path used as the lock target
+* @param task - Async work to run inside the lock; return value is forwarded
 * @param retry - Number of retries when lock acquisition fails, defaults to 3
+* @returns The value resolved by `task`, or `undefined` if the lock could not be acquired
 */
-async function writeFileWithLock(path, content, retry = 3) {
+async function withFileLock(path, task, retry = 3) {
 	if (retry <= 0) {
-		debug$1.error(`${path} Failed to acquire file lock, write failed`);
+		debug$1.error(`${path} Failed to acquire file lock, task aborted`);
 		return;
 	}
 	let release;
@@ -402,13 +424,31 @@ async function writeFileWithLock(path, content, retry = 3) {
 			release = await proper_lockfile.default.lock(path, { realpath: false });
 		} catch {
 			await sleep(500);
-			return writeFileWithLock(path, content, retry - 1);
+			return withFileLock(path, task, retry - 1);
 		}
-		await (0, write_file_atomic.default)(path, content);
+		return await task();
 	} finally {
 		if (release) await release();
 	}
 }
+/**
+* Safely write file using file lock
+* Avoid data corruption caused by concurrent writes through file lock
+* Use atomic write to ensure file write integrity
+*
+* Note: this only makes the *write* atomic. Callers that need to read the
+* current content before computing the new one must use {@link withFileLock}
+* so the read and write belong to the same critical section.
+*
+* @param path - File path
+* @param content - File content
+* @param retry - Number of retries when lock acquisition fails, defaults to 3
+*/
+async function writeFileWithLock(path, content, retry = 3) {
+	return withFileLock(path, async () => {
+		await (0, write_file_atomic.default)(path, content);
+	}, retry);
+}
 //#endregion
 //#region src/options.ts
 /**
@@ -976,16 +1016,19 @@ var PageContext = class {
 		}) : this.pageMetaData).forEach((v) => pagesMap.set(v.path, v));
 		this.pageMetaData = [...pagesMap.values()];
 		this.options.onBeforeWriteFile(this);
-		const pagesJson = (0, comment_json.stringify)(await this.genratePagesJSON(), null, this.options.minify ? void 0 : await this.getIndent()) + (await this.getEndOfLine() ? await this.getNewline() : "");
+		const updated = await withFileLock(this.resolvedPagesJSONPath, async () => {
+			const pagesJson = (0, comment_json.stringify)(await this.genratePagesJSON(), null, this.options.minify ? void 0 : await this.getIndent()) + (await this.getEndOfLine() ? await this.getNewline() : "");
+			if (this.lastPagesJson === pagesJson) {
+				debug$1.pages("PagesJson Not have change");
+				return false;
+			}
+			await (0, write_file_atomic.default)(this.resolvedPagesJSONPath, pagesJson);
+			this.lastPagesJson = pagesJson;
+			return true;
+		});
 		this.generateDeclaration();
-		if (this.lastPagesJson === pagesJson) {
-			debug$1.pages("PagesJson Not have change");
-			return false;
-		}
-		await writeFileWithLock(this.resolvedPagesJSONPath, pagesJson);
-		this.lastPagesJson = pagesJson;
-		this.options.onAfterWriteFile(this);
-		return true;
+		if (updated) this.options.onAfterWriteFile(this);
+		return updated ?? false;
 	}
 	/**
 	* Generate virtual module content
@@ -1050,7 +1093,7 @@ var PageContext = class {
 		const { pages: oldPages, subPackages: oldSubPackages, tabBar: oldTabBar } = (0, comment_json.parse)(await node_fs.default.promises.readFile(this.resolvedPagesJSONPath, { encoding: "utf-8" }).catch(() => "") || "{}");
 		const { pages: _pages, subPackages: _subPackages, tabBar: _tabBar, ...pageJson } = this.pagesGlobConfig || {};
 		const currentPlatform = _uni_helper_uni_env.platform.toUpperCase();
-		pageJson.pages = mergePlatformItems(oldPages, currentPlatform, this.pageMetaData, "path").map(stripType);
+		pageJson.pages = stripTypeInPlace(mergePlatformItems(oldPages, currentPlatform, this.pageMetaData, "path"));
 		if (pageJson.pages && pageJson.pages.length > 0) {
 			const pagesArray = pageJson.pages;
 			const homeIndex = pagesArray.findIndex((page) => page.type === "home");
@@ -1065,7 +1108,7 @@ var PageContext = class {
 		for (const existing of pageJson.subPackages) {
 			const sub = newSubPackages.get(existing.root);
 			if (sub) {
-				existing.pages = mergePlatformItems(existing.pages, currentPlatform, sub.pages, "path").map(stripType);
+				existing.pages = stripTypeInPlace(mergePlatformItems(existing.pages, currentPlatform, sub.pages, "path"));
 				if (sub.plugins) existing.plugins = sub.plugins;
 				newSubPackages.delete(existing.root);
 			}
@@ -1073,7 +1116,7 @@ var PageContext = class {
 		for (const [_, newSub] of newSubPackages) {
 			const subPackage = {
 				root: newSub.root,
-				pages: mergePlatformItems(void 0, currentPlatform, newSub.pages, "path").map(stripType)
+				pages: stripTypeInPlace(mergePlatformItems(void 0, currentPlatform, newSub.pages, "path"))
 			};
 			if (newSub.plugins) subPackage.plugins = newSub.plugins;
 			pageJson.subPackages.push(subPackage);
@@ -1369,5 +1412,7 @@ exports.resolveOptions = resolveOptions;
 exports.resolvePageDirs = resolvePageDirs;
 exports.sleep = sleep;
 exports.stripType = stripType;
+exports.stripTypeInPlace = stripTypeInPlace;
 exports.tryPageMetaFromMacro = tryPageMetaFromMacro;
+exports.withFileLock = withFileLock;
 exports.writeFileWithLock = writeFileWithLock;

package/dist/index.d.cts

@@ -337,6 +337,20 @@ declare function sleep(ms: number): Promise<unknown>;
 /** Babel code generator for converting AST back to code */
 declare const babelGenerate: typeof babelGenerator;
 declare function stripType<T extends Record<string, unknown>>(item: T): Omit<T, 'type'>;
+/**
+ * Remove the internal `type` marker (`'home'` / `'page'`) from every element of
+ * a `CommentArray` *in place* and return the same array.
+ *
+ * Unlike `items.map(stripType)`, this preserves the `Symbol.for('before:N')` /
+ * `Symbol.for('after:N')` comment slots that `comment-json` attaches to the
+ * array, so multi-platform `#ifdef` / `#endif` conditional-compilation blocks
+ * survive serialization into pages.json. `.map()` rebuilds the array and drops
+ * those symbol-keyed comments.
+ *
+ * @param items - CommentArray (or plain array) of page/tabBar metadata
+ * @returns The same array reference, with `type` removed from each element
+ */
+declare function stripTypeInPlace<T extends Record<string, unknown>>(items: T[]): T[];
 //#endregion
 //#region src/types.d.ts
 /** Debug log type, corresponding to methods in the debug object */
@@ -506,16 +520,35 @@ declare function getPageFiles(path: string, options: ResolvedOptions): string[];
  * @returns boolean - Whether the operation was successful
  */
 declare function checkPagesJsonFileSync(path: fs.PathLike): boolean;
+/**
+ * Run a task while holding an exclusive file lock.
+ *
+ * Unlike {@link writeFileWithLock}, this protects the whole read-modify-write
+ * critical section. The lock is held from the moment `task` starts until it
+ * resolves, so concurrent processes cannot observe or overwrite a half-written
+ * state. This is required by pages.json generation, where the new content
+ * depends on the current content (other platforms' `#ifdef` blocks).
+ *
+ * @param path - File path used as the lock target
+ * @param task - Async work to run inside the lock; return value is forwarded
+ * @param retry - Number of retries when lock acquisition fails, defaults to 3
+ * @returns The value resolved by `task`, or `undefined` if the lock could not be acquired
+ */
+declare function withFileLock<T>(path: string, task: () => Promise<T>, retry?: number): Promise<T | undefined>;
 /**
  * Safely write file using file lock
  * Avoid data corruption caused by concurrent writes through file lock
  * Use atomic write to ensure file write integrity
  *
+ * Note: this only makes the *write* atomic. Callers that need to read the
+ * current content before computing the new one must use {@link withFileLock}
+ * so the read and write belong to the same critical section.
+ *
  * @param path - File path
  * @param content - File content
  * @param retry - Number of retries when lock acquisition fails, defaults to 3
  */
-declare function writeFileWithLock(path: string, content: string, retry?: number): Promise<void>;
+declare function writeFileWithLock(path: string, content: string, retry?: number): Promise<void | undefined>;
 //#endregion
 //#region src/options.d.ts
 /**
@@ -532,7 +565,7 @@ declare function resolveOptions(userOptions: UserOptions, viteRoot?: string): Re
  */
 declare function resolvePageDirs(dir: string, root: string, exclude: string[]): string[];
 declare namespace index_d_exports {
-  export { ConfigSource, DefinePage, ExcludeIndexSignature, FILE_EXTENSIONS, MODULE_ID_VIRTUAL, MaybeCallable, MaybePromise, MaybePromiseCallable, OUTPUT_NAME, Options, Page, PageContext, PageMetaDatum, PagePath, RESOLVED_MODULE_ID_VIRTUAL, ResolvedOptions, SubPackageConfig, SubPageMetaDatum, UserOptions, UserPageMeta, UserTabBarItem, VitePluginUniPages, babelGenerate, checkPagesJsonFileSync, debug, debugType, VitePluginUniPages as default, definePage, defineUniPages, extsToGlob, findImports, findMacro, getPageFiles, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCode, parseSFC, resolveOptions, resolvePageDirs, sleep, stripType, tryPageMetaFromMacro, writeFileWithLock };
+  export { ConfigSource, DefinePage, ExcludeIndexSignature, FILE_EXTENSIONS, MODULE_ID_VIRTUAL, MaybeCallable, MaybePromise, MaybePromiseCallable, OUTPUT_NAME, Options, Page, PageContext, PageMetaDatum, PagePath, RESOLVED_MODULE_ID_VIRTUAL, ResolvedOptions, SubPackageConfig, SubPageMetaDatum, UserOptions, UserPageMeta, UserTabBarItem, VitePluginUniPages, babelGenerate, checkPagesJsonFileSync, debug, debugType, VitePluginUniPages as default, definePage, defineUniPages, extsToGlob, findImports, findMacro, getPageFiles, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCode, parseSFC, resolveOptions, resolvePageDirs, sleep, stripType, stripTypeInPlace, tryPageMetaFromMacro, withFileLock, writeFileWithLock };
 }
 /**
  * vite-plugin-uni-pages plugin main entry
@@ -548,4 +581,4 @@ declare namespace index_d_exports {
  */
 declare function VitePluginUniPages(userOptions?: UserOptions): Plugin;
 //#endregion
-export { ConfigSource, type DefinePage, type ExcludeIndexSignature, FILE_EXTENSIONS, MODULE_ID_VIRTUAL, type MaybeCallable, type MaybePromise, type MaybePromiseCallable, OUTPUT_NAME, Options, Page, PageContext, type PageMetaDatum, PagePath, RESOLVED_MODULE_ID_VIRTUAL, ResolvedOptions, SubPackageConfig, type SubPageMetaDatum, UserOptions, type UserPageMeta, type UserTabBarItem, VitePluginUniPages, VitePluginUniPages as default, babelGenerate, checkPagesJsonFileSync, debug, debugType, type definePage, defineUniPages, extsToGlob, findImports, findMacro, getPageFiles, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCode, parseSFC, resolveOptions, resolvePageDirs, sleep, stripType, tryPageMetaFromMacro, writeFileWithLock };
+export { ConfigSource, type DefinePage, type ExcludeIndexSignature, FILE_EXTENSIONS, MODULE_ID_VIRTUAL, type MaybeCallable, type MaybePromise, type MaybePromiseCallable, OUTPUT_NAME, Options, Page, PageContext, type PageMetaDatum, PagePath, RESOLVED_MODULE_ID_VIRTUAL, ResolvedOptions, SubPackageConfig, type SubPageMetaDatum, UserOptions, type UserPageMeta, type UserTabBarItem, VitePluginUniPages, VitePluginUniPages as default, babelGenerate, checkPagesJsonFileSync, debug, debugType, type definePage, defineUniPages, extsToGlob, findImports, findMacro, getPageFiles, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCode, parseSFC, resolveOptions, resolvePageDirs, sleep, stripType, stripTypeInPlace, tryPageMetaFromMacro, withFileLock, writeFileWithLock };

package/dist/index.d.mts

@@ -2,7 +2,7 @@ import { createRequire } from "node:module";
 import { FSWatcher } from "chokidar";
 import { Logger, Plugin, ViteDevServer } from "vite";
 import fs from "node:fs";
-import dbg from "debug";
+import Debug from "debug";
 import { LoadConfigSource } from "unconfig";
 import babelGenerator from "@babel/generator";
 import * as t from "@babel/types";
@@ -286,14 +286,14 @@ declare function invalidatePagesModule(server: ViteDevServer): void;
  * Enable via environment variable DEBUG=vite-plugin-uni-pages:*
  */
 declare const debug: {
-  /** HMR related logs */hmr: dbg.Debugger; /** Configuration options related logs */
-  options: dbg.Debugger; /** Main package page scanning logs */
-  pages: dbg.Debugger; /** Sub-package page scanning logs */
-  subPages: dbg.Debugger; /** Error logs */
-  error: dbg.Debugger; /** Cache related logs */
-  cache: dbg.Debugger; /** Declaration file generation logs */
-  declaration: dbg.Debugger; /** definePage macro parsing logs */
-  definePage: dbg.Debugger;
+  /** HMR related logs */hmr: Debug.Debugger; /** Configuration options related logs */
+  options: Debug.Debugger; /** Main package page scanning logs */
+  pages: Debug.Debugger; /** Sub-package page scanning logs */
+  subPages: Debug.Debugger; /** Error logs */
+  error: Debug.Debugger; /** Cache related logs */
+  cache: Debug.Debugger; /** Declaration file generation logs */
+  declaration: Debug.Debugger; /** definePage macro parsing logs */
+  definePage: Debug.Debugger;
 };
 /**
  * Convert file extensions array to glob pattern
@@ -338,6 +338,20 @@ declare function sleep(ms: number): Promise<unknown>;
 /** Babel code generator for converting AST back to code */
 declare const babelGenerate: typeof babelGenerator;
 declare function stripType<T extends Record<string, unknown>>(item: T): Omit<T, 'type'>;
+/**
+ * Remove the internal `type` marker (`'home'` / `'page'`) from every element of
+ * a `CommentArray` *in place* and return the same array.
+ *
+ * Unlike `items.map(stripType)`, this preserves the `Symbol.for('before:N')` /
+ * `Symbol.for('after:N')` comment slots that `comment-json` attaches to the
+ * array, so multi-platform `#ifdef` / `#endif` conditional-compilation blocks
+ * survive serialization into pages.json. `.map()` rebuilds the array and drops
+ * those symbol-keyed comments.
+ *
+ * @param items - CommentArray (or plain array) of page/tabBar metadata
+ * @returns The same array reference, with `type` removed from each element
+ */
+declare function stripTypeInPlace<T extends Record<string, unknown>>(items: T[]): T[];
 //#endregion
 //#region src/types.d.ts
 /** Debug log type, corresponding to methods in the debug object */
@@ -507,16 +521,35 @@ declare function getPageFiles(path: string, options: ResolvedOptions): string[];
  * @returns boolean - Whether the operation was successful
  */
 declare function checkPagesJsonFileSync(path: fs.PathLike): boolean;
+/**
+ * Run a task while holding an exclusive file lock.
+ *
+ * Unlike {@link writeFileWithLock}, this protects the whole read-modify-write
+ * critical section. The lock is held from the moment `task` starts until it
+ * resolves, so concurrent processes cannot observe or overwrite a half-written
+ * state. This is required by pages.json generation, where the new content
+ * depends on the current content (other platforms' `#ifdef` blocks).
+ *
+ * @param path - File path used as the lock target
+ * @param task - Async work to run inside the lock; return value is forwarded
+ * @param retry - Number of retries when lock acquisition fails, defaults to 3
+ * @returns The value resolved by `task`, or `undefined` if the lock could not be acquired
+ */
+declare function withFileLock<T>(path: string, task: () => Promise<T>, retry?: number): Promise<T | undefined>;
 /**
  * Safely write file using file lock
  * Avoid data corruption caused by concurrent writes through file lock
  * Use atomic write to ensure file write integrity
  *
+ * Note: this only makes the *write* atomic. Callers that need to read the
+ * current content before computing the new one must use {@link withFileLock}
+ * so the read and write belong to the same critical section.
+ *
  * @param path - File path
  * @param content - File content
  * @param retry - Number of retries when lock acquisition fails, defaults to 3
  */
-declare function writeFileWithLock(path: string, content: string, retry?: number): Promise<void>;
+declare function writeFileWithLock(path: string, content: string, retry?: number): Promise<void | undefined>;
 //#endregion
 //#region src/options.d.ts
 /**
@@ -533,7 +566,7 @@ declare function resolveOptions(userOptions: UserOptions, viteRoot?: string): Re
  */
 declare function resolvePageDirs(dir: string, root: string, exclude: string[]): string[];
 declare namespace index_d_exports {
-  export { ConfigSource, DefinePage, ExcludeIndexSignature, FILE_EXTENSIONS, MODULE_ID_VIRTUAL, MaybeCallable, MaybePromise, MaybePromiseCallable, OUTPUT_NAME, Options, Page, PageContext, PageMetaDatum, PagePath, RESOLVED_MODULE_ID_VIRTUAL, ResolvedOptions, SubPackageConfig, SubPageMetaDatum, UserOptions, UserPageMeta, UserTabBarItem, VitePluginUniPages, babelGenerate, checkPagesJsonFileSync, debug, debugType, VitePluginUniPages as default, definePage, defineUniPages, extsToGlob, findImports, findMacro, getPageFiles, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCode, parseSFC, resolveOptions, resolvePageDirs, sleep, stripType, tryPageMetaFromMacro, writeFileWithLock };
+  export { ConfigSource, DefinePage, ExcludeIndexSignature, FILE_EXTENSIONS, MODULE_ID_VIRTUAL, MaybeCallable, MaybePromise, MaybePromiseCallable, OUTPUT_NAME, Options, Page, PageContext, PageMetaDatum, PagePath, RESOLVED_MODULE_ID_VIRTUAL, ResolvedOptions, SubPackageConfig, SubPageMetaDatum, UserOptions, UserPageMeta, UserTabBarItem, VitePluginUniPages, babelGenerate, checkPagesJsonFileSync, debug, debugType, VitePluginUniPages as default, definePage, defineUniPages, extsToGlob, findImports, findMacro, getPageFiles, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCode, parseSFC, resolveOptions, resolvePageDirs, sleep, stripType, stripTypeInPlace, tryPageMetaFromMacro, withFileLock, writeFileWithLock };
 }
 /**
  * vite-plugin-uni-pages plugin main entry
@@ -549,4 +582,4 @@ declare namespace index_d_exports {
  */
 declare function VitePluginUniPages(userOptions?: UserOptions): Plugin;
 //#endregion
-export { ConfigSource, type DefinePage, type ExcludeIndexSignature, FILE_EXTENSIONS, MODULE_ID_VIRTUAL, type MaybeCallable, type MaybePromise, type MaybePromiseCallable, OUTPUT_NAME, Options, Page, PageContext, type PageMetaDatum, PagePath, RESOLVED_MODULE_ID_VIRTUAL, ResolvedOptions, SubPackageConfig, type SubPageMetaDatum, UserOptions, type UserPageMeta, type UserTabBarItem, VitePluginUniPages, VitePluginUniPages as default, babelGenerate, checkPagesJsonFileSync, debug, debugType, type definePage, defineUniPages, extsToGlob, findImports, findMacro, getPageFiles, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCode, parseSFC, resolveOptions, resolvePageDirs, sleep, stripType, tryPageMetaFromMacro, writeFileWithLock };
+export { ConfigSource, type DefinePage, type ExcludeIndexSignature, FILE_EXTENSIONS, MODULE_ID_VIRTUAL, type MaybeCallable, type MaybePromise, type MaybePromiseCallable, OUTPUT_NAME, Options, Page, PageContext, type PageMetaDatum, PagePath, RESOLVED_MODULE_ID_VIRTUAL, ResolvedOptions, SubPackageConfig, type SubPageMetaDatum, UserOptions, type UserPageMeta, type UserTabBarItem, VitePluginUniPages, VitePluginUniPages as default, babelGenerate, checkPagesJsonFileSync, debug, debugType, type definePage, defineUniPages, extsToGlob, findImports, findMacro, getPageFiles, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCode, parseSFC, resolveOptions, resolvePageDirs, sleep, stripType, stripTypeInPlace, tryPageMetaFromMacro, withFileLock, writeFileWithLock };

package/dist/index.mjs

@@ -8,14 +8,14 @@ import { createLogger, normalizePath } from "vite";
 import fs, { existsSync } from "node:fs";
 import { platform } from "@uni-helper/uni-env";
 import { CommentArray, parse, stringify } from "comment-json";
-import dbg from "debug";
+import Debug from "debug";
 import detectIndent from "detect-indent";
 import detectNewline from "detect-newline";
 import { loadConfig } from "unconfig";
+import writeFileAtomic from "write-file-atomic";
 import { mkdir, readFile, writeFile } from "node:fs/promises";
 import lockfile from "proper-lockfile";
 import { globSync } from "tinyglobby";
-import writeFileAtomic from "write-file-atomic";
 import vm from "node:vm";
 import babelGenerator from "@babel/generator";
 import groupBy from "lodash.groupby";
@@ -135,21 +135,21 @@ function invalidatePagesModule(server) {
 */
 const debug = {
 	/** HMR related logs */
-	hmr: dbg("vite-plugin-uni-pages:hmr"),
+	hmr: Debug("vite-plugin-uni-pages:hmr"),
 	/** Configuration options related logs */
-	options: dbg("vite-plugin-uni-pages:options"),
+	options: Debug("vite-plugin-uni-pages:options"),
 	/** Main package page scanning logs */
-	pages: dbg("vite-plugin-uni-pages:pages"),
+	pages: Debug("vite-plugin-uni-pages:pages"),
 	/** Sub-package page scanning logs */
-	subPages: dbg("vite-plugin-uni-pages:subPages"),
+	subPages: Debug("vite-plugin-uni-pages:subPages"),
 	/** Error logs */
-	error: dbg("vite-plugin-uni-pages:error"),
+	error: Debug("vite-plugin-uni-pages:error"),
 	/** Cache related logs */
-	cache: dbg("vite-plugin-uni-pages:cache"),
+	cache: Debug("vite-plugin-uni-pages:cache"),
 	/** Declaration file generation logs */
-	declaration: dbg("vite-plugin-uni-pages:declaration"),
+	declaration: Debug("vite-plugin-uni-pages:declaration"),
 	/** definePage macro parsing logs */
-	definePage: dbg("vite-plugin-uni-pages:definePage")
+	definePage: Debug("vite-plugin-uni-pages:definePage")
 };
 /**
 * Convert file extensions array to glob pattern
@@ -275,6 +275,23 @@ function stripType(item) {
 	const { type, ...rest } = item;
 	return rest;
 }
+/**
+* Remove the internal `type` marker (`'home'` / `'page'`) from every element of
+* a `CommentArray` *in place* and return the same array.
+*
+* Unlike `items.map(stripType)`, this preserves the `Symbol.for('before:N')` /
+* `Symbol.for('after:N')` comment slots that `comment-json` attaches to the
+* array, so multi-platform `#ifdef` / `#endif` conditional-compilation blocks
+* survive serialization into pages.json. `.map()` rebuilds the array and drops
+* those symbol-keyed comments.
+*
+* @param items - CommentArray (or plain array) of page/tabBar metadata
+* @returns The same array reference, with `type` removed from each element
+*/
+function stripTypeInPlace(items) {
+	for (const item of items) if (item && "type" in item) delete item.type;
+	return items;
+}
 //#endregion
 //#region src/files.ts
 /**
@@ -342,17 +359,22 @@ function checkPagesJsonFileSync(path) {
 	}
 }
 /**
-* Safely write file using file lock
-* Avoid data corruption caused by concurrent writes through file lock
-* Use atomic write to ensure file write integrity
+* Run a task while holding an exclusive file lock.
 *
-* @param path - File path
-* @param content - File content
+* Unlike {@link writeFileWithLock}, this protects the whole read-modify-write
+* critical section. The lock is held from the moment `task` starts until it
+* resolves, so concurrent processes cannot observe or overwrite a half-written
+* state. This is required by pages.json generation, where the new content
+* depends on the current content (other platforms' `#ifdef` blocks).
+*
+* @param path - File path used as the lock target
+* @param task - Async work to run inside the lock; return value is forwarded
 * @param retry - Number of retries when lock acquisition fails, defaults to 3
+* @returns The value resolved by `task`, or `undefined` if the lock could not be acquired
 */
-async function writeFileWithLock(path, content, retry = 3) {
+async function withFileLock(path, task, retry = 3) {
 	if (retry <= 0) {
-		debug.error(`${path} Failed to acquire file lock, write failed`);
+		debug.error(`${path} Failed to acquire file lock, task aborted`);
 		return;
 	}
 	let release;
@@ -361,13 +383,31 @@ async function writeFileWithLock(path, content, retry = 3) {
 			release = await lockfile.lock(path, { realpath: false });
 		} catch {
 			await sleep(500);
-			return writeFileWithLock(path, content, retry - 1);
+			return withFileLock(path, task, retry - 1);
 		}
-		await writeFileAtomic(path, content);
+		return await task();
 	} finally {
 		if (release) await release();
 	}
 }
+/**
+* Safely write file using file lock
+* Avoid data corruption caused by concurrent writes through file lock
+* Use atomic write to ensure file write integrity
+*
+* Note: this only makes the *write* atomic. Callers that need to read the
+* current content before computing the new one must use {@link withFileLock}
+* so the read and write belong to the same critical section.
+*
+* @param path - File path
+* @param content - File content
+* @param retry - Number of retries when lock acquisition fails, defaults to 3
+*/
+async function writeFileWithLock(path, content, retry = 3) {
+	return withFileLock(path, async () => {
+		await writeFileAtomic(path, content);
+	}, retry);
+}
 //#endregion
 //#region src/options.ts
 /**
@@ -672,7 +712,7 @@ var PageContext = class {
 		if (debugOption) {
 			const prefix = "vite-plugin-uni-pages:";
 			const suffix = typeof debugOption === "boolean" ? "*" : debugOption;
-			dbg.enable(`${prefix}${suffix}`);
+			Debug.enable(`${prefix}${suffix}`);
 		}
 		this.resolvedPagesJSONPath = path.join(this.root, this.options.outDir, OUTPUT_NAME);
 		debug.options(this.options);
@@ -935,16 +975,19 @@ var PageContext = class {
 		}) : this.pageMetaData).forEach((v) => pagesMap.set(v.path, v));
 		this.pageMetaData = [...pagesMap.values()];
 		this.options.onBeforeWriteFile(this);
-		const pagesJson = stringify(await this.genratePagesJSON(), null, this.options.minify ? void 0 : await this.getIndent()) + (await this.getEndOfLine() ? await this.getNewline() : "");
+		const updated = await withFileLock(this.resolvedPagesJSONPath, async () => {
+			const pagesJson = stringify(await this.genratePagesJSON(), null, this.options.minify ? void 0 : await this.getIndent()) + (await this.getEndOfLine() ? await this.getNewline() : "");
+			if (this.lastPagesJson === pagesJson) {
+				debug.pages("PagesJson Not have change");
+				return false;
+			}
+			await writeFileAtomic(this.resolvedPagesJSONPath, pagesJson);
+			this.lastPagesJson = pagesJson;
+			return true;
+		});
 		this.generateDeclaration();
-		if (this.lastPagesJson === pagesJson) {
-			debug.pages("PagesJson Not have change");
-			return false;
-		}
-		await writeFileWithLock(this.resolvedPagesJSONPath, pagesJson);
-		this.lastPagesJson = pagesJson;
-		this.options.onAfterWriteFile(this);
-		return true;
+		if (updated) this.options.onAfterWriteFile(this);
+		return updated ?? false;
 	}
 	/**
 	* Generate virtual module content
@@ -1009,7 +1052,7 @@ var PageContext = class {
 		const { pages: oldPages, subPackages: oldSubPackages, tabBar: oldTabBar } = parse(await fs.promises.readFile(this.resolvedPagesJSONPath, { encoding: "utf-8" }).catch(() => "") || "{}");
 		const { pages: _pages, subPackages: _subPackages, tabBar: _tabBar, ...pageJson } = this.pagesGlobConfig || {};
 		const currentPlatform = platform.toUpperCase();
-		pageJson.pages = mergePlatformItems(oldPages, currentPlatform, this.pageMetaData, "path").map(stripType);
+		pageJson.pages = stripTypeInPlace(mergePlatformItems(oldPages, currentPlatform, this.pageMetaData, "path"));
 		if (pageJson.pages && pageJson.pages.length > 0) {
 			const pagesArray = pageJson.pages;
 			const homeIndex = pagesArray.findIndex((page) => page.type === "home");
@@ -1024,7 +1067,7 @@ var PageContext = class {
 		for (const existing of pageJson.subPackages) {
 			const sub = newSubPackages.get(existing.root);
 			if (sub) {
-				existing.pages = mergePlatformItems(existing.pages, currentPlatform, sub.pages, "path").map(stripType);
+				existing.pages = stripTypeInPlace(mergePlatformItems(existing.pages, currentPlatform, sub.pages, "path"));
 				if (sub.plugins) existing.plugins = sub.plugins;
 				newSubPackages.delete(existing.root);
 			}
@@ -1032,7 +1075,7 @@ var PageContext = class {
 		for (const [_, newSub] of newSubPackages) {
 			const subPackage = {
 				root: newSub.root,
-				pages: mergePlatformItems(void 0, currentPlatform, newSub.pages, "path").map(stripType)
+				pages: stripTypeInPlace(mergePlatformItems(void 0, currentPlatform, newSub.pages, "path"))
 			};
 			if (newSub.plugins) subPackage.plugins = newSub.plugins;
 			pageJson.subPackages.push(subPackage);
@@ -1303,4 +1346,4 @@ function VitePluginUniPages(userOptions = {}) {
 	};
 }
 //#endregion
-export { FILE_EXTENSIONS, MODULE_ID_VIRTUAL, OUTPUT_NAME, Page, PageContext, RESOLVED_MODULE_ID_VIRTUAL, VitePluginUniPages, VitePluginUniPages as default, babelGenerate, checkPagesJsonFileSync, debug, defineUniPages, extsToGlob, findImports, findMacro, getPageFiles, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCode, parseSFC, resolveOptions, resolvePageDirs, sleep, stripType, tryPageMetaFromMacro, writeFileWithLock };
+export { FILE_EXTENSIONS, MODULE_ID_VIRTUAL, OUTPUT_NAME, Page, PageContext, RESOLVED_MODULE_ID_VIRTUAL, VitePluginUniPages, VitePluginUniPages as default, babelGenerate, checkPagesJsonFileSync, debug, defineUniPages, extsToGlob, findImports, findMacro, getPageFiles, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCode, parseSFC, resolveOptions, resolvePageDirs, sleep, stripType, stripTypeInPlace, tryPageMetaFromMacro, withFileLock, writeFileWithLock };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@uni-helper/vite-plugin-uni-pages",
   "type": "module",
-  "version": "0.4.3",
+  "version": "0.4.6",
   "description": "File system based routing for uni-app applications using Vite",
   "author": "KeJun",
   "maintainers": [
@@ -55,7 +55,7 @@
     "@babel/generator": "^7.29.7",
     "@babel/types": "^7.29.7",
     "@types/proper-lockfile": "^4.1.4",
-    "@uni-helper/uni-env": "^0.2.2",
+    "@uni-helper/uni-env": "^0.3.1",
     "@vue/compiler-sfc": "~3.4.38",
     "ast-kit": "^1.4.3",
     "chokidar": "^3.6.0",
@@ -72,7 +72,7 @@
     "unconfig": "^7.5.0",
     "write-file-atomic": "^7.0.1",
     "yaml": "^2.9.0",
-    "@uni-helper/uni-pages-types": "0.4.3"
+    "@uni-helper/uni-pages-types": "0.4.6"
   },
   "devDependencies": {
     "@antfu/utils": "^9.3.0",