@koishi-ce/plugin-config 1.1.1 → 1.1.3

package/lib/index.mjs

@@ -1,10 +1,9 @@
-import { join, resolve } from "node:path";
+import { dirname, join, resolve } from "node:path";
 import { Context, Logger, Schema, getServiceContext, remove } from "@koishi-ce/koishi";
 import { DataService } from "@koishi-ce/console";
 import { LocalScanner, getPluginShortname, isResidentInCache } from "@koishi-ce/registry";
 import { Loader } from "@koishi-ce/loader";
-import { existsSync, readFileSync } from "node:fs";
-import { readdir } from "node:fs/promises";
+import { readFileSync } from "node:fs";
 //#region src/shared/packages.ts
 /**
 * 插件包元数据提供器（服务端共享实现）。
@@ -464,9 +463,14 @@ var ConfigWriter = class extends DataService {
 * 本仓库 koishi.yml 的插件键统一是相对路径（./plugins/...），而 Bun
 * 不会把未被依赖的 workspace 包链入 node_modules，仅靠 LocalScanner
 * 会漏掉大部分源码包——因此 collect 时额外按配置键逐个加载
-* workspace 包，并写入 paths（配置键 → 包名映射，供前端解析插件名）。
+* workspace 包，并写入 paths（配置键 → 包名映射，供前端解析插件名）；
+* 未启用的包（含嵌套 monorepo 子包）则按 workspaces 声明展开收录。
 */
 const logger = new Logger("config");
+/** 插件包名的收录口径：只认三种插件命名前缀（与 LocalScanner 一致） */
+const PLUGIN_NAME_PATTERN = /^(koishi-plugin-|@koishi(?:-ce)?\/plugin-)/;
+/** 宿主未声明 workspaces 时的兜底约定（模板默认布局） */
+const FALLBACK_WORKSPACES = ["plugins/*", "external/*"];
 /**
 * 本机插件扫描器：在 LocalScanner 的基础上扩展 parsePackage，
 * 让"扫描到某个包"与"解析该插件的运行时信息"在同一次遍历中完成。
@@ -513,7 +517,7 @@ var PackageProvider$1 = class extends PackageProvider {
 	}
 	/**
 	* 收集全部 workspace 源码包：koishi.yml 已有相对路径键引用的（已启用）
-	* 加上 external/ 约定目录下的（可能尚未启用）。
+	* 加上 workspaces 声明覆盖的（可能尚未启用，含嵌套 monorepo 子包）。
 	*/
 	async collectWorkspacePackages() {
 		const index = /* @__PURE__ */ new Map();
@@ -545,39 +549,78 @@ var PackageProvider$1 = class extends PackageProvider {
 				if (!path?.startsWith("./")) return;
 				await addPath(path, true);
 			});
-			await this.collectExternalPackages(addPath);
+			await this.collectWorkspacePlugins(addPath);
 		} catch (error) {
 			logger.warn(error);
 		}
 		return [...index.values()];
 	}
 	/**
-	* 扫描 external/ 约定目录（官方 koishi-scripts 的插件开发目录），
-	* 收录其中尚未启用的 workspace 插件包。
+	* 收集 workspaces 声明覆盖的未启用插件包（嵌套 monorepo 兼容）。
 	*
-	* Bun 只把被依赖引用的 workspace 包链入 node_modules，未启用的
-	* external 插件因此不在本机扫描的视野内（yarn 全量链接生态下的
-	* 自动发现语义失效）——这里显式遍历目录补齐。收录条目带
-	* ./external/<name> 路径键，前端启用时以该键写入配置（loader 的
-	* 相对路径解析原生支持；短名不经 node_modules 会解析失败）。
+	* 以宿主 package.json 的 workspaces 通配为唯一真相源：声明写多深，
+	* 收录就能看多深——external/ 下克隆的 monorepo 形态插件（packages/
+	* 子包在二级及更深）无需平铺即可见。Bun 只把被依赖引用的 workspace
+	* 包链入 node_modules，未启用的插件不在本机扫描视野内（yarn 全量
+	* 链接生态的自动发现语义失效），这里是唯一补齐入口。
+	*
+	* 通配是目录模式，拼上 /package.json 以清单文件为锚点扫描
+	* （Bun.Glob 的 onlyDirs 语义不可靠，win32 实测返回文件路径且分隔符
+	* 为反斜杠，归一为 / 后再派生收录键）；负向模式（! 前缀）同样拼
+	* 锚点后对正向结果做差集——模板对 external 下 node_modules 的负向
+	* 通配即用于排除搬迁残留的依赖目录（注释里不写通配字面量，
+	* biome 会把其中的 JSDoc 起始序列误解析成类型）。收录口径与
+	* LocalScanner 的本机扫描一致：只认三种插件命名前缀，monorepo
+	* 根（@scope/monorepo 形态）与普通库不进列表；收录键
+	* ./<相对路径>（loader 的相对路径解析原生支持任意深度）。
 	*/
