当前位置：首页 > news >正文

如何高效配置create-better-t-stack项目：BTS配置文件完整解析与自定义指南

news 2026/4/16 4:28:29

如何高效配置create-better-t-stack项目：BTS配置文件完整解析与自定义指南

【免费下载链接】create-better-t-stackA modern CLI tool for scaffolding end-to-end type-safe TypeScript projects with best practices and customizable configurations项目地址: https://gitcode.com/gh_mirrors/cr/create-better-t-stack

create-better-t-stack是一个现代化的CLI工具，用于搭建端到端类型安全的TypeScript项目，提供最佳实践和可自定义配置。本文将深入解析BTS配置文件（bts.jsonc）的结构和自定义方法，帮助你轻松掌控项目配置。

BTS配置文件基础

BTS配置文件（bts.jsonc）是create-better-t-stack项目的核心配置文件，它存储了项目的所有关键设置。该文件采用JSONC格式（带注释的JSON），位于项目根目录下。

你可以通过readBtsConfig函数读取配置文件，该函数定义在apps/cli/src/utils/bts-config.ts中。配置文件的结构由BetterTStackConfig接口定义，位于packages/types/src/types.ts。

配置文件基本结构

一个典型的BTS配置文件包含以下主要部分：

元数据：版本信息和创建时间
项目核心设置：数据库、ORM、前后端框架等
附加组件配置：各种扩展功能的详细设置
部署选项：Web和服务器部署配置

核心配置选项详解

项目基础设置

BTS配置文件的基础设置决定了项目的整体架构。这些设置包括：

database：数据库类型，可选值包括"none"、"sqlite"、"postgres"、"mysql"、"mongodb"
orm：ORM框架，可选值包括"drizzle"、"prisma"、"mongoose"、"none"
backend：后端框架，可选值包括"hono"、"express"、"fastify"、"elysia"、"convex"等
runtime：运行时环境，可选值包括"bun"、"node"、"workers"、"none"
frontend：前端框架数组，可选值包括"tanstack-router"、"react-router"、"next"、"nuxt"等

这些选项的详细定义可以在packages/types/src/schemas.ts中找到。

示例配置片段

{ "version": "1.0.0", "createdAt": "2023-10-01T12:00:00Z", "database": "postgres", "orm": "prisma", "backend": "hono", "runtime": "bun", "frontend": ["next"], "addons": ["biome", "turborepo"] }

高级自定义选项

附加组件配置

addonOptions字段允许你为各种附加组件提供详细配置。例如：

WXT插件：配置WXT模板和开发端口
Fumadocs：选择Fumadocs模板和设置开发端口
MCP：配置MCP服务器和代理
Ultracite：设置代码检查工具、编辑器集成和代理

这些选项的详细定义可以在packages/types/src/schemas.ts的AddonOptionsSchema中找到。

数据库设置

dbSetupOptions字段用于配置数据库的详细设置，包括：

mode：数据库设置模式，"manual"或"auto"
neon：Neon数据库的详细配置
prismaPostgres：Prisma Postgres的区域设置
turso：Turso数据库的名称和组设置

修改和更新配置

create-better-t-stack提供了updateBtsConfig函数，用于安全地更新配置文件。该函数定义在apps/cli/src/utils/bts-config.ts，可以更新以下配置项：

addons
addonOptions
dbSetupOptions
webDeploy
serverDeploy

示例：添加Biome代码检查工具

import { updateBtsConfig } from "./utils/bts-config"; async function addBiomeAddon(projectDir: string) { await updateBtsConfig(projectDir, { addons: ["biome", "turborepo"] }); }

配置验证和兼容性

BTS配置文件使用Zod模式进行验证，确保配置的有效性。核心验证逻辑在packages/types/src/schemas.ts中定义，特别是BetterTStackConfigSchema和BetterTStackConfigFileSchema。

配置验证会检查各种兼容性规则，例如：

"nx"和"turborepo"不能同时使用
某些数据库和ORM组合是否有效
附加组件之间的依赖关系

实际应用场景

场景1：创建全栈TypeScript应用

要创建一个使用Next.js前端、Hono后端、PostgreSQL数据库和Prisma ORM的项目，你的BTS配置可能如下：

{ "version": "1.0.0", "createdAt": "2023-10-01T12:00:00Z", "database": "postgres", "orm": "prisma", "backend": "hono", "runtime": "bun", "frontend": ["next"], "api": "trpc", "addons": ["biome", "turborepo"], "auth": "better-auth", "dbSetup": "neon" }

场景2：添加MCP支持

要为现有项目添加MCP支持，你可以更新配置：

{ "addons": ["mcp", "biome", "turborepo"], "addonOptions": { "mcp": { "scope": "project", "servers": ["better-t-stack", "shadcn"], "agents": ["cursor", "claude-code"] } } }