bts.jsonc

bts.jsonc 的作用及其重要性

什么是 bts.jsonc?

bts.jsonc 是一个小型配置文件,在您创建项目时会被写入项目根目录。它记录了您选择的堆栈配置(前端、后端、API、数据库/ORM、认证、附加组件等)。该文件使用 JSONC(支持注释的 JSON)格式,并包含用于编辑器提示的架构。

位置:./bts.jsonc

为什么需要它

  • add 命令需要它来检测您当前的堆栈配置
  • 帮助验证兼容性并预填充合理的默认值

如果 bts.jsonc 缺失,add 命令将无法运行,因为无法检测到项目。

可以安全删除(但有注意事项)

在正常开发过程中可以安全删除;apps/*packages/* 中生成的代码仍然是事实来源。但是,如果您计划以后使用 add 命令,则必须保留 bts.jsonc(或重新创建它),以便 CLI 能够检测到您的项目。

格式

该文件使用支持注释的 JSONC 格式,并包含用于工具的 $schema URL。

// Better-T-Stack 配置文件
// 可以安全删除
{
  "$schema": "https://r2.better-t-stack.dev/schema.json",
  "version": "x.y.z",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "frontend": ["tanstack-router"],
  "backend": "hono",
  "runtime": "bun",
  "database": "sqlite",
  "orm": "drizzle",
  "api": "trpc",
  "auth": "better-auth",
  "addons": ["turborepo"],
  "examples": [],
  "dbSetup": "none",
  "webDeploy": "none",
  "packageManager": "bun"
}

注意事项:

  • 值反映了您在项目创建期间选择的内容
  • 当您运行 add 时,文件可能会更新(例如,附加组件或 webDeploy)

另请参阅:add 命令