-	async collectExternalPackages(addPath) {
-		const base = resolve(this.scanner.baseDir, "external");
-		const entries = await readdir(base).catch(() => []);
-		for (const entry of entries) {
-			const dir = join(base, entry);
-			if (!existsSync(join(dir, "package.json"))) continue;
-			try {
-				const manifest = JSON.parse(readFileSync(join(dir, "package.json"), "utf8"));
-				if (typeof manifest.name !== "string" || !/^(koishi-plugin-|@koishi(?:-ce)?\/plugin-)/.test(manifest.name)) continue;
-				await addPath(`./external/${entry}`, false);
-			} catch (error) {
-				logger.warn(error);
+	async collectWorkspacePlugins(addPath) {
+		const baseDir = this.scanner.baseDir;
+		const patterns = readWorkspacePatterns(baseDir);
+		const anchor = (pattern) => `${pattern.replace(/\/+$/, "")}/package.json`;
+		const excluded = /* @__PURE__ */ new Set();
+		for (const pattern of patterns) {
+			if (!pattern.startsWith("!")) continue;
+			for (const rel of new Bun.Glob(anchor(pattern.slice(1))).scanSync({ cwd: baseDir })) excluded.add(normalizeSlashes(rel));
+		}
+		const seen = /* @__PURE__ */ new Set();
+		for (const pattern of patterns) {
+			if (pattern.startsWith("!")) continue;
+			for (const rel of new Bun.Glob(anchor(pattern)).scanSync({ cwd: baseDir })) {
+				const manifestPath = normalizeSlashes(rel);
+				if (excluded.has(manifestPath) || seen.has(manifestPath)) continue;
+				seen.add(manifestPath);
+				try {
+					const manifest = JSON.parse(readFileSync(join(baseDir, manifestPath), "utf8"));
+					if (typeof manifest.name !== "string" || !PLUGIN_NAME_PATTERN.test(manifest.name)) continue;
+					await addPath(`./${dirname(manifestPath)}`, false);
+				} catch (error) {
+					logger.warn(error);
+				}
 			}
 		}
 	}
 };
 /**
+* 读取宿主 package.json 的 workspaces 通配声明；缺失、非数组（如 yarn
+* no-hoist 的对象形态）或为空时回退模板默认约定——旧项目与 prod 形态
+* （workspaces 已被脚手架删除）的一级目录可见性不回退。
+*/
+function readWorkspacePatterns(baseDir) {
+	try {
+		const manifest = JSON.parse(readFileSync(join(baseDir, "package.json"), "utf8"));
+		if (Array.isArray(manifest.workspaces)) {
+			const patterns = manifest.workspaces.filter((pattern) => typeof pattern === "string");
+			if (patterns.length) return patterns;
+		}
+	} catch {}
+	return FALLBACK_WORKSPACES;
+}
+/** Bun.Glob 的 scan 在 win32 返回反斜杠分隔的相对路径，统一归一为 / */
+function normalizeSlashes(path) {
+	return path.split("\\").join("/");
+}
+/**
 * 递归遍历插件配置表并对每个插件键执行回调：`$` 开头的键是内部控制
 * 字段，`group:` 分组键的值内嵌套下一层插件表，其余键原样传入回调。
 */
@@ -611,8 +654,8 @@ function apply(ctx) {
 	ctx.plugin(ServiceProvider);
 	ctx.plugin(ConfigWriter);
 	ctx.console.addEntry({
-		dev: resolve(__dirname, "../client/index.ts"),
-		prod: resolve(__dirname, "../dist")
+		dev: resolve(import.meta.dir, "../client/index.ts"),
+		prod: resolve(import.meta.dir, "../dist")
 	});
 }
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@koishi-ce/plugin-config",
     "description": "Manage your bots and plugins with console",
-    "version": "1.1.1",
+    "version": "1.1.3",
     "type": "module",
     "main": "lib/index.mjs",
     "types": "lib/index.d.ts",
@@ -67,15 +67,15 @@
         "@koishi-ce/koishi": "^1.0.0"
     },
     "devDependencies": {
-        "@koishi-ce/client": "^1.2.2",
-        "@koishi-ce/plugin-hmr": "^1.1.1",
+        "@koishi-ce/client": "^1.2.4",
+        "@koishi-ce/plugin-hmr": "^1.1.2",
         "element-plus": "^2.14.5",
         "vue": "^3.5.12",
         "vue-router": "^5.2.0"
     },
     "dependencies": {
-        "@koishi-ce/console": "^1.0.0",
-        "@koishi-ce/loader": "^1.0.7",
+        "@koishi-ce/console": "^1.0.1",
+        "@koishi-ce/loader": "^1.0.9",
         "@koishi-ce/registry": "^1.0.5"
     }
 }

