vite-plugin-uni-inject 0.5.0 → 0.6.0

package/README.md

@@ -1,41 +1,19 @@
-# vite-plugin-uni-inject
+# Vite-plugin-uni-inject
 
-利用 Vite 插件机制，实现自动注入代码，解放你的双手。
+一个轻量级的 uniapp 注入增强插件，旨在为 uniapp 项目提供更舒适的开发体验。
 
-## 功能特点
+## 文档
 
-- 干净的注入任何代码，没有多余的结构。
-- 支持注入 `<page-meta/>` 这种只能放在页面第一个位置的标签节点。
-- 支持基于文件路由的 `page.json` 自动生成并注入，无需手动维护页面表。
+请阅读 [文档](https://kriac.github.io/vite-plugin-uni-inject) 了解更多使用细节。
 
-## 如何使用
+## 使用
 
-### 安装依赖
+如果你在开发过程中遇到了什么问题，或者有更好的建议，欢迎提交 issue 与我们讨论。
 
-```bash
-pnpm i -D vite-plugin-uni-inject
-```
+## 贡献
 
-### vite.config.ts
+首先感谢你考虑为本项目做出贡献！我们欢迎社区成员的贡献，以帮助改进和扩展本项目。
 
-```ts
-import { defineConfig } from "vite";
-import { uniAutoPages, uniInject } from "vite-plugin-uni-inject";
-import uni from "@dcloudio/vite-plugin-uni";
+## 执照
 
-// 如果有重写 page.json 文件的插件，请确保写在 uniInject 之前
-export default defineConfig(() => {
-  return {
-    plugins: [uniAutoPages(), uniInject(), uni()],
-  };
-});
-```
-
-### 独立插件说明
-
-- `uniAutoPages(options)`：负责扫描文件路由并补全 `src/pages.json` 。
-- `uniInject(options)`：负责注入 `App.inject.vue`（或自定义文件）到页面文件。
-
-## 报告错误
-
-欢迎提交 issue 与我们讨论。
+本项目采用 MIT 许可证，详细内容请见 [LICENSE](LICENSE) 文件。

package/dist/index.cjs

@@ -94,14 +94,18 @@ function uniInject(opts) {
 				});
 				let nextScriptCode = scriptCode;
 				if (imports.length) {
-					const ranges = [...imports].sort((a, b) => b.start - a.start);
+					const ranges = [...imports].sort((a, b) => {
+						return b.start - a.start;
+					});
 					for (const { start: rangeStart, end: rangeEnd } of ranges) {
 						let removeEnd = rangeEnd;
 						if (nextScriptCode.startsWith("\r\n", removeEnd)) removeEnd += 2;
 						else if (nextScriptCode[removeEnd] === "\n") removeEnd += 1;
 						nextScriptCode = nextScriptCode.slice(0, rangeStart) + nextScriptCode.slice(removeEnd);
 					}
-					nextScriptCode = `\n${imports.map((item) => item.code).join("\n")}${nextScriptCode}`;
+					nextScriptCode = `\n${imports.map((item) => {
+						return item.code;
+					}).join("\n")}${nextScriptCode}`;
 				}
 				newCode = newCode.slice(0, start) + nextScriptCode + newCode.slice(end);
 			}
