create-koishi-ce 1.3.1 → 1.4.0

package/src/__tests__/tar-pack.ts

@@ -34,20 +34,26 @@ function paxRecord(key: string, value: string): string {
 	let length = body.length + 2;
 	for (;;) {
 		const prefix = `${length} `;
-		if (prefix.length + body.length === length) return `${prefix}${body}`;
+		if (prefix.length + body.length === length)
+			return `${prefix}${body}`;
 		length = prefix.length + body.length;
 	}
 }
 
 /** 收集条目父目录（含显式目录自身），保证目录条目先于引用内容出现 */
-function collectDirs(entries: readonly TarEntry[]): string[] {
+function collectDirs(
+	entries: readonly TarEntry[],
+): string[] {
 	const dirs = new Set<string>();
 	for (const entry of entries) {
 		if (entry.type === "dir" || entry.path.endsWith("/")) {
 			dirs.add(entry.path.replace(/\/+$/, ""));
 			continue;
 		}
-		let parent = entry.path.slice(0, entry.path.lastIndexOf("/"));
+		let parent = entry.path.slice(
+			0,
+			entry.path.lastIndexOf("/"),
+		);
 		while (parent) {
 			dirs.add(parent);
 			const index = parent.lastIndexOf("/");
@@ -78,7 +84,10 @@ function createHeader(
 	header.set(encoder.encode("00"), 263);
 	// 校验和：先以空格占位，再求和回填（八进制 6 位 + \0 + 空格）
 	header.fill(0x20, 148, 156);
-	const sum = header.reduce((total, byte) => total + byte, 0);
+	const sum = header.reduce(
+		(total, byte) => total + byte,
+		0,
+	);
 	const checksum = `${sum.toString(8).padStart(6, "0")}\0 `;
 	header.set(encoder.encode(checksum), 148);
 	return header;
@@ -111,7 +120,10 @@ function writeOctal(
 }
 
 /** 追加内容块并按 512 补齐 */
-function pushPadded(blocks: Uint8Array[], content: Uint8Array): void {
+function pushPadded(
+	blocks: Uint8Array[],
+	content: Uint8Array,
+): void {
 	blocks.push(content);
 	const rest = content.length % BLOCK;
 	if (rest) blocks.push(new Uint8Array(BLOCK - rest));
@@ -138,10 +150,14 @@ function pushEntry(
 		// pax 扩展头自身也须有非空 name（node-tar 校验「path is
 		// required」，空名会把整条 x 头判为无效并导致后续流错位）；
 		// PaxHeader/ 前缀与 node-tar pack 的命名约定一致
-		blocks.push(createHeader(`PaxHeader/${name}`, "x", body.length));
+		blocks.push(
+			createHeader(`PaxHeader/${name}`, "x", body.length),
+		);
 		pushPadded(blocks, body);
 	}
-	blocks.push(createHeader(name.slice(0, 100), type, size, link));
+	blocks.push(
+		createHeader(name.slice(0, 100), type, size, link),
+	);
 	if (size) pushPadded(blocks, content);
 }
 
@@ -157,8 +173,12 @@ export async function tarPack(
 		blocks.push(createHeader(`${dir}/`, "5", 0));
 	}
 	for (const entry of entries) {
-		if (entry.type === "dir" || entry.path.endsWith("/")) continue;
-		if (entry.type === "symlink" || entry.type === "hardlink") {
+		if (entry.type === "dir" || entry.path.endsWith("/"))
+			continue;
+		if (
+			entry.type === "symlink" ||
+			entry.type === "hardlink"
+		) {
 			const type = entry.type === "symlink" ? "2" : "1";
 			pushEntry(
 				blocks,
@@ -175,7 +195,10 @@ export async function tarPack(
 	}
 	blocks.push(new Uint8Array(BLOCK * 2)); // 归档结束标志（全零块）
 
-	const total = blocks.reduce((sum, block) => sum + block.length, 0);
+	const total = blocks.reduce(
+		(sum, block) => sum + block.length,
+		0,
+	);
 	const raw = new Uint8Array(total);
 	let cursor = 0;
 	for (const block of blocks) {

package/src/__tests__/template.test.ts

@@ -3,7 +3,10 @@
 
 import { expect, test } from "bun:test";
 import { renderManifest } from "../index.ts";
-import { baseManifest, templateFiles } from "../template.ts";
+import {
+	baseManifest,
+	templateFiles,
+} from "../template.ts";
 
 test("内置模板依赖纯度：不含任何 @koishijs / koishi-plugin 官方生态包", () => {
 	const { dependencies, devDependencies } = baseManifest();
@@ -16,10 +19,14 @@ test("内置模板依赖纯度：不含任何 @koishijs / koishi-plugin 官方
 		"@koishijs/loader",
 	]);
 	for (const key of Object.keys(dependencies ?? {})) {
-		expect(guarded.has(key) || key.startsWith("@koishi-ce/")).toBe(true);
+		expect(
+			guarded.has(key) || key.startsWith("@koishi-ce/"),
+		).toBe(true);
 	}
 	for (const key of Object.keys(devDependencies ?? {})) {
-		expect(key === "bun-types" || key.startsWith("@koishi-ce/")).toBe(true);
+		expect(
+			key === "bun-types" || key.startsWith("@koishi-ce/"),
+		).toBe(true);
 	}
 });
 
@@ -29,10 +36,16 @@ test("内置模板 packageManager 钉 Bun，脚本用 Bun Shell 环境变量前
 		scripts: Record<string, string>;
 	};
 	// 本项目只支持 Bun 运行时：packageManager 形如 bun@1.x.y
-	expect(manifest["packageManager"] ?? "").toMatch(/^bun@\d+\.\d+\.\d+/);
+	expect(manifest["packageManager"] ?? "").toMatch(
+		/^bun@\d+\.\d+\.\d+/,
+	);
 	// cross-env 已移除：bun run 走 Bun Shell，环境变量前缀天然跨平台
-	expect(scripts["dev"]).toBe("NODE_ENV=development koishi start");
-	expect(JSON.stringify(manifest)).not.toContain("cross-env");
+	expect(scripts["dev"]).toBe(
+		"NODE_ENV=development koishi start",
+	);
+	expect(JSON.stringify(manifest)).not.toContain(
+		"cross-env",
+	);
 });
 
 test("内置模板以 npm alias 钉住 koishi 裸名，版本保持 4.18.x 冻结线", () => {
@@ -40,7 +53,9 @@ test("内置模板以 npm alias 钉住 koishi 裸名，版本保持 4.18.x 冻
 	expect(typeof request).toBe("string");
 	// alias 形态 npm:@koishi-ce/koishi-shim@^4.18.x——版本若漂出 ^4 区间，
 	// 上游插件的 peer `koishi ^4` 判定为不满足，market UI 会试图改写它
-	expect(request ?? "").toMatch(/^npm:@koishi-ce\/koishi-shim@\^4\./);
+	expect(request ?? "").toMatch(
+		/^npm:@koishi-ce\/koishi-shim@\^4\./,
+	);
 });
 
 test("内置模板钉住 console / core / loader 上游 peer 名，防 Bun 自动装官方全家桶", () => {
@@ -68,49 +83,73 @@ test("内置模板静态文件齐备，koishi.yml 预配 market 镜像源", () =
 		"tsconfig.json",
 		"README.md",
 	]) {
-		expect(templateFiles[file]?.length ?? 0).toBeGreaterThan(0);
+		expect(
+			templateFiles[file]?.length ?? 0,
+		).toBeGreaterThan(0);
 	}
 	expect(templateFiles["koishi.yml"]).toContain(
 		"endpoint: https://registry.koishi.chat/index.json",
 	);
 });
 
-test("koishi.yml 预写策略对齐官方实例：CE 插件装而禁用，官方 adapter/database 只写不装", () => {
+test("koishi.yml 预写策略对齐官方实例：CE 插件全量预装（依赖数据库者禁用），官方 adapter / 未分发 database 只写不装", () => {
 	const yml = templateFiles["koishi.yml"] ?? "";
 	// 依赖数据库 / 暂无需启用的 CE 插件：预装但 ~ 禁用
 	for (const name of [
 		"~admin",
 		"~bind",
+		"~broadcast",
+		"~callme",
 		"~analytics",
 		"~auth",
 		"~dataview",
 		"~rate-limit",
 		"~inspect",
 		"~server-temp",
+		"~mock",
 	]) {
 		expect(yml).toContain(name);
 	}
 	// 无需数据库即可工作的 CE 插件：直接启用
-	for (const name of ["assets-local", "theme-vanilla", "status", "sandbox"]) {
+	for (const name of [
+		"assets-local",
+		"echo",
+		"theme-vanilla",
+		"status",
+		"sandbox",
+	]) {
 		expect(yml).toContain(name);
 	}
-	// 官方 adapter / database 只以 ~ 禁用条目预写（未预装，市场装后启用）
+	// database-sqlite 已随模板预装：依赖在册 + yml 保持 ~ 禁用（启用即可用）
+	expect(
+		baseManifest().dependencies?.[
+			"@koishi-ce/plugin-database-sqlite"
+		],
+	).toBe("^1.0.0");
+	expect(yml).toContain("~database-sqlite");
+	// 官方 adapter / 未再分发的 database 只以 ~ 禁用条目预写（未预装，市场装后启用）
 	for (const name of [
 		"~adapter-discord",
 		"~adapter-telegram",
 		"~adapter-qq",
-		"~database-sqlite",
+		"~database-mongo",
 		"~database-postgres",
 	]) {
 		expect(yml).toContain(name);
 	}
 	// 模板依赖里不得出现官方 adapter / database 包名（只预写不预装）
-	expect(JSON.stringify(baseManifest())).not.toContain("adapter-");
-	expect(JSON.stringify(baseManifest())).not.toContain("database-");
+	expect(JSON.stringify(baseManifest())).not.toContain(
+		"adapter-",
+	);
+	expect(JSON.stringify(baseManifest())).not.toContain(
+		"@koishijs/plugin-database-",
+	);
 });
 
 test("renderManifest 渲染内置模板：常规改写生效，prod 模式保留 koishi alias", () => {
-	const output = JSON.parse(renderManifest(baseManifest(), "my-app", false));
+	const output = JSON.parse(
+		renderManifest(baseManifest(), "my-app", false),
+	);
 	expect(output.name).toBe("my-app");
 	expect(output.private).toBe(true);
 	expect(output.version).toBe("0.0.0");
@@ -120,14 +159,18 @@ test("renderManifest 渲染内置模板：常规改写生效，prod 模式保留
 		"npm:@koishi-ce/koishi-shim@^4.18.11",
 	);
 
-	const prod = JSON.parse(renderManifest(baseManifest(), "my-app", true));
+	const prod = JSON.parse(
+		renderManifest(baseManifest(), "my-app", true),
+	);
 	expect("workspaces" in prod).toBe(false);
 	expect("devDependencies" in prod).toBe(false);
 	// 四个上游名 alias 是运行时依赖，prod 模式下必须原样保留
-	expect(prod.dependencies.koishi).toBe("npm:@koishi-ce/koishi-shim@^4.18.11");
-	expect(prod.dependencies["@koishijs/plugin-console"]).toBe(
-		"npm:@koishi-ce/console-shim@^5.30.11",
+	expect(prod.dependencies.koishi).toBe(
+		"npm:@koishi-ce/koishi-shim@^4.18.11",
 	);
+	expect(
+		prod.dependencies["@koishijs/plugin-console"],
+	).toBe("npm:@koishi-ce/console-shim@^5.30.11");
 	expect(prod.dependencies["@koishijs/core"]).toBe(
 		"npm:@koishi-ce/koishi-shim@4.18.11",
 	);

package/src/index.ts

@@ -23,24 +23,45 @@
  * - template.ts   内置 @koishi-ce 模板（静态文件与 baseManifest）
  */
 import { spawnSync } from "node:child_process";
-import { existsSync, mkdirSync, readdirSync, writeFileSync } from "node:fs";
+import {
+	existsSync,
+	mkdirSync,
+	readdirSync,
+	writeFileSync,
+} from "node:fs";
 import { basename, join, relative } from "node:path";
 import { parseArgs } from "node:util";
 import * as p from "@clack/prompts";
 import pc from "picocolors";
 import pkg from "../package.json" with { type: "json" };
-import { type Manifest, renderManifest } from "./manifest.ts";
-import { getLocalRegistry, readNpmrcRegistry } from "./registry.ts";
+import {
+	type Manifest,
+	renderManifest,
+} from "./manifest.ts";
+import {
+	getLocalRegistry,
+	readNpmrcRegistry,
+} from "./registry.ts";
 import { scaffoldRemote } from "./remote.ts";
 import { baseManifest, templateFiles } from "./template.ts";
-import { detectAgent, emptyDir, gitConfig, supports } from "./utils.ts";
+import {
+	detectAgent,
+	emptyDir,
+	gitConfig,
+	supports,
+} from "./utils.ts";
 
 const { version } = pkg;
 
 export type { Manifest };
 // 公共导出面：与拆分前保持一致（bin.ts 与测试文件按 ../index.ts 的既有
 // 导入路径原样可用）；子模块的其余导出属于包内部实现，不在此暴露。
-export { detectAgent, getLocalRegistry, readNpmrcRegistry, renderManifest };
+export {
+	detectAgent,
+	getLocalRegistry,
+	readNpmrcRegistry,
+	renderManifest,
+};
 
 /** CLI 参数（node:util parseArgs 解析，别名映射见 bin 帮助文本） */
 interface Args {
@@ -92,7 +113,8 @@ async function getName(): Promise<string> {
 	const answer = await p.text({
 		message: "项目名：",
 		initialValue: "koishi-app",
-		validate: (value) => (value?.trim() ? undefined : "项目名不能为空"),
+		validate: (value) =>
+			value?.trim() ? undefined : "项目名不能为空",
 	});
 	if (p.isCancel(answer)) process.exit(0);
 	const trimmed = answer.trim();
@@ -102,7 +124,10 @@ async function getName(): Promise<string> {
 
 /** 交互式确认框：返回用户是否选择了「是」（Ctrl+C 取消直接退出） */
 async function confirm(message: string) {
-	const answer = await p.confirm({ message, initialValue: true });
+	const answer = await p.confirm({
+		message,
+		initialValue: true,
+	});
 	if (p.isCancel(answer)) process.exit(0);
 	return answer === true;
 }
@@ -121,7 +146,9 @@ async function prepare() {
 	if (!files.length) return;
 
 	if (!argv.forced && !argv.yes) {
-		console.log(pc.yellow(`  目标目录 "${project}" 非空。`));
+		console.log(
+			pc.yellow(`  目标目录 "${project}" 非空。`),
+		);
 		const yes = await confirm("清空现有文件并继续？");
 		if (!yes) process.exit(0);
 	}
@@ -134,12 +161,18 @@ async function prepare() {
  * 加上由 baseManifest() 渲染出的 package.json。纯本地写入，无网络请求。
  */
 function scaffoldBuiltin() {
-	for (const [file, content] of Object.entries(templateFiles)) {
+	for (const [file, content] of Object.entries(
+		templateFiles,
+	)) {
 		writeFileSync(join(rootDir, file), content);
 	}
 	writeFileSync(
 		join(rootDir, "package.json"),
-		renderManifest(baseManifest(), project, argv.prod === true),
+		renderManifest(
+			baseManifest(),
+			project,
+			argv.prod === true,
+		),
 	);
 }
 
@@ -149,7 +182,9 @@ function scaffoldBuiltin() {
  * scaffoldRemote），registry 取值 --registry 参数 > 本机 npm 配置 > 官方源。
  */
 async function scaffold() {
-	console.log(pc.dim("  正在 ") + project + pc.dim(" 中生成项目 ..."));
+	console.log(
+		pc.dim("  正在 ") + project + pc.dim(" 中生成项目 ..."),
+	);
 
 	if (argv.template) {
 		const registry = (
@@ -181,8 +216,13 @@ async function scaffold() {
 async function initGit() {
 	if (!argv.git || !supports(["git", "--version"])) return;
 	const branch = gitConfig("init.defaultBranch") || "main";
-	spawnSync("git", ["init", "-b", branch], { stdio: "ignore", cwd: rootDir });
-	console.log(pc.green(`  已初始化 git 仓库（分支 ${branch}）。\n`));
+	spawnSync("git", ["init", "-b", branch], {
+		stdio: "ignore",
+		cwd: rootDir,
+	});
+	console.log(
+		pc.green(`  已初始化 git 仓库（分支 ${branch}）。\n`),
+	);
 }
 
 /**
@@ -194,7 +234,8 @@ async function install() {
 	if (argv.yes) return;
 
 	const agent = detectAgent();
-	const startArgs = agent === "yarn" ? ["start"] : ["run", "start"];
+	const startArgs =
+		agent === "yarn" ? ["start"] : ["run", "start"];
 	const yes = await confirm("现在安装依赖并启动吗？");
 	if (yes) {
 		const installed = spawnSync(agent, ["install"], {
@@ -202,19 +243,30 @@ async function install() {
 			cwd: rootDir,
 		});
 		if (installed.status !== 0) {
-			console.log(pc.red("  依赖安装失败，请检查上方日志。"));
+			console.log(
+				pc.red("  依赖安装失败，请检查上方日志。"),
+			);
 			return;
 		}
-		spawnSync(agent, startArgs, { stdio: "inherit", cwd: rootDir });
+		spawnSync(agent, startArgs, {
+			stdio: "inherit",
+			cwd: rootDir,
+		});
 	} else {
 		console.log(pc.dim("  稍后可以这样启动：\n"));
 		if (rootDir !== cwd) {
 			const related = relative(cwd, rootDir);
 			console.log(pc.blue(`  cd ${pc.bold(related)}`));
 		}
-		console.log(pc.blue(`  ${agent === "yarn" ? "yarn" : `${agent} install`}`));
 		console.log(
-			pc.blue(`  ${agent === "yarn" ? "yarn" : `${agent} run`} start`),
+			pc.blue(
+				`  ${agent === "yarn" ? "yarn" : `${agent} install`}`,
+			),
+		);
+		console.log(
+			pc.blue(
+				`  ${agent === "yarn" ? "yarn" : `${agent} run`} start`,
+			),
 		);
 		console.log();
 	}
@@ -243,7 +295,9 @@ export async function start() {
 	}
 
 	console.log();
-	console.log(`  ${pc.bold("Create Koishi")}  ${pc.blue(`v${version}`)}`);
+	console.log(
+		`  ${pc.bold("Create Koishi")}  ${pc.blue(`v${version}`)}`,
+	);
 	console.log();
 
 	const name = await getName();

package/src/registry.ts

@@ -16,10 +16,16 @@ import { join } from "node:path";
  * 从单个 .npmrc 文件提取 registry 配置项（非注释、非 scoped 的 registry= 行）。
  * 文件不存在或未配置时返回 undefined，读文件异常一律静默吞掉。
  */
-export function readNpmrcRegistry(file: string): string | undefined {
+export function readNpmrcRegistry(
+	file: string,
+): string | undefined {
 	try {
-		for (const line of readFileSync(file, "utf8").split(/\r?\n/)) {
-			const matched = /^\s*registry\s*=\s*(\S+)\s*$/.exec(line);
+		for (const line of readFileSync(file, "utf8").split(
+			/\r?\n/,
+		)) {
+			const matched = /^\s*registry\s*=\s*(\S+)\s*$/.exec(
+				line,
+			);
 			const value = matched?.[1];
 			if (value) return value;
 		}
@@ -44,7 +50,10 @@ export function getLocalRegistry(
 		readNpmrcRegistry(join(userHome, ".npmrc")),
 	];
 	for (const candidate of candidates) {
-		if (candidate?.startsWith("https://") || candidate?.startsWith("http://")) {
+		if (
+			candidate?.startsWith("https://") ||
+			candidate?.startsWith("http://")
+		) {
 			return candidate;
 		}
 	}

package/src/remote.ts

@@ -16,7 +16,10 @@ import { readFileSync, writeFileSync } from "node:fs";
 import { join } from "node:path";
 import { downloadTemplate } from "giget";
 import pc from "picocolors";
-import { type Manifest, renderManifest } from "./manifest.ts";
+import {
+	type Manifest,
+	renderManifest,
+} from "./manifest.ts";
 
 /** registry 包元数据中本流程消费的字段 */
 interface RegistryMeta {
@@ -69,15 +72,25 @@ export async function scaffoldRemote({
 }: RemoteOptions) {
 	try {
 		const metaRes = await fetch(`${registry}/${template}`);
-		if (!metaRes.ok) throw new HttpError(metaRes.status, metaRes.statusText);
+		if (!metaRes.ok)
+			throw new HttpError(
+				metaRes.status,
+				metaRes.statusText,
+			);
 		const remote = (await metaRes.json()) as RegistryMeta;
 		const version = remote["dist-tags"][ref];
 		if (version === undefined) {
-			throw new HttpError(404, `模板 ${template}@${ref} 不存在`);
+			throw new HttpError(
+				404,
+				`模板 ${template}@${ref} 不存在`,
+			);
 		}
 		const url = remote.versions[version]?.dist?.tarball;
 		if (url === undefined) {
-			throw new HttpError(404, `模板 ${template}@${ref} 不存在`);
+			throw new HttpError(
+				404,
+				`模板 ${template}@${ref} 不存在`,
+			);
 		}
 
 		// 解包交给 giget：provider 的 tar 字段是函数，giget 需要时才发起
@@ -93,7 +106,10 @@ export async function scaffoldRemote({
 					tar: async () => {
 						const tarballRes = await fetch(url);
 						if (!tarballRes.ok || !tarballRes.body) {
-							throw new HttpError(tarballRes.status, tarballRes.statusText);
+							throw new HttpError(
+								tarballRes.status,
+								tarballRes.statusText,
+							);
 						}
 						return tarballRes.body;
 					},
@@ -113,8 +129,17 @@ export async function scaffoldRemote({
 }
 
 /** 把改写结果写回下载解包出的 package.json */
-function writePackageJson(rootDir: string, project: string, prod: boolean) {
+function writePackageJson(
+	rootDir: string,
+	project: string,
+	prod: boolean,
+) {
 	const filename = join(rootDir, "package.json");
-	const meta = JSON.parse(readFileSync(filename, "utf8")) as Manifest;
-	writeFileSync(filename, renderManifest(meta, project, prod));
+	const meta = JSON.parse(
+		readFileSync(filename, "utf8"),
+	) as Manifest;
+	writeFileSync(
+		filename,
+		renderManifest(meta, project, prod),
+	);
 }

package/src/template/README.md

@@ -18,8 +18,9 @@ bun run dev          # 启动（开发模式，启用 HMR 热更新）
 
 ## 预装与预写
 
-- **已预装**：基础与控制台插件（@koishi-ce 全家桶）。其中依赖数据库的（admin / bind / analytics / auth / dataview / rate-limit 等）与暂无需启用的（inspect / server-temp）在 `koishi.yml` 中以 `~` 前缀保持禁用——安装并启用任一数据库插件后，去掉对应 `~` 即可。
-- **只预写、未预装**：adapter（discord / telegram / qq …）与数据库（sqlite / mongo / postgres …）官方插件以 `~` 禁用条目预写在 `koishi.yml` 的 `group:adapter` / `group:storage`——loader 会跳过禁用条目，不安装也能正常启动；需要时在控制台「插件市场」搜索安装，回到配置页点击启用即可。
+- **已预装**：基础与控制台插件（@koishi-ce 全家桶）。其中依赖数据库的（admin / bind / broadcast / callme / analytics / auth / dataview / rate-limit 等）与暂无需启用的（inspect / server-temp / mock）在 `koishi.yml` 中以 `~` 前缀保持禁用——启用任一数据库插件后，去掉对应 `~` 即可。
+- **数据库开箱即用**：`@koishi-ce/plugin-database-sqlite` 已预装（`~database-sqlite` 保持禁用），无需市场安装，在配置页启用即可，数据落在 `data/koishi.db`。
+- **只预写、未预装**：adapter（discord / telegram / qq …）与数据库（mongo / mysql / postgres …）官方插件以 `~` 禁用条目预写在 `koishi.yml` 的 `group:adapter` / `group:storage`——loader 会跳过禁用条目，不安装也能正常启动；需要时在控制台「插件市场」搜索安装，回到配置页点击启用即可。
 
 ## 安装插件
 

package/src/template/koishi.yml

@@ -7,7 +7,10 @@ plugins:
   group:basic:
     ~admin: {}
     ~bind: {}
+    ~broadcast: {}
+    ~callme: {}
     commands: {}
+    echo: {}
     help: {}
     http: {}
     ~inspect: {}
@@ -63,3 +66,4 @@ plugins:
     $if: env.NODE_ENV === 'development'
     hmr:
       root: .
+    ~mock: {}