vite-plugin-uni-inject 0.2.0 → 0.3.0

package/README.md

@@ -1,17 +1,15 @@
 # vite-plugin-uni-inject
 
-利用 Vite 插件机制，解决 uniapp 项目中无法使用公共组件的问题。
+利用 Vite 插件机制，实现自动注入代码，解放你的双手。
 
 ## 功能特点
 
 - 干净的注入任何代码，没有多余的结构。
 - 支持注入 `<page-meta/>` 这种只能放在页面第一个位置的标签节点。
-- 自动识别所有 `page.json` 中的 vue 文件并注入，无需维护注入页面表。
+- 支持基于文件路由的 `page.json` 自动生成并注入，无需手动维护页面表。
 
 ## 如何使用
 
-原理就是通过 vite 插件机制，在构建过程中自动注入 inject.vue 中的代码。
-
 ### 安装依赖
 
 ```bash
@@ -22,17 +20,22 @@ pnpm i -D vite-plugin-uni-inject
 
 ```ts
 import { defineConfig } from "vite";
+import { uniAutoPages, uniInject } from "vite-plugin-uni-inject";
 import uni from "@dcloudio/vite-plugin-uni";
-import uniInject from "vite-plugin-uni-inject";
 
 // 如果有重写 page.json 文件的插件，请确保写在 uniInject 之前
 export default defineConfig(() => {
   return {
-    plugins: [uniInject(), uni()],
+    plugins: [uniAutoPages(), uniInject(), uni()],
   };
 });
 ```
 
+### 独立插件说明
+
+- `uniAutoPages(options)`：负责扫描文件路由并补全 `src/pages.json` 。
+- `uniInject(options)`：负责注入 `App.inject.vue`（或自定义文件）到页面文件。
+
 ## 报告错误
 
 欢迎提交 issue 与我们讨论。

package/dist/index.cjs

@@ -1,3 +1,4 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region \0rolldown/runtime.js
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -28,9 +29,12 @@ let path = require("path");
 path = __toESM(path);
 let magic_string = require("magic-string");
 magic_string = __toESM(magic_string);
-//#region src/index.ts
-function src_default(opts) {
-	const { injectPath = "App.inject.vue" } = opts || {};
+//#region src/inject.ts
+/**
+* 注入代码插件
+*/
+function uniInject(opts) {
+	const { path: injectPath = "App.inject.vue" } = opts || {};
 	const pageSet = /* @__PURE__ */ new Set();
 	let injectTemplate = "";
 	let injectScriptSetup = "";
@@ -79,15 +83,15 @@ function src_default(opts) {
 			if (newDescriptor.scriptSetup) {
 				const start = newDescriptor.scriptSetup.loc.start.offset;
 				const end = newDescriptor.scriptSetup.loc.end.offset;
-				const code = newDescriptor.scriptSetup.content;
-				const s = new magic_string.default(code);
-				const ast = (0, _babel_parser.parse)(code, {
+				const scriptCode = newDescriptor.scriptSetup.content;
+				const s = new magic_string.default(scriptCode);
+				const ast = (0, _babel_parser.parse)(scriptCode, {
 					sourceType: "module",
 					plugins: ["typescript"]
 				});
 				const imports = [];
 				for (const node of ast.program.body) if (node.type === "ImportDeclaration") {
-					imports.push(code.slice(node.start, node.end));
+					imports.push(scriptCode.slice(node.start, node.end));
 					s.remove(node.start, node.end + 1);
 				}
 				if (imports.length) s.prepend("\n" + imports.join("\n"));
@@ -98,4 +102,147 @@ function src_default(opts) {
 	};
 }
 //#endregion
-module.exports = src_default;
+//#region src/auto-pages.ts
+function toPosixPath(value) {
+	return value.replace(/\\/g, "/");
+}
+function normalizeDir(value) {
+	return toPosixPath(value).replace(/^\/+|\/+$/g, "");
+}
+function walkFiles(dirPath, filePaths = []) {
+	if (!fs.default.existsSync(dirPath)) return filePaths;
+	const entries = fs.default.readdirSync(dirPath, { withFileTypes: true });
+	for (const entry of entries) {
+		const fullPath = path.default.join(dirPath, entry.name);
+		if (entry.isDirectory()) {
+			walkFiles(fullPath, filePaths);
+			continue;
+		}
+		filePaths.push(fullPath);
+	}
+	return filePaths;
+}
+function collectFileRoutes(srcRoot, routeDirs) {
+	const routeSet = /* @__PURE__ */ new Set();
+	routeDirs.forEach((dir) => {
+		walkFiles(path.default.resolve(srcRoot, dir)).forEach((filePath) => {
+			if (!filePath.endsWith(".vue")) return;
+			const noExt = path.default.relative(srcRoot, filePath).slice(0, -4);
+			routeSet.add(toPosixPath(noExt));
+		});
+	});
+	return Array.from(routeSet).sort();
+}
+function getScanDirs(dir, subPackages) {
+	const dirSet = /* @__PURE__ */ new Set();
+	const normalizedMainDir = normalizeDir(dir);
+	if (normalizedMainDir) dirSet.add(normalizedMainDir);
+	subPackages.forEach((subRoot) => {
+		const normalizedSubRoot = normalizeDir(subRoot);
+		if (!normalizedSubRoot) return;
+		if (normalizedMainDir) {
+			dirSet.add(`${normalizedSubRoot}/${normalizedMainDir}`);
+			return;
+		}
+		dirSet.add(normalizedSubRoot);
+	});
+	return Array.from(dirSet);
+}
+function readPagesJson(pagesJsonPath) {
+	if (!fs.default.existsSync(pagesJsonPath)) return null;
+	const content = fs.default.readFileSync(pagesJsonPath, "utf-8");
+	return JSON.parse(content);
+}
+function mergePages(routes, existingPages) {
+	const existingMap = new Map(existingPages.map((p) => [p.path, p]));
+	return routes.map((route) => {
+		return existingMap.get(route) ?? { path: route };
+	});
+}
+function hasPagesJsonChanged(current, next) {
+	return JSON.stringify({
+		pages: next.pages,
+		subPackages: next.subPackages ?? []
+	}) !== JSON.stringify({
+		pages: current.pages ?? [],
+		subPackages: current.subPackages ?? []
+	});
+}
+function getPagesByFileRoute(routes, pagesJson, subPackageRoots) {
+	const mainRoutes = [];
+	const subRouteMap = /* @__PURE__ */ new Map();
+	const normalizedSubRoots = subPackageRoots.map(normalizeDir);
+	for (const route of routes) {
+		const matchedRoot = normalizedSubRoots.find((root) => {
+			return route.startsWith(root + "/");
+		});
+		if (matchedRoot) {
+			const subPath = route.slice(matchedRoot.length + 1);
+			const list = subRouteMap.get(matchedRoot) ?? [];
+			list.push(subPath);
+			subRouteMap.set(matchedRoot, list);
+		} else mainRoutes.push(route);
+	}
+	const pages = mergePages(mainRoutes, pagesJson.pages ?? []);
+	const existSubs = pagesJson.subPackages ?? [];
+	const subPackages = normalizedSubRoots.map((root) => {
+		return {
+			root,
+			pages: mergePages(subRouteMap.get(root) ?? [], existSubs.find((s) => {
+				return normalizeDir(s.root) === root;
+			})?.pages ?? [])
+		};
+	});
+	const merged = {
+		...pagesJson,
+		pages,
+		subPackages
+	};
+	return {
+		merged,
+		changed: hasPagesJsonChanged(pagesJson, merged)
+	};
+}
+function resolveDtsFilePath(srcRoot, dts) {
+	return path.default.isAbsolute(dts) ? dts : path.default.resolve(srcRoot, dts);
+}
+function buildRouteDts(routes) {
+	return [
+		"// Auto-generated by vite-plugin-uni-inject. Do not edit.",
+		"",
+		"/** 提取路径 */",
+		"export type ExtractPath<T extends string, Prefix extends string> = T extends `${Prefix}${infer P}` ? P : never;",
+		"",
+		"/** 路由路径 */",
+		"export type RoutePath =",
+		routes.map((route) => `  | "/${route}"`).join("\n") + ";",
+		""
+	].join("\n");
+}
+/**
+* 自动补全 pages.json 插件
+*/
+function uniAutoPages(opts) {
+	const { dir = "pages", subPackages = [], dts = "uni-pages.d.ts" } = opts || {};
+	return {
+		name: "vite-plugin-uni-auto-pages",
+		enforce: "pre",
+		configResolved(config) {
+			const srcRoot = path.default.resolve(config.root, "src");
+			const pagesJsonPath = path.default.join(srcRoot, "pages.json");
+			const pagesJson = readPagesJson(pagesJsonPath);
+			if (!pagesJson) return;
+			const routes = collectFileRoutes(srcRoot, getScanDirs(dir, subPackages));
+			const { merged, changed } = getPagesByFileRoute(routes, pagesJson, subPackages);
+			if (changed) fs.default.writeFileSync(pagesJsonPath, JSON.stringify(merged, null, 2) + "\n");
+			if (dts) {
+				const dtsFilePath = resolveDtsFilePath(srcRoot, dts);
+				const dtsContent = buildRouteDts(routes);
+				fs.default.writeFileSync(dtsFilePath, dtsContent);
+			}
+		}
+	};
+}
+//#endregion
+exports.uniAutoPages = uniAutoPages;
+exports.uniInject = uniInject;

package/dist/index.d.cts

@@ -1,12 +1,36 @@
 //#region src/types.d.ts
-/** 插件配置 */
-interface PluginOptions {
-  /** 要注入的文件路径 - 基于项目 src 目录 */
-  injectPath?: string;
+/** 注入插件配置 */
+interface InjectPluginOptions {
+  /**
+   * 注入的文件路径
+   * @default 'src/App.inject.vue'
+   */
+  path?: string;
+}
+/** 自动补全 pages 插件配置 */
+interface AutoPagesPluginOptions {
+  /**
+   * 扫描目录
+   * @default 'pages'
+   */
+  dir?: string;
+  /**
+   * 分包目录
+   * @default []
+   */
+  subPackages?: string[];
+  /**
+   * 生成类型声明
+   * @default 'src/uni-pages.d.ts'
+   */
+  dts?: string;
 }
 //#endregion
-//#region src/index.d.ts
-declare function export_default(opts?: PluginOptions): {
+//#region src/inject.d.ts
+/**
+ * 注入代码插件
+ */
+declare function uniInject(opts?: InjectPluginOptions): {
   name: string;
   enforce: "pre";
   configResolved(config: {
@@ -16,4 +40,17 @@ declare function export_default(opts?: PluginOptions): {
     code: string;
   } | undefined;
 };
-export = export_default;
+//#endregion
+//#region src/auto-pages.d.ts
+/**
+ * 自动补全 pages.json 插件
+ */
+declare function uniAutoPages(opts?: AutoPagesPluginOptions): {
+  name: string;
+  enforce: "pre";
+  configResolved(config: {
+    root: string;
+  }): void;
+};
+//#endregion
+export { uniAutoPages, uniInject };

package/dist/index.d.mts

@@ -1,12 +1,36 @@
 //#region src/types.d.ts
-/** 插件配置 */
-interface PluginOptions {
-  /** 要注入的文件路径 - 基于项目 src 目录 */
-  injectPath?: string;
+/** 注入插件配置 */
+interface InjectPluginOptions {
+  /**
+   * 注入的文件路径
+   * @default 'src/App.inject.vue'
+   */
+  path?: string;
+}
+/** 自动补全 pages 插件配置 */
+interface AutoPagesPluginOptions {
+  /**
+   * 扫描目录
+   * @default 'pages'
+   */
+  dir?: string;
+  /**
+   * 分包目录
+   * @default []
+   */
+  subPackages?: string[];
+  /**
+   * 生成类型声明
+   * @default 'src/uni-pages.d.ts'
+   */
+  dts?: string;
 }
 //#endregion
-//#region src/index.d.ts
-declare function export_default(opts?: PluginOptions): {
+//#region src/inject.d.ts
+/**
+ * 注入代码插件
+ */
+declare function uniInject(opts?: InjectPluginOptions): {
   name: string;
   enforce: "pre";
   configResolved(config: {
@@ -17,4 +41,16 @@ declare function export_default(opts?: PluginOptions): {
   } | undefined;
 };
 //#endregion
-export { export_default as default };
+//#region src/auto-pages.d.ts
+/**
+ * 自动补全 pages.json 插件
+ */
+declare function uniAutoPages(opts?: AutoPagesPluginOptions): {
+  name: string;
+  enforce: "pre";
+  configResolved(config: {
+    root: string;
+  }): void;
+};
+//#endregion
+export { uniAutoPages, uniInject };

package/dist/index.mjs

@@ -3,9 +3,12 @@ import { parse as parse$1 } from "@vue/compiler-sfc";
 import fs from "fs";
 import path from "path";
 import MagicString from "magic-string";
-//#region src/index.ts
-function src_default(opts) {
-	const { injectPath = "App.inject.vue" } = opts || {};
+//#region src/inject.ts
+/**
+* 注入代码插件
+*/
+function uniInject(opts) {
+	const { path: injectPath = "App.inject.vue" } = opts || {};
 	const pageSet = /* @__PURE__ */ new Set();
 	let injectTemplate = "";
 	let injectScriptSetup = "";
@@ -54,15 +57,15 @@ function src_default(opts) {
 			if (newDescriptor.scriptSetup) {
 				const start = newDescriptor.scriptSetup.loc.start.offset;
 				const end = newDescriptor.scriptSetup.loc.end.offset;
-				const code = newDescriptor.scriptSetup.content;
-				const s = new MagicString(code);
-				const ast = parse(code, {
+				const scriptCode = newDescriptor.scriptSetup.content;
+				const s = new MagicString(scriptCode);
+				const ast = parse(scriptCode, {
 					sourceType: "module",
 					plugins: ["typescript"]
 				});
 				const imports = [];
 				for (const node of ast.program.body) if (node.type === "ImportDeclaration") {
-					imports.push(code.slice(node.start, node.end));
+					imports.push(scriptCode.slice(node.start, node.end));
 					s.remove(node.start, node.end + 1);
 				}
 				if (imports.length) s.prepend("\n" + imports.join("\n"));
@@ -73,4 +76,146 @@ function src_default(opts) {
 	};
 }
 //#endregion
-export { src_default as default };
+//#region src/auto-pages.ts
+function toPosixPath(value) {
+	return value.replace(/\\/g, "/");
+}
+function normalizeDir(value) {
+	return toPosixPath(value).replace(/^\/+|\/+$/g, "");
+}
+function walkFiles(dirPath, filePaths = []) {
+	if (!fs.existsSync(dirPath)) return filePaths;
+	const entries = fs.readdirSync(dirPath, { withFileTypes: true });
+	for (const entry of entries) {
+		const fullPath = path.join(dirPath, entry.name);
+		if (entry.isDirectory()) {
+			walkFiles(fullPath, filePaths);
+			continue;
+		}
+		filePaths.push(fullPath);
+	}
+	return filePaths;
+}
+function collectFileRoutes(srcRoot, routeDirs) {
+	const routeSet = /* @__PURE__ */ new Set();
+	routeDirs.forEach((dir) => {
+		walkFiles(path.resolve(srcRoot, dir)).forEach((filePath) => {
+			if (!filePath.endsWith(".vue")) return;
+			const noExt = path.relative(srcRoot, filePath).slice(0, -4);
+			routeSet.add(toPosixPath(noExt));
+		});
+	});
+	return Array.from(routeSet).sort();
+}
+function getScanDirs(dir, subPackages) {
+	const dirSet = /* @__PURE__ */ new Set();
+	const normalizedMainDir = normalizeDir(dir);
+	if (normalizedMainDir) dirSet.add(normalizedMainDir);
+	subPackages.forEach((subRoot) => {
+		const normalizedSubRoot = normalizeDir(subRoot);
+		if (!normalizedSubRoot) return;
+		if (normalizedMainDir) {
+			dirSet.add(`${normalizedSubRoot}/${normalizedMainDir}`);
+			return;
+		}
+		dirSet.add(normalizedSubRoot);
+	});
+	return Array.from(dirSet);
+}
+function readPagesJson(pagesJsonPath) {
+	if (!fs.existsSync(pagesJsonPath)) return null;
+	const content = fs.readFileSync(pagesJsonPath, "utf-8");
+	return JSON.parse(content);
+}
+function mergePages(routes, existingPages) {
+	const existingMap = new Map(existingPages.map((p) => [p.path, p]));
+	return routes.map((route) => {
+		return existingMap.get(route) ?? { path: route };
+	});
+}
+function hasPagesJsonChanged(current, next) {
+	return JSON.stringify({
+		pages: next.pages,
+		subPackages: next.subPackages ?? []
+	}) !== JSON.stringify({
+		pages: current.pages ?? [],
+		subPackages: current.subPackages ?? []
+	});
+}
+function getPagesByFileRoute(routes, pagesJson, subPackageRoots) {
+	const mainRoutes = [];
+	const subRouteMap = /* @__PURE__ */ new Map();
+	const normalizedSubRoots = subPackageRoots.map(normalizeDir);
+	for (const route of routes) {
+		const matchedRoot = normalizedSubRoots.find((root) => {
+			return route.startsWith(root + "/");
+		});
+		if (matchedRoot) {
+			const subPath = route.slice(matchedRoot.length + 1);
+			const list = subRouteMap.get(matchedRoot) ?? [];
+			list.push(subPath);
+			subRouteMap.set(matchedRoot, list);
+		} else mainRoutes.push(route);
+	}
+	const pages = mergePages(mainRoutes, pagesJson.pages ?? []);
+	const existSubs = pagesJson.subPackages ?? [];
+	const subPackages = normalizedSubRoots.map((root) => {
+		return {
+			root,
+			pages: mergePages(subRouteMap.get(root) ?? [], existSubs.find((s) => {
+				return normalizeDir(s.root) === root;
+			})?.pages ?? [])
+		};
+	});
+	const merged = {
+		...pagesJson,
+		pages,
+		subPackages
+	};
+	return {
+		merged,
+		changed: hasPagesJsonChanged(pagesJson, merged)
+	};
+}
+function resolveDtsFilePath(srcRoot, dts) {
+	return path.isAbsolute(dts) ? dts : path.resolve(srcRoot, dts);
+}
+function buildRouteDts(routes) {
+	return [
+		"// Auto-generated by vite-plugin-uni-inject. Do not edit.",
+		"",
+		"/** 提取路径 */",
+		"export type ExtractPath<T extends string, Prefix extends string> = T extends `${Prefix}${infer P}` ? P : never;",
+		"",
+		"/** 路由路径 */",
+		"export type RoutePath =",
+		routes.map((route) => `  | "/${route}"`).join("\n") + ";",
+		""
+	].join("\n");
+}
+/**
+* 自动补全 pages.json 插件
+*/
+function uniAutoPages(opts) {
+	const { dir = "pages", subPackages = [], dts = "uni-pages.d.ts" } = opts || {};
+	return {
+		name: "vite-plugin-uni-auto-pages",
+		enforce: "pre",
+		configResolved(config) {
+			const srcRoot = path.resolve(config.root, "src");
+			const pagesJsonPath = path.join(srcRoot, "pages.json");
+			const pagesJson = readPagesJson(pagesJsonPath);
+			if (!pagesJson) return;
+			const routes = collectFileRoutes(srcRoot, getScanDirs(dir, subPackages));
+			const { merged, changed } = getPagesByFileRoute(routes, pagesJson, subPackages);
+			if (changed) fs.writeFileSync(pagesJsonPath, JSON.stringify(merged, null, 2) + "\n");
+			if (dts) {
+				const dtsFilePath = resolveDtsFilePath(srcRoot, dts);
+				const dtsContent = buildRouteDts(routes);
+				fs.writeFileSync(dtsFilePath, dtsContent);
+			}
+		}
+	};
+}
+//#endregion
+export { uniAutoPages, uniInject };

package/package.json

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