用途
Bun 是一个一体化的 JavaScript 运行时与工具套件,同时提供运行时、包管理器、打包器和测试运行器,整体以速度为重点。适用场景包括:为新包引入 Bun、从 Node 迁移、编写或调试 Bun 脚本与测试。
选择建议
当新 JavaScript/TypeScript 项目看重安装和启动速度、并希望工具面尽量小时,优先选择 Bun。当需要最广泛的生态兼容性、依赖假定 Node 的原生工具链,或依赖项存在已知的 Bun 不兼容问题时,优先使用 Node。
主要能力
运行时:基于 JavaScriptCore(使用 Zig 编写)实现的高速运行环境,提供许多 Node 兼容 API。
包管理器:bun install 明显快于许多替代方案;锁文件为文本格式的 bun.lock,旧版本使用二进制格式 bun.lockb。
打包器:内置面向应用与库的打包器和转译器。
测试运行器:bun test 提供类似 Jest 的 API。
从 Node 迁移
将 node script.js 替换为 bun run script.js 或 bun script.js。
用 bun install 替代 npm install;该仓库使用 Bun 作为包管理器,package.json 的 preinstall 钩子为 bunx only-allow bun。
大多数包可以工作,但需要验证兼容性;npm 脚本等价物优先使用 bun run。
一次性可执行运行使用 bunx(如 bunx <cmd>),类似 npx。
可复现安装
在 CI 或部署流程中需要可复现安装时,使用 bun install --frozen-lockfile。
与该仓库的集成
该 monorepo 使用 Turborepo 进行编排。仓库 package.json 中定义的常见工作区脚本包括:
校验所有 skill:运行 hr-skills-build validate 任务
bun run validate
添加/移除 skill 后同步元数据
bun run sync
重新生成 skills 目录
bun run catalog
打包可分发的 skill zip
bun run zip
构建所有工作区包
bun run build
运行测试与类型检查
bun run test bun run typecheck
代码检查与格式化
bun run lint bun run lint:md bun run lint:md:fix
该仓库安装 Lefthook 用于 Git 钩子(prepare 脚本运行 lefthook install)。需遵守强制使用 Bun 的 preinstall 钩子(bunx only-allow bun)。
该项目的 CI 建议
在 CI 中先运行 bun install --frozen-lockfile,再尽早运行 bun run typecheck 和 bun run validate,以便快速发现类型或 skill 格式问题。可对 CI 中重复构建使用 turbo 缓存以加速工作负载。
示例
安装与运行
安装依赖(创建或更新 bun.lock)
bun install
运行脚本或文件
bun run dev bun run src/index.ts bun src/index.ts
脚本与环境变量
bun run --env-file=.env dev FOO=bar bun run script.ts
测试
bun test bun test --watch
// test/example.test.ts import { expect, test } from "bun:test";
test("add", () => { expect(1 + 2).toBe(3); });
常见问题与指导
bun install 创建的 node_modules 布局会因大量使用符号链接而有所不同;依赖精确布局的工具可能需要验证。部分较旧或小众依赖可能与 Bun 不兼容,此时可能需要回退到 Node。部署到支持 Bun 的运行时环境时,需确保构建/运行时设置和命令配置正确。