@@ -138,7 +142,9 @@ function analyzeVueContent(content, filePath) {
 	if (!content.includes("definePage")) return null;
 	const stripRanges = [];
 	const { descriptor } = (0, _vue_compiler_sfc.parse)(content);
-	const blocks = [descriptor.scriptSetup, descriptor.script].filter((b) => Boolean(b));
+	const blocks = [descriptor.scriptSetup, descriptor.script].filter((b) => {
+		return Boolean(b);
+	});
 	let config = null;
 	for (const block of blocks) {
 		const src = block.content;
@@ -156,7 +162,9 @@ function analyzeVueContent(content, filePath) {
 		for (const node of ast.program.body) {
 			if (typeof node.start !== "number" || typeof node.end !== "number") continue;
 			if (node.type === "ImportDeclaration") {
-				if (node.specifiers.some((s) => s.type === "ImportSpecifier" && s.imported.type === "Identifier" && s.imported.name === "definePage")) stripRanges.push({
+				if (node.specifiers.some((s) => {
+					return s.type === "ImportSpecifier" && s.imported.type === "Identifier" && s.imported.name === "definePage";
+				})) stripRanges.push({
 					start: base + node.start,
 					end: base + node.end
 				});
@@ -225,7 +233,9 @@ function getPagesByFileRoute(routes, analysisMap, pagesJson, subPackageRoots) {
 	const subRouteMap = /* @__PURE__ */ new Map();
 	const normalizedSubRoots = subPackageRoots.map(normalizeDir);
 	for (const route of routes) {
-		const matchedRoot = normalizedSubRoots.find((root) => route.startsWith(root + "/"));
+		const matchedRoot = normalizedSubRoots.find((root) => {
+			return route.startsWith(root + "/");
+		});
 		if (matchedRoot) {
 			const list = subRouteMap.get(matchedRoot) ?? [];
 			list.push(route.slice(matchedRoot.length + 1));
@@ -241,11 +251,17 @@ function getPagesByFileRoute(routes, analysisMap, pagesJson, subPackageRoots) {
 	}
 	return {
 		...pagesJson,
-		pages: buildPages(mainRoutes, analysisMap, (r) => r),
-		subPackages: normalizedSubRoots.map((root) => ({
-			root,
-			pages: buildPages(subRouteMap.get(root) ?? [], analysisMap, (r) => `${root}/${r}`)
-		}))
+		pages: buildPages(mainRoutes, analysisMap, (r) => {
+			return r;
+		}),
+		subPackages: normalizedSubRoots.map((root) => {
+			return {
+				root,
+				pages: buildPages(subRouteMap.get(root) ?? [], analysisMap, (r) => {
+					return `${root}/${r}`;
+				})
+			};
+		})
 	};
 }
 function buildRouteDts(routes) {
@@ -257,7 +273,9 @@ function buildRouteDts(routes) {
 export type ExtractPath<T extends string, Prefix extends string> = T extends \`\${Prefix}\${infer P}\` ? P : never;
 
 /** 路由路径 */
-export type RoutePath = ${routes.map((r) => `"/${r}"`).join(` |\n`)};
+export type RoutePath = ${routes.map((r) => {
+		return `"/${r}"`;
+	}).join(` |\n`)};
 
 declare global {
   /**
@@ -267,13 +285,17 @@ declare global {
 }
 `;
 }
-function writeIfTextChanged(targetPath, nextContent) {
-	const normalize = (s) => {
-		return s.replace(/\s+/g, "").replace(/,(?=[)\]}>])/g, "").replace(/([=(<,|&?:])\|/g, "$1");
-	};
-	if (fs.default.existsSync(targetPath) && normalize(fs.default.readFileSync(targetPath, "utf-8")) === normalize(nextContent)) return;
+function getCachePath(cacheDir, targetPath) {
+	const cacheName = Buffer.from(path.default.resolve(targetPath)).toString("base64url");
+	return path.default.join(cacheDir, "vite-plugin-uni-inject", "auto-pages", cacheName);
+}
+function writeFileWithCache(targetPath, nextContent, cacheDir, forceWrite = false) {
+	const cachePath = getCachePath(cacheDir, targetPath);
+	if (!forceWrite && fs.default.existsSync(targetPath) && fs.default.existsSync(cachePath) && fs.default.readFileSync(cachePath, "utf-8") === nextContent) return;
 	fs.default.mkdirSync(path.default.dirname(targetPath), { recursive: true });
 	fs.default.writeFileSync(targetPath, nextContent);
+	fs.default.mkdirSync(path.default.dirname(cachePath), { recursive: true });
+	fs.default.writeFileSync(cachePath, nextContent);
 }
 /**
 * 自动补全 pages.json 插件
@@ -290,11 +312,11 @@ function uniAutoPages(opts) {
 			if (!pagesJson) return;
 			const { routes, analysisMap } = collectFileRoutes(srcRoot, getScanDirs(mainPackage, subPackages));
 			const merged = getPagesByFileRoute(routes, analysisMap, pagesJson, subPackages);
-			writeIfTextChanged(pagesJsonPath, JSON.stringify(merged, null, 2) + "\n");
-			if (dts) {
-				const newDts = buildRouteDts(routes);
-				writeIfTextChanged(path.default.join(srcRoot, dts), newDts);
-			}
+			const newPagesJson = JSON.stringify(merged, null, 2) + "\n";
+			const dtsPath = dts ? path.default.join(srcRoot, dts) : null;
+			const shouldRefreshPagesJson = dtsPath ? !fs.default.existsSync(dtsPath) : false;
+			writeFileWithCache(pagesJsonPath, newPagesJson, config.cacheDir, shouldRefreshPagesJson);
+			if (dtsPath) writeFileWithCache(dtsPath, buildRouteDts(routes), config.cacheDir);
 		},
 		transform(code, id) {
 			const pure = id.split("?")[0];
@@ -302,7 +324,9 @@ function uniAutoPages(opts) {
 			const analysis = analyzeVueContent(code, pure);
 			if (!analysis?.stripRanges.length) return;
 			let newCode = code;
-			const ranges = [...analysis.stripRanges].sort((a, b) => b.start - a.start);
+			const ranges = [...analysis.stripRanges].sort((a, b) => {
+				return b.start - a.start;
+			});
 			for (const { start, end } of ranges) {
 				let removeEnd = end;
 				if (newCode.startsWith("\r\n", removeEnd)) removeEnd += 2;

package/dist/index.d.cts

@@ -78,6 +78,7 @@ declare function uniAutoPages(opts?: AutoPagesPluginOptions): {
   name: string;
   enforce: "pre";
   configResolved(config: {
+    cacheDir: string;
     root: string;
   }): void;
   transform(code: string, id: string): {

package/dist/index.d.mts

@@ -78,6 +78,7 @@ declare function uniAutoPages(opts?: AutoPagesPluginOptions): {
   name: string;
   enforce: "pre";
   configResolved(config: {
+    cacheDir: string;
     root: string;
   }): void;
   transform(code: string, id: string): {

package/dist/index.mjs

@@ -69,14 +69,18 @@ function uniInject(opts) {
 				});
 				let nextScriptCode = scriptCode;
 				if (imports.length) {
-					const ranges = [...imports].sort((a, b) => b.start - a.start);
+					const ranges = [...imports].sort((a, b) => {
+						return b.start - a.start;
+					});
 					for (const { start: rangeStart, end: rangeEnd } of ranges) {
 						let removeEnd = rangeEnd;
 						if (nextScriptCode.startsWith("\r\n", removeEnd)) removeEnd += 2;
 						else if (nextScriptCode[removeEnd] === "\n") removeEnd += 1;
 						nextScriptCode = nextScriptCode.slice(0, rangeStart) + nextScriptCode.slice(removeEnd);
 					}
-					nextScriptCode = `\n${imports.map((item) => item.code).join("\n")}${nextScriptCode}`;
+					nextScriptCode = `\n${imports.map((item) => {
+						return item.code;
+					}).join("\n")}${nextScriptCode}`;
 				}
 				newCode = newCode.slice(0, start) + nextScriptCode + newCode.slice(end);
 			}
@@ -113,7 +117,9 @@ function analyzeVueContent(content, filePath) {
 	if (!content.includes("definePage")) return null;
 	const stripRanges = [];
 	const { descriptor } = parse$1(content);
-	const blocks = [descriptor.scriptSetup, descriptor.script].filter((b) => Boolean(b));
+	const blocks = [descriptor.scriptSetup, descriptor.script].filter((b) => {
+		return Boolean(b);
+	});
 	let config = null;
 	for (const block of blocks) {
 		const src = block.content;
@@ -131,7 +137,9 @@ function analyzeVueContent(content, filePath) {
 		for (const node of ast.program.body) {
 			if (typeof node.start !== "number" || typeof node.end !== "number") continue;
 			if (node.type === "ImportDeclaration") {
-				if (node.specifiers.some((s) => s.type === "ImportSpecifier" && s.imported.type === "Identifier" && s.imported.name === "definePage")) stripRanges.push({
+				if (node.specifiers.some((s) => {
+					return s.type === "ImportSpecifier" && s.imported.type === "Identifier" && s.imported.name === "definePage";
+				})) stripRanges.push({
 					start: base + node.start,
 					end: base + node.end
 				});
@@ -200,7 +208,9 @@ function getPagesByFileRoute(routes, analysisMap, pagesJson, subPackageRoots) {
 	const subRouteMap = /* @__PURE__ */ new Map();
 	const normalizedSubRoots = subPackageRoots.map(normalizeDir);
 	for (const route of routes) {
-		const matchedRoot = normalizedSubRoots.find((root) => route.startsWith(root + "/"));
+		const matchedRoot = normalizedSubRoots.find((root) => {
+			return route.startsWith(root + "/");
+		});
 		if (matchedRoot) {
 			const list = subRouteMap.get(matchedRoot) ?? [];
 			list.push(route.slice(matchedRoot.length + 1));
@@ -216,11 +226,17 @@ function getPagesByFileRoute(routes, analysisMap, pagesJson, subPackageRoots) {
 	}
 	return {
 		...pagesJson,
-		pages: buildPages(mainRoutes, analysisMap, (r) => r),
-		subPackages: normalizedSubRoots.map((root) => ({
-			root,
-			pages: buildPages(subRouteMap.get(root) ?? [], analysisMap, (r) => `${root}/${r}`)
-		}))
+		pages: buildPages(mainRoutes, analysisMap, (r) => {
+			return r;
+		}),
+		subPackages: normalizedSubRoots.map((root) => {
+			return {
+				root,
+				pages: buildPages(subRouteMap.get(root) ?? [], analysisMap, (r) => {
+					return `${root}/${r}`;
+				})
+			};
+		})
 	};
 }
 function buildRouteDts(routes) {
@@ -232,7 +248,9 @@ function buildRouteDts(routes) {
 export type ExtractPath<T extends string, Prefix extends string> = T extends \`\${Prefix}\${infer P}\` ? P : never;
 
 /** 路由路径 */
-export type RoutePath = ${routes.map((r) => `"/${r}"`).join(` |\n`)};
+export type RoutePath = ${routes.map((r) => {
+		return `"/${r}"`;
+	}).join(` |\n`)};
 
 declare global {
   /**
@@ -242,13 +260,17 @@ declare global {
 }
 `;
 }
-function writeIfTextChanged(targetPath, nextContent) {
-	const normalize = (s) => {
-		return s.replace(/\s+/g, "").replace(/,(?=[)\]}>])/g, "").replace(/([=(<,|&?:])\|/g, "$1");
-	};
-	if (fs.existsSync(targetPath) && normalize(fs.readFileSync(targetPath, "utf-8")) === normalize(nextContent)) return;
+function getCachePath(cacheDir, targetPath) {
+	const cacheName = Buffer.from(path.resolve(targetPath)).toString("base64url");
+	return path.join(cacheDir, "vite-plugin-uni-inject", "auto-pages", cacheName);
+}
+function writeFileWithCache(targetPath, nextContent, cacheDir, forceWrite = false) {
+	const cachePath = getCachePath(cacheDir, targetPath);
+	if (!forceWrite && fs.existsSync(targetPath) && fs.existsSync(cachePath) && fs.readFileSync(cachePath, "utf-8") === nextContent) return;
 	fs.mkdirSync(path.dirname(targetPath), { recursive: true });
 	fs.writeFileSync(targetPath, nextContent);
+	fs.mkdirSync(path.dirname(cachePath), { recursive: true });
+	fs.writeFileSync(cachePath, nextContent);
 }
 /**
 * 自动补全 pages.json 插件
@@ -265,11 +287,11 @@ function uniAutoPages(opts) {
 			if (!pagesJson) return;
 			const { routes, analysisMap } = collectFileRoutes(srcRoot, getScanDirs(mainPackage, subPackages));
 			const merged = getPagesByFileRoute(routes, analysisMap, pagesJson, subPackages);
-			writeIfTextChanged(pagesJsonPath, JSON.stringify(merged, null, 2) + "\n");
-			if (dts) {
-				const newDts = buildRouteDts(routes);
-				writeIfTextChanged(path.join(srcRoot, dts), newDts);
-			}
+			const newPagesJson = JSON.stringify(merged, null, 2) + "\n";
+			const dtsPath = dts ? path.join(srcRoot, dts) : null;
+			const shouldRefreshPagesJson = dtsPath ? !fs.existsSync(dtsPath) : false;
+			writeFileWithCache(pagesJsonPath, newPagesJson, config.cacheDir, shouldRefreshPagesJson);
+			if (dtsPath) writeFileWithCache(dtsPath, buildRouteDts(routes), config.cacheDir);
 		},
 		transform(code, id) {
 			const pure = id.split("?")[0];
@@ -277,7 +299,9 @@ function uniAutoPages(opts) {
 			const analysis = analyzeVueContent(code, pure);
 			if (!analysis?.stripRanges.length) return;
 			let newCode = code;
-			const ranges = [...analysis.stripRanges].sort((a, b) => b.start - a.start);
+			const ranges = [...analysis.stripRanges].sort((a, b) => {
+				return b.start - a.start;
+			});
 			for (const { start, end } of ranges) {
 				let removeEnd = end;
 				if (newCode.startsWith("\r\n", removeEnd)) removeEnd += 2;

package/package.json

@@ -4,7 +4,7 @@
   "author": "Kriac",
   "license": "MIT",
   "type": "module",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "homepage": "https://github.com/Kriac/vite-plugin-uni-inject",
   "repository": {
     "type": "git",