create-koishi-ce 1.0.0 → 1.1.0

package/lib/bin.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env bun
-import { r as start } from "./src-D9XdTOrE.mjs";
+import { a as start } from "./src-CUSQBq1d.mjs";
 //#region src/bin.ts
 /**
 * create-koishi-ce 的 CLI 可执行入口：shebang 由 rolldown 原样保留到

package/lib/index.d.ts

@@ -8,7 +8,8 @@ interface Manifest {
   private?: boolean;
   version?: string;
   workspaces?: unknown;
-  devDependencies?: unknown;
+  dependencies?: Record<string, string>;
+  devDependencies?: Record<string, string>;
   [key: string]: unknown;
 }
 /**
@@ -17,6 +18,20 @@ interface Manifest {
  * 本 CLI 自身以 bun 为运行时（bin shebang），能执行即已具备 bun 环境。
  */
 declare function detectAgent(): string;
+/**
+ * 从单个 .npmrc 文件提取 registry 配置项（非注释、非 scoped 的 registry= 行）。
+ * 文件不存在或未配置时返回 undefined，读文件异常一律静默吞掉。
+ */
+declare function readNpmrcRegistry(file: string): string | undefined;
+/**
+ * 读取本机 npm registry 配置（优先级对齐 npm 自身：环境变量 > 项目
+ * .npmrc > 用户 ~/.npmrc）。刻意不 spawn 子进程探测——既有实现按
+ * user-agent 选 `bun config get registry`，而 Bun 没有 config 子命令，
+ * bunx 场景下子进程退出码 1 直接炸掉脚手架；读 npmrc 是零依赖、零
+ * 子进程的等价路径。任何一步都拿不到时返回 undefined，由调用方回落
+ * 官方源。
+ */
+declare function getLocalRegistry(cwd?: string, userHome?: string): string | undefined;
 /**
  * 改写模板的 package.json（纯函数，导出供单测）：替换项目名、标记
  * private、版本归零。
@@ -28,4 +43,4 @@ declare function renderManifest(source: Manifest, project: string, prod: boolean
  */
 declare function start(): Promise<void>;
 //#endregion
-export { Manifest, detectAgent, renderManifest, start };
+export { Manifest, detectAgent, getLocalRegistry, readNpmrcRegistry, renderManifest, start };

package/lib/index.mjs

@@ -1,2 +1,2 @@
-import { n as renderManifest, r as start, t as detectAgent } from "./src-D9XdTOrE.mjs";
-export { detectAgent, renderManifest, start };
+import { a as start, i as renderManifest, n as getLocalRegistry, r as readNpmrcRegistry, t as detectAgent } from "./src-CUSQBq1d.mjs";
+export { detectAgent, getLocalRegistry, readNpmrcRegistry, renderManifest, start };

package/lib/{src-D9XdTOrE.mjs → src-CUSQBq1d.mjs}

@@ -1,29 +1,17 @@
 import { spawnSync } from "node:child_process";
 import { existsSync, mkdirSync, readFileSync, readdirSync, rmSync, writeFileSync } from "node:fs";
+import { homedir } from "node:os";
 import { basename, join, relative } from "node:path";
 import { Readable } from "node:stream";
-import getRegistry from "get-registry";
 import kleur from "kleur";
 import prompts from "prompts";
 import { extract } from "tar";
 import parse from "yargs-parser";
