create-koishi-ce 1.3.0 → 1.4.0

package/package.json

@@ -1,64 +1,59 @@
 {
-	"name": "create-koishi-ce",
-	"description": "Setup a Koishi application",
-	"version": "1.3.0",
-	"type": "module",
-	"main": "./lib/index.mjs",
-	"module": "./lib/index.mjs",
-	"types": "./lib/index.d.ts",
-	"bin": {
-		"create-koishi-ce": "./lib/bin.mjs"
-	},
-	"files": [
-		"lib",
-		"src"
-	],
-	"contributors": [
-		"Shigma <shigma10826@gmail.com>",
-		"Oppenheymu <oppenheymu@gmail.com>"
-	],
-	"license": "MIT",
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/Koishi-CE/koishi.git",
-		"directory": "apps/koishi-create"
-	},
-	"bugs": {
-		"url": "https://github.com/Koishi-CE/koishi/issues"
-	},
-	"homepage": "https://koishi.chat",
-	"scripts": {
-		"build": "tsdown"
-	},
-	"keywords": [
-		"bot",
-		"chatbot",
-		"koishi",
-		"discord",
-		"telegram",
-		"create",
-		"scaffold",
-		"template",
-		"generator",
-		"boilerplate"
-	],
-	"devDependencies": {
-		"@types/prompts": "^2.4.9",
-		"@types/yargs-parser": "^21.0.3"
-	},
-	"dependencies": {
-		"kleur": "^4.1.5",
-		"prompts": "^2.4.2",
-		"tar": "^7.5.22",
-		"yargs-parser": "^22.0.0"
-	},
-	"exports": {
-		".": {
-			"source": "./src/index.ts",
-			"types": "./lib/index.d.ts",
-			"import": "./lib/index.mjs",
-			"default": "./lib/index.mjs"
-		},
-		"./package.json": "./package.json"
-	}
-}
+    "name": "create-koishi-ce",
+    "description": "Setup a Koishi application",
+    "version": "1.4.0",
+    "type": "module",
+    "main": "./lib/index.mjs",
+    "module": "./lib/index.mjs",
+    "types": "./lib/index.d.ts",
+    "bin": {
+        "create-koishi-ce": "./lib/bin.mjs"
+    },
+    "files": [
+        "lib",
+        "src"
+    ],
+    "contributors": [
+        "Shigma <shigma10826@gmail.com>",
+        "Oppenheymu <oppenheymu@gmail.com>"
+    ],
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/Koishi-CE/koishi.git",
+        "directory": "apps/koishi-create"
+    },
+    "bugs": {
+        "url": "https://github.com/Koishi-CE/koishi/issues"
+    },
+    "homepage": "https://koishi.chat",
+    "scripts": {
+        "build": "tsdown"
+    },
+    "keywords": [
+        "bot",
+        "chatbot",
+        "koishi",
+        "discord",
+        "telegram",
+        "create",
+        "scaffold",
+        "template",
+        "generator",
+        "boilerplate"
+    ],
+    "dependencies": {
+        "@clack/prompts": "^1.7.0",
+        "picocolors": "^1.1.1",
+        "giget": "^3.3.1"
+    },
+    "exports": {
+        ".": {
+            "source": "./src/index.ts",
+            "types": "./lib/index.d.ts",
+            "import": "./lib/index.mjs",
+            "default": "./lib/index.mjs"
+        },
+        "./package.json": "./package.json"
+    }
+}

package/src/__tests__/manifest.test.ts

@@ -2,7 +2,11 @@
 // Copyright (c) 2026-present Koishi-CE contributors.
 
 import { expect, test } from "bun:test";
