create-koishi-ce 1.3.0 → 1.3.1

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.3.1",
+    "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__/run-default.test.ts

@@ -19,7 +19,7 @@ import { basename, join } from "node:path";
  * start() 默认（内置模板）主流程的端到端测试。
  *
  * 手段：把 process.argv 指为无位置参数 + --git，chdir 到临时目录后动态
- * 导入被测模块（其内部 cwd / argv 在模块顶层固化）；prompts 与
+ * 导入被测模块（其内部 cwd / argv 在模块顶层固化）；@clack/prompts 与
  * node:child_process 均 mock，分别提供可编程的问询答案与子进程记录，
  * process.exit 替换为可捕获的异常，从而覆盖全部交互分支。
  */
@@ -34,17 +34,15 @@ 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 的调用记录与可编程行为 */

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

@@ -13,19 +13,22 @@ import {
 } from "node:fs";
 import { tmpdir } from "node:os";
 import { join } from "node:path";
-import { c as tarCreate } from "tar";
+import { tarPack } from "./tar-pack.ts";
 
 /**
  * start() 远程模板分支（--template）的端到端测试。
  *
  * 以 Bun.serve 起本地伪 registry（127.0.0.1 随机端口），按用例切换
  * 场景（正常 / 元数据 404 / dist-tag 缺失 / tarball 404 / tarball 损坏）；
- * tarball 由 tar 包真实打包，scaffoldRemote 的下载-解包-改写全链路真实执行。
+ * tarball 由 __tests__/tar-pack.ts 的 tarPack 打包（ustar + gzip，与真实
+ * npm tarball 同构），scaffoldRemote 的下载-解包-改写全链路真实执行
+ * （解包走 giget，含超长名 pax 条目的端到端验证）。
  *
  * 覆盖率口径说明：bun 的覆盖率对同一路径的多个 query 实例只统计最后
  * 求值的那份，本文件是 koishi-create 全部测试中最后加载的实例，因此
  * 在此补齐 registry 探测纯函数、emptyDir 与 initGit（--git）等只在其它
- * 实例出现过的分支，保证 src/index.ts 的行覆盖完整。
+ * 实例出现过的分支，保证 index.ts 及其子模块（manifest / registry /
+ * utils / remote）的行覆盖完整。
  */
 
 const workspaceRoot = mkdtempSync(join(tmpdir(), "ckc-run-remote-"));
@@ -38,7 +41,10 @@ let scenario: "ok" | "meta-404" | "missing-ref" | "tarball-404" | "corrupt" =
 	"ok";
 
 /** 预先打包好的模板 tarball（package/ 前缀目录，strip:1 解包） */