package/src/__tests__/index.test.ts

@@ -290,6 +290,67 @@ writeFileSync(
 mkdirSync(join(fixtureRoot, "external/no-manifest"), {
 	recursive: true,
 });
+// 嵌套 monorepo（新模板 workspaces 声明形态）：子包在二级深度可收录，
+// monorepo 根（@scope/monorepo 命名）不进列表，node_modules 残留探针
+// 被负向通配排除；plugins/ 一级的未启用包（盲区修复）同样可收录
+writeFileSync(
+	join(fixtureRoot, "package.json"),
+	JSON.stringify({
+		name: "fixture-host",
+		private: true,
+		workspaces: [
+			"plugins/*",
+			"external/**",
+			"!external/**/node_modules/**",
+		],
+	}),
+);
+mkdirSync(
+	join(fixtureRoot, "external/infra/packages/war-lib"),
+	{ recursive: true },
+);
+writeFileSync(
+	join(
+		fixtureRoot,
+		"external/infra/packages/war-lib/package.json",
+	),
+	JSON.stringify({
+		name: "koishi-plugin-war-lib",
+		version: "0.2.0",
+	}),
+);
+writeFileSync(
+	join(fixtureRoot, "external/infra/package.json"),
+	JSON.stringify({
+		name: "@infra/monorepo",
+		version: "1.0.0",
+		private: true,
+	}),
+);
+mkdirSync(
+	join(fixtureRoot, "external/infra/node_modules/zzz"),
+	{ recursive: true },
+);
+writeFileSync(
+	join(
+		fixtureRoot,
+		"external/infra/node_modules/zzz/package.json",
+	),
+	JSON.stringify({
+		name: "koishi-plugin-zzz-pollution",
+		version: "1.0.0",
+	}),
+);
+mkdirSync(join(fixtureRoot, "plugins/local-tool"), {
+	recursive: true,
+});
+writeFileSync(
+	join(fixtureRoot, "plugins/local-tool/package.json"),
+	JSON.stringify({
+		name: "koishi-plugin-local-tool",
+		version: "0.3.0",
+	}),
+);
 loader.baseDir = fixtureRoot;
 
 loader.config = {
@@ -462,6 +523,83 @@ describe("@koishi-ce/plugin-config", () => {
 			expect(data["no-manifest"]).toBeUndefined();
 		});
 
+		it("workspaces 声明驱动收录嵌套 monorepo 子包与 plugins/ 未启用包", async () => {
+			const provider = app.get(
+				"console.services.packages",
+			) as unknown as {
+				get(): Promise<Dict<Record<string, unknown>>>;
+			};
+			const data = await provider.get();
+			// 嵌套子包（external/** 任意深度）：收录并以深路径为键
+			const lib = data["koishi-plugin-war-lib"];
+			expect(lib?.["workspace"]).toBe(true);
+			expect(lib?.["paths"]).toEqual([
+				"./external/infra/packages/war-lib",
+			]);
+			expect(lib?.["runtime"]).toBeUndefined();
+			// plugins/ 一级的未启用包同样可收录（此前的可见性盲区）
+			expect(
+				data["koishi-plugin-local-tool"]?.["paths"],
+			).toEqual(["./plugins/local-tool"]);
+			// monorepo 根（@scope/monorepo 命名）不进列表
+			expect(data["@infra/monorepo"]).toBeUndefined();
+			// node_modules 残留探针被负向通配排除（即使命名合规）
+			expect(
+				data["koishi-plugin-zzz-pollution"],
+			).toBeUndefined();
+		});
+
+		it("readWorkspacePatterns：无清单 / 非数组 / 空数组时回退约定", async () => {
+			const { readWorkspacePatterns } = await import(
+				"../node/packages.ts"
+			);
+			const empty = mkdtempSync(
+				join(tmpdir(), "koishi-config-ws-"),
+			);
+			try {
+				// 无 package.json → 兜底约定
+				expect(readWorkspacePatterns(empty)).toEqual([
+					"plugins/*",
+					"external/*",
+				]);
+				// 非数组（yarn no-hoist 对象形态）与空数组同理
+				writeFileSync(
+					join(empty, "package.json"),
+					JSON.stringify({
+						workspaces: { packages: ["external/*"] },
+					}),
+				);
+				expect(readWorkspacePatterns(empty)).toEqual([
+					"plugins/*",
+					"external/*",
+				]);
+				writeFileSync(
+					join(empty, "package.json"),
+					JSON.stringify({ workspaces: [] }),
+				);
+				expect(readWorkspacePatterns(empty)).toEqual([
+					"plugins/*",
+					"external/*",
+				]);
+				// 合法声明原样透传（负向模式保留 ! 前缀）
+				writeFileSync(
+					join(empty, "package.json"),
+					JSON.stringify({
+						workspaces: [
+							"external/**",
+							"!external/**/node_modules/**",
+						],
+					}),
+				);
+				expect(readWorkspacePatterns(empty)).toEqual([
+					"external/**",
+					"!external/**/node_modules/**",
+				]);
+			} finally {
+				rmSync(empty, { recursive: true, force: true });
+			}
+		});
+
 		itQuiet(
 			["config"],
 			"request-runtime 按路径键 / 短名解析并刷新，失败结果同样缓存",

package/src/node/index.ts

@@ -50,7 +50,7 @@ export function apply(ctx: Context) {
 	// 路径相对 lib 产物（运行时执行形态）而非 src 源码：本文件在源码里位于
 	// src/node（两层），打包后位于 lib（一层），深度不一致，按 lib 计
 	ctx.console.addEntry({
-		dev: resolve(__dirname, "../client/index.ts"),
-		prod: resolve(__dirname, "../dist"),
+		dev: resolve(import.meta.dir, "../client/index.ts"),
+		prod: resolve(import.meta.dir, "../dist"),
 	});
 }

package/src/node/packages.ts

@@ -10,11 +10,11 @@
  * 本仓库 koishi.yml 的插件键统一是相对路径（./plugins/...），而 Bun
  * 不会把未被依赖的 workspace 包链入 node_modules，仅靠 LocalScanner
  * 会漏掉大部分源码包——因此 collect 时额外按配置键逐个加载
- * workspace 包，并写入 paths（配置键 → 包名映射，供前端解析插件名）。
+ * workspace 包，并写入 paths（配置键 → 包名映射，供前端解析插件名）；
+ * 未启用的包（含嵌套 monorepo 子包）则按 workspaces 声明展开收录。
  */
-import { existsSync, readFileSync } from "node:fs";
-import { readdir } from "node:fs/promises";
-import { join, resolve } from "node:path";
+import { readFileSync } from "node:fs";
+import { dirname, join, resolve } from "node:path";
 import { Logger } from "@koishi-ce/koishi";
 import {
 	getPluginShortname,
@@ -25,6 +25,13 @@ import * as shared from "../shared/index.ts";
 
 const logger = new Logger("config");
 
+/** 插件包名的收录口径：只认三种插件命名前缀（与 LocalScanner 一致） */
+const PLUGIN_NAME_PATTERN =
+	/^(koishi-plugin-|@koishi(?:-ce)?\/plugin-)/;
+
+/** 宿主未声明 workspaces 时的兜底约定（模板默认布局） */
+const FALLBACK_WORKSPACES = ["plugins/*", "external/*"];
+
 /**
  * 本机插件扫描器：在 LocalScanner 的基础上扩展 parsePackage，
  * 让"扫描到某个包"与"解析该插件的运行时信息"在同一次遍历中完成。
@@ -84,7 +91,7 @@ export class PackageProvider extends shared.PackageProvider {
 
 	/**
 	 * 收集全部 workspace 源码包：koishi.yml 已有相对路径键引用的（已启用）
-	 * 加上 external/ 约定目录下的（可能尚未启用）。
+	 * 加上 workspaces 声明覆盖的（可能尚未启用，含嵌套 monorepo 子包）。
 	 */
 	private async collectWorkspacePackages(): Promise<
 		shared.PackageProvider.Data[]
@@ -140,7 +147,7 @@ export class PackageProvider extends shared.PackageProvider {
 					await addPath(path, true);
 				},
 			);
-			await this.collectExternalPackages(addPath);
+			await this.collectWorkspacePlugins(addPath);
 		} catch (error) {
 			logger.warn(error);
 		}
@@ -148,44 +155,108 @@ export class PackageProvider extends shared.PackageProvider {
 	}
 
 	/**
-	 * 扫描 external/ 约定目录（官方 koishi-scripts 的插件开发目录），
-	 * 收录其中尚未启用的 workspace 插件包。
+	 * 收集 workspaces 声明覆盖的未启用插件包（嵌套 monorepo 兼容）。
 	 *
-	 * Bun 只把被依赖引用的 workspace 包链入 node_modules，未启用的
-	 * external 插件因此不在本机扫描的视野内（yarn 全量链接生态下的
-	 * 自动发现语义失效）——这里显式遍历目录补齐。收录条目带
-	 * ./external/<name> 路径键，前端启用时以该键写入配置（loader 的
-	 * 相对路径解析原生支持；短名不经 node_modules 会解析失败）。
+	 * 以宿主 package.json 的 workspaces 通配为唯一真相源：声明写多深，
+	 * 收录就能看多深——external/ 下克隆的 monorepo 形态插件（packages/
+	 * 子包在二级及更深）无需平铺即可见。Bun 只把被依赖引用的 workspace
+	 * 包链入 node_modules，未启用的插件不在本机扫描视野内（yarn 全量
+	 * 链接生态的自动发现语义失效），这里是唯一补齐入口。
+	 *
+	 * 通配是目录模式，拼上 /package.json 以清单文件为锚点扫描
+	 * （Bun.Glob 的 onlyDirs 语义不可靠，win32 实测返回文件路径且分隔符
+	 * 为反斜杠，归一为 / 后再派生收录键）；负向模式（! 前缀）同样拼
+	 * 锚点后对正向结果做差集——模板对 external 下 node_modules 的负向
+	 * 通配即用于排除搬迁残留的依赖目录（注释里不写通配字面量，
+	 * biome 会把其中的 JSDoc 起始序列误解析成类型）。收录口径与
+	 * LocalScanner 的本机扫描一致：只认三种插件命名前缀，monorepo
+	 * 根（@scope/monorepo 形态）与普通库不进列表；收录键
+	 * ./<相对路径>（loader 的相对路径解析原生支持任意深度）。
 	 */
-	private async collectExternalPackages(
+	private async collectWorkspacePlugins(
 		addPath: (path: string, warm: boolean) => Promise<void>,
 	) {
-		const base = resolve(this.scanner.baseDir, "external");
-		const entries = await readdir(base).catch(() => []);
-		for (const entry of entries) {
-			const dir = join(base, entry);
-			if (!existsSync(join(dir, "package.json"))) continue;
-			try {
-				const manifest = JSON.parse(
-					readFileSync(join(dir, "package.json"), "utf8"),
-				) as { name?: unknown };
-				// 与 LocalScanner 的本机收录口径一致：只认三种插件
-				// 命名前缀，external 下的普通库与杂项目录不进列表
+		const baseDir = this.scanner.baseDir;
+		const patterns = readWorkspacePatterns(baseDir);
+		// 目录通配 → 清单文件锚点（去尾斜杠后拼接；负向模式去掉 ! 前缀）
+		const anchor = (pattern: string) =>
+			`${pattern.replace(/\/+$/, "")}/package.json`;
+		const excluded = new Set<string>();
+		for (const pattern of patterns) {
+			if (!pattern.startsWith("!")) continue;
+			for (const rel of new Bun.Glob(
+				anchor(pattern.slice(1)),
+			).scanSync({ cwd: baseDir })) {
+				excluded.add(normalizeSlashes(rel));
+			}
+		}
+		const seen = new Set<string>();
+		for (const pattern of patterns) {
+			if (pattern.startsWith("!")) continue;
+			for (const rel of new Bun.Glob(
+				anchor(pattern),
+			).scanSync({ cwd: baseDir })) {
+				const manifestPath = normalizeSlashes(rel);
 				if (
-					typeof manifest.name !== "string" ||
-					!/^(koishi-plugin-|@koishi(?:-ce)?\/plugin-)/.test(
-						manifest.name,
-					)
+					excluded.has(manifestPath) ||
+					seen.has(manifestPath)
 				)
 					continue;
-				await addPath(`./external/${entry}`, false);
-			} catch (error) {
-				logger.warn(error);
+				seen.add(manifestPath);
+				try {
+					const manifest = JSON.parse(
+						readFileSync(
+							join(baseDir, manifestPath),
+							"utf8",
+						),
+					) as { name?: unknown };
+					if (
+						typeof manifest.name !== "string" ||
+						!PLUGIN_NAME_PATTERN.test(manifest.name)
+					)
+						continue;
+					await addPath(
+						`./${dirname(manifestPath)}`,
+						false,
+					);
+				} catch (error) {
+					logger.warn(error);
+				}
 			}
 		}
 	}
 }
 
+/**
+ * 读取宿主 package.json 的 workspaces 通配声明；缺失、非数组（如 yarn
+ * no-hoist 的对象形态）或为空时回退模板默认约定——旧项目与 prod 形态
+ * （workspaces 已被脚手架删除）的一级目录可见性不回退。
+ */
+export function readWorkspacePatterns(
+	baseDir: string,
+): string[] {
+	try {
+		const manifest = JSON.parse(
+			readFileSync(join(baseDir, "package.json"), "utf8"),
+		) as { workspaces?: unknown };
+		if (Array.isArray(manifest.workspaces)) {
+			const patterns = manifest.workspaces.filter(
+				(pattern): pattern is string =>
+					typeof pattern === "string",
+			);
+			if (patterns.length) return patterns;
+		}
+	} catch {
+		// 无宿主清单（异常环境）：走兜底约定
+	}
+	return FALLBACK_WORKSPACES;
+}
+
+/** Bun.Glob 的 scan 在 win32 返回反斜杠分隔的相对路径，统一归一为 / */
+function normalizeSlashes(path: string): string {
+	return path.split("\\").join("/");
+}
+
 /**
  * 递归遍历插件配置表并对每个插件键执行回调：`$` 开头的键是内部控制
  * 字段，`group:` 分组键的值内嵌套下一层插件表，其余键原样传入回调。