-import { detectAgent, type Manifest, renderManifest } from "../index.ts";
+import {
+	detectAgent,
+	type Manifest,
+	renderManifest,
+} from "../index.ts";
 
 test("renderManifest 基础改写：替换项目名、标记 private、版本归零", () => {
 	const source: Manifest = {
@@ -11,7 +15,9 @@ test("renderManifest 基础改写：替换项目名、标记 private、版本归
 		workspaces: ["koishi-app/*"],
 		scripts: { start: "koishi start" },
 	};
-	const output = JSON.parse(renderManifest(source, "my-app", false));
+	const output = JSON.parse(
+		renderManifest(source, "my-app", false),
+	);
 	expect(output.name).toBe("my-app");
 	expect(output.private).toBe(true);
 	expect(output.version).toBe("0.0.0");
@@ -19,7 +25,9 @@ test("renderManifest 基础改写：替换项目名、标记 private、版本归
 	expect(output.scripts).toEqual({ start: "koishi start" });
 	expect(output.workspaces).toEqual(["koishi-app/*"]);
 	// 与模板一致的两空格缩进 + 结尾换行
-	expect(renderManifest(source, "my-app", false).endsWith("}\n")).toBe(true);
+	expect(
+		renderManifest(source, "my-app", false).endsWith("}\n"),
+	).toBe(true);
 });
 
 test("renderManifest prod 模式：删除 workspaces 与 devDependencies", () => {
@@ -28,7 +36,9 @@ test("renderManifest prod 模式：删除 workspaces 与 devDependencies", () =>
 		workspaces: ["koishi-app/*"],
 		devDependencies: { koishi: "^4.18.11" },
 	};
-	const output = JSON.parse(renderManifest(source, "my-app", true));
+	const output = JSON.parse(
+		renderManifest(source, "my-app", true),
+	);
 	expect(output.name).toBe("my-app");
 	expect("workspaces" in output).toBe(false);
 	expect("devDependencies" in output).toBe(false);
@@ -36,7 +46,8 @@ test("renderManifest prod 模式：删除 workspaces 与 devDependencies", () =>
 
 test("detectAgent：yarn / pnpm 跟随探测，其余一律 bun", () => {
 	const key = "npm_config_user_agent";
-	process.env[key] = "npm/10.9.2 node/v22.14.0 x64 workspaces/false";
+	process.env[key] =
+		"npm/10.9.2 node/v22.14.0 x64 workspaces/false";
 	expect(detectAgent()).toBe("bun");
 	process.env[key] = "yarn/1.22.22 npm/? node/v22.14.0 x64";
 	expect(detectAgent()).toBe("yarn");

package/src/__tests__/registry.test.ts

@@ -2,10 +2,17 @@
 // Copyright (c) 2026-present Koishi-CE contributors.
 
 import { expect, test } from "bun:test";
-import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
+import {
+	mkdtempSync,
+	rmSync,
+	writeFileSync,
+} from "node:fs";
 import { tmpdir } from "node:os";
 import { join } from "node:path";
-import { getLocalRegistry, readNpmrcRegistry } from "../index.ts";
+import {
+	getLocalRegistry,
+	readNpmrcRegistry,
+} from "../index.ts";
 
 test("readNpmrcRegistry：提取首个 registry= 行，忽略注释与空行", () => {
 	const dir = mkdtempSync(join(tmpdir(), "ckc-npmrc-"));
@@ -14,13 +21,17 @@ test("readNpmrcRegistry：提取首个 registry= 行，忽略注释与空行", (
 		file,
 		"# 注释行\n; 另一种注释\n\nstrict-ssl=false\nregistry=https://registry.npmmirror.com/\r\n@scope:registry=https://example.com/\n",
 	);
-	expect(readNpmrcRegistry(file)).toBe("https://registry.npmmirror.com/");
+	expect(readNpmrcRegistry(file)).toBe(
+		"https://registry.npmmirror.com/",
+	);
 	rmSync(dir, { recursive: true, force: true });
 });
 
 test("readNpmrcRegistry：文件不存在或未配置时返回 undefined 而不抛错", () => {
 	expect(
-		readNpmrcRegistry(join(tmpdir(), "ckc-不存在", ".npmrc")),
+		readNpmrcRegistry(
+			join(tmpdir(), "ckc-不存在", ".npmrc"),
+		),
 	).toBeUndefined();
 	const dir = mkdtempSync(join(tmpdir(), "ckc-npmrc-"));
 	const file = join(dir, ".npmrc");
@@ -31,14 +42,18 @@ test("readNpmrcRegistry：文件不存在或未配置时返回 undefined 而不
 
 test("getLocalRegistry：环境变量优先且校验协议，非法值跳过", () => {
 	const key = "npm_config_registry";
-	const isolated = mkdtempSync(join(tmpdir(), "ckc-npmrc-"));
+	const isolated = mkdtempSync(
+		join(tmpdir(), "ckc-npmrc-"),
+	);
 	process.env[key] = "https://registry.example.com/";
 	expect(getLocalRegistry(isolated, isolated)).toBe(
 		"https://registry.example.com/",
 	);
 	// 非 http(s) 的值视为未配置，继续走后续候选
 	process.env[key] = "ftp://not-a-registry/";
-	expect(getLocalRegistry(isolated, isolated)).toBeUndefined();
+	expect(
+		getLocalRegistry(isolated, isolated),
+	).toBeUndefined();
 	delete process.env[key];
 	rmSync(isolated, { recursive: true, force: true });
 });
@@ -47,11 +62,20 @@ test("getLocalRegistry：项目 .npmrc 优先于用户级 .npmrc，均无配置
 	const key = "npm_config_registry";
 	delete process.env[key];
 	const dir = mkdtempSync(join(tmpdir(), "ckc-npmrc-"));
-	const emptyHome = mkdtempSync(join(tmpdir(), "ckc-home-"));
-	writeFileSync(join(dir, ".npmrc"), "registry=http://localhost:4873/\n");
-	expect(getLocalRegistry(dir, emptyHome)).toBe("http://localhost:4873/");
+	const emptyHome = mkdtempSync(
+		join(tmpdir(), "ckc-home-"),
+	);
+	writeFileSync(
+		join(dir, ".npmrc"),
+		"registry=http://localhost:4873/\n",
+	);
+	expect(getLocalRegistry(dir, emptyHome)).toBe(
+		"http://localhost:4873/",
+	);
 	// 目录与用户级均无 .npmrc 时返回 undefined，主流程回落官方源
-	expect(getLocalRegistry(emptyHome, emptyHome)).toBeUndefined();
+	expect(
+		getLocalRegistry(emptyHome, emptyHome),
+	).toBeUndefined();
 	rmSync(dir, { recursive: true, force: true });
 	rmSync(emptyHome, { recursive: true, force: true });
 });

package/src/__tests__/run-default.test.ts

@@ -1,7 +1,14 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) 2026-present Koishi-CE contributors.
 
-import { afterAll, beforeAll, describe, expect, it, mock } from "bun:test";
+import {
+	afterAll,
+	beforeAll,
+	describe,
+	expect,
+	it,
+	mock,
+} from "bun:test";
 import { spawnSync } from "node:child_process";
 import {
 	existsSync,
@@ -19,12 +26,14 @@ import { basename, join } from "node:path";
  * start() 默认（内置模板）主流程的端到端测试。
  *
  * 手段：把 process.argv 指为无位置参数 + --git，chdir 到临时目录后动态
- * 导入被测模块（其内部 cwd / argv 在模块顶层固化）；prompts 与
+ * 导入被测模块（其内部 cwd / argv 在模块顶层固化）；@clack/prompts 与
  * node:child_process 均 mock，分别提供可编程的问询答案与子进程记录，
  * process.exit 替换为可捕获的异常，从而覆盖全部交互分支。
  */
 
-const workspaceRoot = mkdtempSync(join(tmpdir(), "ckc-run-default-"));
+const workspaceRoot = mkdtempSync(
+	join(tmpdir(), "ckc-run-default-"),
+);
 const previousCwd = process.cwd();
 const previousArgv = process.argv.slice();
 const previousExit = process.exit;
@@ -34,21 +43,23 @@ const hadUserAgent = userAgentKey in process.env;
 const previousUserAgent = process.env[userAgentKey];
 delete process.env[userAgentKey];
 
-/** prompts 的可编程答案队列（按 type 分发） */
+/** @clack/prompts 的可编程答案队列（按 prompt 类型分发） */
 const nameAnswers: string[] = [];
 const confirmAnswers: boolean[] = [];
 
-mock.module("prompts", () => ({
-	default: async (question: { type?: string }) => {
-		if (question.type === "confirm") {
-			return { yes: confirmAnswers.shift() ?? false };
-		}
-		return { name: nameAnswers.shift() ?? "" };
-	},
+mock.module("@clack/prompts", () => ({
+	text: async () => nameAnswers.shift() ?? "",
+	confirm: async () => confirmAnswers.shift() ?? false,
+	isCancel: (value: unknown) => typeof value === "symbol",
+	cancel: () => {},
 }));
 
 /** spawnSync 的调用记录与可编程行为 */
-const spawnLog: Array<{ cmd: string; args: string[]; cwd?: string }> = [];
+const spawnLog: Array<{
+	cmd: string;
+	args: string[];
+	cwd?: string;
+}> = [];
 let installExit = 0;
 
 // 本文件求值时 node:child_process 恒为真实实现（本仓测试中唯一的
@@ -63,15 +74,21 @@ mock.module("node:child_process", () => ({
 		args: readonly string[],
 		options: { cwd?: string },
 	) => {
-		if (cmd === "git" && args[0] === "--version") return { status: 0 };
-		if (cmd === "git" && args[0] === "config" && args[1] === "--get") {
+		if (cmd === "git" && args[0] === "--version")
+			return { status: 0 };
+		if (
+			cmd === "git" &&
+			args[0] === "config" &&
+			args[1] === "--get"
+		) {
 			const key = args[2];
 			const table: Record<string, string> = {
 				"user.name": "Tester",
 				"user.email": "t@e.st",
 				"init.defaultBranch": "trunk",
 			};
-			const value = key !== undefined ? table[key] : undefined;
+			const value =
+				key !== undefined ? table[key] : undefined;
 			return value === undefined
 				? { status: 1, stdout: "" }
 				: { status: 0, stdout: `${value}\n` };
@@ -80,13 +97,21 @@ mock.module("node:child_process", () => ({
 		spawnLog.push({
 			cmd,
 			args: [...args],
-			...(options.cwd === undefined ? {} : { cwd: options.cwd }),
+			...(options.cwd === undefined
+				? {}
+				: { cwd: options.cwd }),
 		});
 		// 依赖安装可编程；agent 启动不真实拉起
-		if (args[0] === "install") return { status: installExit };
-		if (cmd === "bun" && args[0] === "run") return { status: 0 };
+		if (args[0] === "install")
+			return { status: installExit };
+		if (cmd === "bun" && args[0] === "run")
+			return { status: 0 };
 		// 其余命令透传真实执行（副作用均在各自测试的临时目录内）
-		return realSpawnSync(cmd, args, options as Parameters<typeof spawnSync>[2]);
+		return realSpawnSync(
+			cmd,
+			args,
+			options as Parameters<typeof spawnSync>[2],
+		);
 	},
 }));
 
@@ -104,13 +129,16 @@ process.exit = ((code?: number) => {
 	throw new ExitError(code ?? 0);
 }) as typeof process.exit;
 
-process.argv = [process.argv[0] ?? "bun", "create-koishi-ce", "--git"];
+process.argv = [
+	process.argv[0] ?? "bun",
+	"create-koishi-ce",
+	"--git",
+];
 process.chdir(workspaceRoot);
 // query 强制独立实例（说明与写法见 run-help.test.ts）
 const specifier = "../index.ts?default-run";
-const { start, getLocalRegistry, readNpmrcRegistry } = (await import(
-	specifier
-)) as typeof import("../index.ts");
+const { start, getLocalRegistry, readNpmrcRegistry } =
+	(await import(specifier)) as typeof import("../index.ts");
 // cwd 已在被测模块内固化，立即切回，缩小对进程全局的影响窗口
 process.chdir(previousCwd);
 
@@ -152,20 +180,32 @@ function expectTemplateFiles(dir: string): void {
 	) as Record<string, unknown>;
 	expect(manifest["private"]).toBe(true);
 	expect(manifest["version"]).toBe("0.0.0");
-	expect(manifest["workspaces"]).toEqual(["plugins/*", "external/*"]);
+	expect(manifest["workspaces"]).toEqual([
+		"plugins/*",
+		"external/*",
+	]);
 }
 
 describe("create-koishi-ce 默认模板主流程", () => {
 	// 补齐本实例下纯函数分支的行覆盖（registry 既有测试走的是共享实例）
 	it("registry 探测纯函数在本实例同样可用", () => {
 		const npmrc = join(workspaceRoot, ".npmrc");
-		writeFileSync(npmrc, "registry=https://registry.example.com/\n");
-		expect(readNpmrcRegistry(npmrc)).toBe("https://registry.example.com/");
-		expect(readNpmrcRegistry(join(workspaceRoot, "absent"))).toBeUndefined();
-		expect(getLocalRegistry(workspaceRoot, workspaceRoot)).toBe(
+		writeFileSync(
+			npmrc,
+			"registry=https://registry.example.com/\n",
+		);
+		expect(readNpmrcRegistry(npmrc)).toBe(
 			"https://registry.example.com/",
 		);
-		expect(getLocalRegistry(workspaceRoot, workspaceRoot)).toBeDefined();
+		expect(
+			readNpmrcRegistry(join(workspaceRoot, "absent")),
+		).toBeUndefined();
+		expect(
+			getLocalRegistry(workspaceRoot, workspaceRoot),
+		).toBe("https://registry.example.com/");
+		expect(
+			getLocalRegistry(workspaceRoot, workspaceRoot),
+		).toBeDefined();
 		rmSync(npmrc, { force: true });
 	});
 
@@ -178,7 +218,10 @@ describe("create-koishi-ce 默认模板主流程", () => {
 		expect(
 			(
 				JSON.parse(
-					readFileSync(join(workspaceRoot, "package.json"), "utf8"),
+					readFileSync(
+						join(workspaceRoot, "package.json"),
+						"utf8",
+					),
 				) as Record<string, unknown>
 			)["name"],
 		).toBe(basename(workspaceRoot));
@@ -196,7 +239,10 @@ describe("create-koishi-ce 默认模板主流程", () => {
 		expect(
 			(
 				JSON.parse(
-					readFileSync(join(workspaceRoot, "app-a", "package.json"), "utf8"),
+					readFileSync(
+						join(workspaceRoot, "app-a", "package.json"),
+						"utf8",
+					),
 				) as Record<string, unknown>
 			)["name"],
 		).toBe("app-a");
@@ -226,8 +272,12 @@ describe("create-koishi-ce 默认模板主流程", () => {
 		writeFileSync(join(dir, "occupier.txt"), "保留我");
 		nameAnswers.push("app-b");
 		confirmAnswers.push(false);
-		await expect(start()).rejects.toThrow("process.exit(0)");
-		expect(readFileSync(join(dir, "occupier.txt"), "utf8")).toBe("保留我");
+		await expect(start()).rejects.toThrow(
+			"process.exit(0)",
+		);
+		expect(
+			readFileSync(join(dir, "occupier.txt"), "utf8"),
+		).toBe("保留我");
 	});
 
 	it("用户确认清空：emptyDir 后重建模板", async () => {
@@ -235,14 +285,18 @@ describe("create-koishi-ce 默认模板主流程", () => {
 		nameAnswers.push("app-b");
 		confirmAnswers.push(true);
 		await start();
-		expect(existsSync(join(dir, "occupier.txt"))).toBe(false);
+		expect(existsSync(join(dir, "occupier.txt"))).toBe(
+			false,
+		);
 		expectTemplateFiles(dir);
 		logs.length = 0;
 	});
 
 	it("项目名问询被取消（空白输入）：直接退出", async () => {
 		nameAnswers.push("   ");
-		await expect(start()).rejects.toThrow("process.exit(0)");
+		await expect(start()).rejects.toThrow(
+			"process.exit(0)",
+		);
 	});
 
 	it("依赖安装失败：提示后不再尝试启动", async () => {
@@ -268,11 +322,14 @@ describe("create-koishi-ce 默认模板主流程", () => {
 		expect(output).toContain("cd");
 		expect(output).toContain("bun install");
 		expect(output).toContain("bun run start");
-		expect(existsSync(join(workspaceRoot, "sub", "app-c", "koishi.yml"))).toBe(
-			true,
-		);
 		expect(
-			readdirSync(join(workspaceRoot, "sub", "app-c")).length,
+			existsSync(
+				join(workspaceRoot, "sub", "app-c", "koishi.yml"),
+			),
+		).toBe(true);
+		expect(
+			readdirSync(join(workspaceRoot, "sub", "app-c"))
+				.length,
 		).toBeGreaterThan(0);
 	});
 });

package/src/__tests__/run-help.test.ts

@@ -1,7 +1,13 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) 2026-present Koishi-CE contributors.
 
-import { afterAll, beforeAll, describe, expect, it } from "bun:test";
+import {
+	afterAll,
+	beforeAll,
+	describe,
+	expect,
+	it,
+} from "bun:test";
 
 /**
  * start() 的 --help 分支：打印用法后直接返回（不产生任何写盘）。
@@ -11,7 +17,11 @@ import { afterAll, beforeAll, describe, expect, it } from "bun:test";
 const logs: string[] = [];
 const originalLog = console.log;
 
-process.argv = [process.argv[0] ?? "bun", "create-koishi-ce", "--help"];
+process.argv = [
+	process.argv[0] ?? "bun",
+	"create-koishi-ce",
+	"--help",
+];
 
 // 以 query 强制独立实例：index.ts 顶层固化 argv / cwd，而 bun test 的
 // 模块注册表跨测试文件共享（不带 query 会拿到既有测试文件已加载的
@@ -19,7 +29,9 @@ process.argv = [process.argv[0] ?? "bun", "create-koishi-ce", "--help"];
 // 形式交给运行时（file URL 形式的 query 不参与缓存键；TS 亦不解析
 // 带 query 的说明符），故经变量动态构造，类型以 typeof import() 收紧
 const specifier = "../index.ts?help";
-const { start } = (await import(specifier)) as typeof import("../index.ts");
+const { start } = (await import(
+	specifier
+)) as typeof import("../index.ts");
 
 beforeAll(() => {
 	console.log = (...args: unknown[]) => {
@@ -35,7 +47,9 @@ describe("create-koishi-ce --help", () => {
 	it("打印用法说明后即返回", async () => {
 		await start();
 		const output = logs.join("\n");
-		expect(output).toContain("用法：create-koishi-ce [名称] [选项]");
+		expect(output).toContain(
+			"用法：create-koishi-ce [名称] [选项]",
+		);
 		expect(output).toContain("--template");
 		expect(output).toContain("--prod");
 		// 帮助分支不应询问项目名（无 "项目名：" 提示输出）