-let tarball: Buffer;
+let tarball: Uint8Array;
+
+/** 超长文件名（>100 字节，触发 pax 扩展头），归档与落盘共用同一串 */
+const longName = "deep".repeat(30);
 
 // fetch 回调内引用 registry.port，显式标注返回类型以切断 initializer 的循环推断
 const registry = Bun.serve({
@@ -81,16 +87,14 @@ const registry = Bun.serve({
 	},
 });
 
-/** prompts mock：install 的 confirm 默认拒绝，可按用例入队覆盖 */
+/** @clack/prompts mock：install 的 confirm 默认拒绝，可按用例入队覆盖 */
 const confirmAnswers: boolean[] = [];
 
-mock.module("prompts", () => ({
-	default: async (question: { type?: string }) => {
-		if (question.type === "confirm") {
-			return { yes: confirmAnswers.shift() ?? false };
-		}
-		return { name: "" };
-	},
+mock.module("@clack/prompts", () => ({
+	text: async () => "",
+	confirm: async () => confirmAnswers.shift() ?? false,
+	isCancel: (value: unknown) => typeof value === "symbol",
+	cancel: () => {},
 }));
 
 // erasableSyntaxOnly 禁用参数属性，改为显式字段声明
@@ -135,26 +139,32 @@ beforeAll(async () => {
 	console.log = (...args: unknown[]) => {
 		logs.push(args.map((arg) => `${arg}`).join(" "));
 	};
-	// 造模板载荷并打包：package/package.json + package/index.js
-	const payload = join(workspaceRoot, "payload", "package");
-	mkdirSync(payload, { recursive: true });
-	writeFileSync(
-		join(payload, "package.json"),
-		JSON.stringify({
-			name: "fake-tpl",
-			version: "2.0.0",
-			private: false,
-			workspaces: ["src/*"],
-			scripts: { start: "node index.js" },
-		}),
-	);
-	writeFileSync(join(payload, "index.js"), "console.log('tpl');\n");
-	const tarballPath = join(workspaceRoot, "fake-tpl.tgz");
-	await tarCreate(
-		{ file: tarballPath, cwd: join(workspaceRoot, "payload"), portable: true },
-		["package"],
-	);
-	tarball = readFileSync(tarballPath);
+	// 造模板载荷并打包：package/package.json + package/index.js + 超长名文件
+	const encoder = new TextEncoder();
+	tarball = await tarPack([
+		{
+			path: "package/package.json",
+			data: encoder.encode(
+				JSON.stringify({
+					name: "fake-tpl",
+					version: "2.0.0",
+					private: false,
+					workspaces: ["src/*"],
+					scripts: { start: "node index.js" },
+				}),
+			),
+		},
+		{
+			path: "package/index.js",
+			data: encoder.encode("console.log('tpl');\n"),
+		},
+		{
+			// 124 字符 > ustar 的 100 字节 name 上限：tarPack 前置 pax
+			// 扩展头，giget（tar 库）经 pax 还原后同样能正确落盘
+			path: `package/${longName}.txt`,
+			data: encoder.encode("pax"),
+		},
+	]);
 });
 
 afterAll(() => {
@@ -170,6 +180,10 @@ function reset(sc: typeof scenario): void {
 	scenario = sc;
 	logs.length = 0;
 	rmSync(join(workspaceRoot, "myapp"), { recursive: true, force: true });
+	// giget 把 tarball 缓存到系统临时目录（win32 为 tmpdir()/giget，不受
+	// XDG_CACHE_HOME 影响）；逐用例清理，避免上一场景的缓存（tarball-404
+	// 的缺失或 corrupt 的损坏归档）被 giget 的「下载失败回退缓存」吞掉
+	rmSync(join(tmpdir(), "giget"), { recursive: true, force: true });
 }
 
 describe("create-koishi-ce 远程模板", () => {
@@ -178,6 +192,8 @@ describe("create-koishi-ce 远程模板", () => {
 		await start();
 		const dir = join(workspaceRoot, "myapp");
 		expect(existsSync(join(dir, "index.js"))).toBe(true);
+		// 超长名文件经 pax 扩展头正常落盘（tarPack 打包 → giget 解包全链路）
+		expect(readFileSync(join(dir, `${longName}.txt`), "utf8")).toBe("pax");
 		const manifest = JSON.parse(
 			readFileSync(join(dir, "package.json"), "utf8"),
 		) as Record<string, unknown>;

package/src/__tests__/tar-pack.ts

@@ -0,0 +1,188 @@
+// SPDX-License-Identifier: MIT
+// Copyright (c) 2026-present Koishi-CE contributors.
+
+/**
+ * 测试专用 .tgz fixture 构造器（ustar + 超长名 pax 兜底 + gzip）。
+ *
+ * 生产代码的远程模板解包已改走 giget（见 src/index.ts scaffoldRemote），
+ * 这里只保留「打包」一侧供测试构造伪 registry 的 tarball 响应。tar
+ * 归档格式稳定，此工具不随业务演进，故不再单独维护解析逻辑与单测
+ * ——其正确性由 __tests__/run-remote.test.ts 的「打包 → giget 解包」
+ * 端到端链路间接验证。
+ */
+
+import { gzipSync } from "node:zlib";
+
+const BLOCK = 512;
+const encoder = new TextEncoder();
+
+/** 单条目（供 tarPack 构造归档） */
+export interface TarEntry {
+	/** 归档内路径（相对归档根；目录以 / 结尾） */
+	path: string;
+	/** 条目类型（默认 file） */
+	type?: "file" | "dir" | "symlink" | "hardlink";
+	/** 文件内容（file 类型） */
+	data?: Uint8Array;
+	/** 链接目标（symlink / hardlink 类型，归档内相对路径） */
+	link?: string;
+}
+
+/** 构造单条 pax 记录（len 前缀自洽的数字迭代） */
+function paxRecord(key: string, value: string): string {
+	const body = `${key}=${value}\n`;
+	let length = body.length + 2;
+	for (;;) {
+		const prefix = `${length} `;
+		if (prefix.length + body.length === length) return `${prefix}${body}`;
+		length = prefix.length + body.length;
+	}
+}
+
+/** 收集条目父目录（含显式目录自身），保证目录条目先于引用内容出现 */
+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("/"));
+		while (parent) {
+			dirs.add(parent);
+			const index = parent.lastIndexOf("/");
+			parent = index < 0 ? "" : parent.slice(0, index);
+		}
+	}
+	return [...dirs];
+}
+
+/** 构造一个 512 字节的 ustar 头部 */
+function createHeader(
+	name: string,
+	type: string,
+	size: number,
+	link = "",
+): Uint8Array {
+	const header = new Uint8Array(BLOCK);
+	// name / linkname 由调用方保证经 pax 兜底（此处截断仅作占位）
+	header.set(encoder.encode(name), 0);
+	header.set(encoder.encode(link), 157);
+	writeOctal(header, 100, 8, type === "5" ? 0o755 : 0o644); // mode
+	writeOctal(header, 108, 8, 0); // uid
+	writeOctal(header, 116, 8, 0); // gid
+	writeOctal(header, 124, 12, size);
+	writeOctal(header, 136, 12, 0); // mtime
+	header[156] = type.charCodeAt(0) ?? 0;
+	header.set(encoder.encode("ustar\0"), 257);
+	header.set(encoder.encode("00"), 263);
+	// 校验和：先以空格占位，再求和回填（八进制 6 位 + \0 + 空格）
+	header.fill(0x20, 148, 156);
+	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;
+}
+
+/**
+ * 把八进制数字写入定长字段，采用 tar 标准布局：前导 ASCII '0' 填充 +
+ * 数字 + 空格 + '\0' 结尾（对齐 GNU tar / node-tar 的 encSmallNumber）。
+ * 数字必须全部落在字段首个 NUL 之前——部分实现按 `\0` 截断解析，若用
+ * NUL 做前导填充（旧实现写法）会把字段整体读成 0。
+ */
+function writeOctal(
+	block: Uint8Array,
+	offset: number,
+	length: number,
+	value: number,
+): void {
+	const digits = value.toString(8);
+	if (digits.length === length - 1) {
+		// 数字恰好占满（无空格），直接写 NUL 结尾
+		block.set(encoder.encode(digits), offset);
+		block[offset + length - 1] = 0;
+		return;
+	}
+	const before = length - digits.length - 2;
+	block.fill(0x30, offset, offset + before); // 前导 '0'
+	block.set(encoder.encode(digits), offset + before);
+	block[offset + before + digits.length] = 0x20; // 数字与 NUL 间留空格
+	block[offset + length - 1] = 0;
+}
+
+/** 追加内容块并按 512 补齐 */
+function pushPadded(blocks: Uint8Array[], content: Uint8Array): void {
+	blocks.push(content);
+	const rest = content.length % BLOCK;
+	if (rest) blocks.push(new Uint8Array(BLOCK - rest));
+}
+
+/** 追加一个数据条目：超长名（ustar 上限 100 字节）自动前置 pax 扩展头 */
+function pushEntry(
+	blocks: Uint8Array[],
+	name: string,
+	type: string,
+	size: number,
+	content: Uint8Array,
+	link = "",
+): void {
+	const records: string[] = [];
+	if (encoder.encode(name).length > 100) {
+		records.push(paxRecord("path", name));
+	}
+	if (link && encoder.encode(link).length > 100) {
+		records.push(paxRecord("linkpath", link));
+	}
+	if (records.length) {
+		const body = encoder.encode(records.join(""));
+		// pax 扩展头自身也须有非空 name（node-tar 校验「path is
+		// required」，空名会把整条 x 头判为无效并导致后续流错位）；
+		// PaxHeader/ 前缀与 node-tar pack 的命名约定一致
+		blocks.push(createHeader(`PaxHeader/${name}`, "x", body.length));
+		pushPadded(blocks, body);
+	}
+	blocks.push(createHeader(name.slice(0, 100), type, size, link));
+	if (size) pushPadded(blocks, content);
+}
+
+/**
+ * 把条目表打包成 .tgz 字节（ustar + pax 扩展 + gzip）。
+ * 仅供测试构造 fixture；产物与真实 npm tarball 的结构一致。
+ */
+export async function tarPack(
+	entries: readonly TarEntry[],
+): Promise<Uint8Array> {
+	const blocks: Uint8Array[] = [];
+	for (const dir of collectDirs(entries)) {
+		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") {
+			const type = entry.type === "symlink" ? "2" : "1";
+			pushEntry(
+				blocks,
+				entry.path,
+				type,
+				0,
+				new Uint8Array(0),
+				entry.link ?? "",
+			);
+		} else {
+			const data = entry.data ?? new Uint8Array(0);
+			pushEntry(blocks, entry.path, "0", data.length, data);
+		}
+	}
+	blocks.push(new Uint8Array(BLOCK * 2)); // 归档结束标志（全零块）
+
+	const total = blocks.reduce((sum, block) => sum + block.length, 0);
+	const raw = new Uint8Array(total);
+	let cursor = 0;
+	for (const block of blocks) {
+		raw.set(block, cursor);
+		cursor += block.length;
+	}
+
+	// gzip 压缩为 .tgz（与 npm registry 的 tarball 同构）
+	return gzipSync(raw);
+}