-//#endregion
-//#region src/index.ts
-/**
-* create-koishi-ce 脚手架（npm 包名 create-koishi-ce，目录名为
-* apps/koishi-create，二者不一致是历史遗留，以目录名为准）。
-*
-* 通过 `bunx create-koishi-ce [name]`（npx 亦可）交互式创建 Koishi 机器人
-* 应用项目：确定项目名 → 准备目标目录 → 从 npm registry 下载模板包（默认
-* @koishijs/boilerplate，刻意沿用上游官方模板以保持与上游插件生态一致）
-* 并解包 → 改写 package.json → 按需初始化 git → 询问是否立即安装依赖并
-* 启动。CLI 可执行入口在 src/bin.ts（构建产物 lib/bin.mjs，bin 字段指向
-* 它）；本文件只承载主流程与可单测的纯函数（范式对齐 @koishi-ce/scripts）。
-*/
-const { version } = {
+//#region package.json
+var package_default = {
 	name: "create-koishi-ce",
 	description: "Setup a Koishi application",
-	version: "1.0.0",
+	version: "1.1.0",
 	type: "module",
 	main: "./lib/index.mjs",
 	module: "./lib/index.mjs",
@@ -57,7 +45,6 @@ const { version } = {
 		"@types/yargs-parser": "^21.0.3"
 	},
 	dependencies: {
-		"get-registry": "^1.1.0",
 		"kleur": "^4.1.5",
 		"prompts": "^2.4.2",
 		"tar": "^7.5.22",
@@ -73,6 +60,163 @@ const { version } = {
 		"./package.json": "./package.json"
 	}
 };
+//#endregion
+//#region src/template.ts
+/** 模板静态文件（相对项目根的路径 → 文件内容），package.json 另行渲染 */
+const templateFiles = {
+	".env": [
+		"GITHUB_MIRROR = https://ghproxy.com/https://github.com",
+		"GITHUB_CONTENT_MIRROR = https://ghproxy.com/https://raw.githubusercontent.com",
+		"GRAVATAR_MIRROR = https://cravatar.cn"
+	].join("\n"),
+	".gitignore": ["node_modules/", "data/"].join("\n"),
+	"koishi.yml": [
+		"plugins:",
+		"  group:server:",
+		"    server:",
+		"      port: 5140",
+		"      maxPort: 5149",
+		"  group:basic:",
+		"    ~admin: {}",
+		"    ~bind: {}",
+		"    commands: {}",
+		"    help: {}",
+		"    http: {}",
+		"    ~inspect: {}",
+		"    locales: {}",
+		"    proxy-agent: {}",
+		"  group:console:",
+		"    actions: {}",
+		"    ~analytics: {}",
+		"    ~auth: {}",
+		"    config: {}",
+		"    console:",
+		"      open: true",
+		"    explorer: {}",
+		"    insight: {}",
+		"    logger: {}",
+		"    market:",
+		"      search:",
+		"        endpoint: https://registry.koishi.chat/index.json",
+		"    notifier: {}",
+		"    oobe: {}",
+		"    sandbox: {}",
+		"    status: {}",
+		"  group:develop:",
+		"    $if: env.NODE_ENV === 'development'",
+		"    hmr:",
+		"      root: ."
+	].join("\n"),
+	"tsconfig.json": [
+		"{",
+		"  \"compilerOptions\": {",
+		"    \"target\": \"ESNext\",",
+		"    \"module\": \"ESNext\",",
+		"    \"moduleResolution\": \"bundler\",",
+		"    \"lib\": [\"ESNext\"],",
+		"    \"types\": [\"bun-types\"],",
+		"    \"strict\": true,",
+		"    \"skipLibCheck\": true,",
+		"    \"noEmit\": true,",
+		"    \"allowImportingTsExtensions\": true,",
+		"    \"verbatimModuleSyntax\": true,",
+		"    \"erasableSyntaxOnly\": true",
+		"  },",
+		"  \"include\": [\"plugins/*/src\", \"external/*/src\"]",
+		"}"
+	].join("\n"),
+	"README.md": `# Koishi 机器人项目
+
+由 \`bun create koishi-ce\` 生成，运行于 [@koishi-ce 社区再分发版](https://github.com/Koishi-CE/koishi) 生态。
+
+## 环境要求
+
+- [Bun](https://bun.sh) ≥ 1.2（运行时：koishi CLI 与插件加载链以 Bun 为准）
+
+## 快速开始
+
+\`\`\`bash
+bun install
+bun run start        # 启动（生产模式）
+bun run dev          # 启动（开发模式，启用 HMR 热更新）
+\`\`\`
+
+启动后访问控制台：<http://127.0.0.1:5140>
+
+## 安装插件
+
+推荐在控制台「插件市场」页安装（已预配 registry.koishi.chat 镜像源）；也可以手动 \`bun add <包名>\` 后在 \`koishi.yml\` 中启用。
+
+上游官方 adapter（如 adapter-discord / adapter-telegram）、数据库插件（如 database-sqlite）与社区 koishi-plugin-* 插件均可直接安装：根依赖中的 \`"koishi": "npm:@koishi-ce/koishi-shim@^4.18.11"\` 已把上游生态对 \`koishi\` 的依赖钉回 @koishi-ce 框架（**请勿删除或改写该行**），不会形成第二份框架副本。analytics 等依赖数据库的插件请先安装数据库插件，再去掉配置中对应的 \`~\` 前缀启用。
+
+## 自定义插件
+
+在 \`plugins/\` 目录下创建插件包（可用 \`bun run new <名称>\` 生成骨架），在 \`koishi.yml\` 中以相对路径引用（如 \`./plugins/my-plugin\`）即可启用；Bun 直接加载 TypeScript 源码，无需预编译。
+`
+};
+/**
+* 内置模板的 package.json 基础内容（name/version 会被 renderManifest 覆写，
+* prod 模式下 workspaces 与 devDependencies 会被移除）。
+*/
+function baseManifest() {
+	return {
+		type: "module",
+		workspaces: ["plugins/*", "external/*"],
+		scripts: {
+			start: "koishi start",
+			dev: "cross-env NODE_ENV=development koishi start",
+			new: "koishi-scripts setup"
+		},
+		dependencies: {
+			"@koishi-ce/koishi": "^1.0.0",
+			"@koishi-ce/plugin-actions": "^1.0.0",
+			"@koishi-ce/plugin-admin": "^1.0.0",
+			"@koishi-ce/plugin-analytics": "^1.0.0",
+			"@koishi-ce/plugin-auth": "^1.0.0",
+			"@koishi-ce/plugin-bind": "^1.0.0",
+			"@koishi-ce/plugin-commands": "^1.0.0",
+			"@koishi-ce/plugin-config": "^1.0.0",
+			"@koishi-ce/plugin-console": "^1.0.0",
+			"@koishi-ce/plugin-explorer": "^1.0.0",
+			"@koishi-ce/plugin-help": "^1.0.0",
+			"@koishi-ce/plugin-http": "^1.0.0",
+			"@koishi-ce/plugin-insight": "^1.0.0",
+			"@koishi-ce/plugin-inspect": "^1.0.0",
+			"@koishi-ce/plugin-locales": "^1.0.0",
+			"@koishi-ce/plugin-logger": "^1.0.0",
+			"@koishi-ce/plugin-market": "^1.0.0",
+			"@koishi-ce/plugin-notifier": "^1.0.0",
+			"@koishi-ce/plugin-oobe": "^1.0.0",
+			"@koishi-ce/plugin-proxy-agent": "^1.0.0",
+			"@koishi-ce/plugin-sandbox": "^1.0.0",
+			"@koishi-ce/plugin-server": "^1.0.0",
+			"@koishi-ce/plugin-status": "^1.0.0",
+			koishi: "npm:@koishi-ce/koishi-shim@^4.18.11"
+		},
+		devDependencies: {
+			"@koishi-ce/client": "^1.0.0",
+			"@koishi-ce/plugin-hmr": "^1.0.0",
+			"@koishi-ce/scripts": "^1.0.0",
+			"bun-types": "^1.4.0",
+			"cross-env": "^7.0.3"
+		}
+	};
+}
+//#endregion
+//#region src/index.ts
+/**
+* create-koishi-ce 脚手架（npm 包名 create-koishi-ce，目录名为
+* apps/koishi-create，二者不一致是历史遗留，以目录名为准）。
+*
+* 通过 `bunx create-koishi-ce [name]`（npx 亦可）交互式创建 Koishi 机器人
+* 应用项目：确定项目名 → 准备目标目录 → 写入内置 @koishi-ce 模板（默认，
+* 见 src/template.ts；--template <包名> 可改用 npm registry 远程模板，如
+* 上游官方 @koishijs/boilerplate）→ 按需初始化 git → 询问是否立即安装
+* 依赖并启动。CLI 可执行入口在 src/bin.ts（构建产物 lib/bin.mjs，bin 字段
+* 指向它）；本文件只承载主流程与可单测的纯函数（范式对齐
+* @koishi-ce/scripts）。
+*/
+const { version } = package_default;
 /** fetch 请求非 2xx 时抛出的错误，携带 HTTP 状态码与状态文本 */
 var HttpError = class extends Error {
 	status;
@@ -108,6 +252,34 @@ function detectAgent() {
 	if (ua.startsWith("pnpm")) return "pnpm";
 	return "bun";
 }
+/**
+* 从单个 .npmrc 文件提取 registry 配置项（非注释、非 scoped 的 registry= 行）。
+* 文件不存在或未配置时返回 undefined，读文件异常一律静默吞掉。
+*/
+function readNpmrcRegistry(file) {
+	try {
+		for (const line of readFileSync(file, "utf8").split(/\r?\n/)) {
+			const value = /^\s*registry\s*=\s*(\S+)\s*$/.exec(line)?.[1];
+			if (value) return value;
+		}
+	} catch {}
+}
+/**
+* 读取本机 npm registry 配置（优先级对齐 npm 自身：环境变量 > 项目
+* .npmrc > 用户 ~/.npmrc）。刻意不 spawn 子进程探测——既有实现按
+* user-agent 选 `bun config get registry`，而 Bun 没有 config 子命令，
+* bunx 场景下子进程退出码 1 直接炸掉脚手架；读 npmrc 是零依赖、零
+* 子进程的等价路径。任何一步都拿不到时返回 undefined，由调用方回落
+* 官方源。
+*/
+function getLocalRegistry(cwd = process.cwd(), userHome = homedir()) {
+	const candidates = [
+		process.env["npm_config_registry"],
+		readNpmrcRegistry(join(cwd, ".npmrc")),
+		readNpmrcRegistry(join(userHome, ".npmrc"))
+	];
+	for (const candidate of candidates) if (candidate?.startsWith("https://") || candidate?.startsWith("http://")) return candidate;
+}
 /** 静默执行命令探测其是否可用（如 git --version），失败即视为不可用 */
 function supports(command) {
 	return spawnSync(command[0] ?? "", command.slice(1), { stdio: "ignore" }).status === 0;
@@ -190,18 +362,22 @@ function writePackageJson() {
 	writeFileSync(filename, renderManifest(meta, project, argv.prod === true));
 }
 /**
-* 模板下载与解包的主流程：
-* 1. 确定 npm registry（--registry 参数 > 本机 npm 配置 > 官方源）；
-* 2. 拉取模板包元数据，按 dist-tags 解析目标版本（--ref，默认 latest）；
-* 3. 流式下载 tarball 并解包到目标目录（strip: 1 去掉包根目录层级），
+* 写入内置模板（默认路径）：静态文件（src/template.ts 的 templateFiles）
+* 加上由 baseManifest() 渲染出的 package.json。纯本地写入，无网络请求。
+*/
+function scaffoldBuiltin() {
+	for (const [file, content] of Object.entries(templateFiles)) writeFileSync(join(rootDir, file), content);
+	writeFileSync(join(rootDir, "package.json"), renderManifest(baseManifest(), project, argv.prod === true));
+}
+/**
+* 远程模板下载与解包（--template 指定时）：
+* 1. 拉取模板包元数据，按 dist-tags 解析目标版本（--ref，默认 latest）；
+* 2. 流式下载 tarball 并解包到目标目录（strip: 1 去掉包根目录层级），
 *    网络错误统一以 HttpError 提示后退出；
-* 4. 最后改写 package.json。
+* 3. 最后改写 package.json。
 */
-async function scaffold() {
-	console.log(kleur.dim("  正在 ") + project + kleur.dim(" 中生成项目 ..."));
-	const registry = (argv.registry || await getRegistry() || "https://registry.npmjs.org").replace(/\/$/, "");
-	console.log(kleur.dim(`  使用 registry：${registry}\n`));
-	const template = argv.template || "@koishijs/boilerplate";
+async function scaffoldRemote(registry) {
+	const template = argv.template;
 	const ref = argv.ref || "latest";
 	try {
 		const metaRes = await fetch(`${registry}/${template}`);
@@ -226,6 +402,19 @@ async function scaffold() {
 		process.exit(1);
 	}
 	writePackageJson();
+}
+/**
+* 生成项目的主入口：默认写内置 @koishi-ce 模板（scaffoldBuiltin）；
+* --template <包名> 时改为从 npm registry 下载远程模板（scaffoldRemote），
+* registry 取值 --registry 参数 > 本机 npm 配置 > 官方源。
+*/
+async function scaffold() {
+	console.log(kleur.dim("  正在 ") + project + kleur.dim(" 中生成项目 ..."));
+	if (argv.template) {
+		const registry = (argv.registry || getLocalRegistry() || "https://registry.npmjs.org").replace(/\/$/, "");
+		console.log(kleur.dim(`  使用 registry：${registry}\n`));
+		await scaffoldRemote(registry);
+	} else scaffoldBuiltin();
 	console.log(kleur.green("  完成。\n"));
 }
 /**
@@ -286,8 +475,8 @@ async function start() {
   用法：create-koishi-ce [名称] [选项]
 
   选项：
-    -t, --template <名称>   模板包名（默认 @koishijs/boilerplate）
-    -r, --ref <引用>        模板版本引用（默认 latest）
+    -t, --template <名称>   从 npm registry 下载指定模板包（默认使用内置 @koishi-ce 模板）
+    -r, --ref <引用>        远程模板版本引用（默认 latest）
     -f, --forced            强制清空目标目录
     -g, --git               初始化 git 仓库
         --registry <地址>   指定 npm registry（如 https://registry.npmmirror.com）
@@ -309,4 +498,4 @@ async function start() {
 	await install();
 }
 //#endregion
-export { renderManifest as n, start as r, detectAgent as t };
+export { start as a, renderManifest as i, getLocalRegistry as n, readNpmrcRegistry as r, detectAgent as t };

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "create-koishi-ce",
 	"description": "Setup a Koishi application",
-	"version": "1.0.0",
+	"version": "1.1.0",
 	"type": "module",
 	"main": "./lib/index.mjs",
 	"module": "./lib/index.mjs",
@@ -47,7 +47,6 @@
 		"@types/yargs-parser": "^21.0.3"
 	},
 	"dependencies": {
-		"get-registry": "^1.1.0",
 		"kleur": "^4.1.5",
 		"prompts": "^2.4.2",
 		"tar": "^7.5.22",

package/src/__tests__/registry.test.ts

@@ -0,0 +1,54 @@
+import { expect, test } from "bun:test";
+import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { getLocalRegistry, readNpmrcRegistry } from "../index.ts";
+
+test("readNpmrcRegistry：提取首个 registry= 行，忽略注释与空行", () => {
+	const dir = mkdtempSync(join(tmpdir(), "ckc-npmrc-"));
+	const file = join(dir, ".npmrc");
+	writeFileSync(
+		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/");
+	rmSync(dir, { recursive: true, force: true });
+});
+
+test("readNpmrcRegistry：文件不存在或未配置时返回 undefined 而不抛错", () => {
+	expect(
+		readNpmrcRegistry(join(tmpdir(), "ckc-不存在", ".npmrc")),
+	).toBeUndefined();
+	const dir = mkdtempSync(join(tmpdir(), "ckc-npmrc-"));
+	const file = join(dir, ".npmrc");
+	writeFileSync(file, "strict-ssl=false\n");
+	expect(readNpmrcRegistry(file)).toBeUndefined();
+	rmSync(dir, { recursive: true, force: true });
+});
+
+test("getLocalRegistry：环境变量优先且校验协议，非法值跳过", () => {
+	const key = "npm_config_registry";
+	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();
+	delete process.env[key];
+	rmSync(isolated, { recursive: true, force: true });
+});
+
+test("getLocalRegistry：项目 .npmrc 优先于用户级 .npmrc，均无配置时返回 undefined", () => {
+	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/");
+	// 目录与用户级均无 .npmrc 时返回 undefined，主流程回落官方源
+	expect(getLocalRegistry(emptyHome, emptyHome)).toBeUndefined();
+	rmSync(dir, { recursive: true, force: true });
+	rmSync(emptyHome, { recursive: true, force: true });
+});