lanyuanxiaoyao/bun-app-template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: 新增版本管理系统，重构 /health → /api/meta

Browse Source
This commit is contained in:
兰缘小妖
2026-05-24 23:32:19 +08:00
parent bc54f8352a
commit 7dc3a270ae
23 changed files with 450 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@@ -35,11 +35,10 @@ export const APP = {
title: "Your App", // 人类可读标题
subtitle: "你的副标题", // 副标题
description: "应用描述", // SEO meta 描述
version: "0.1.0", // 版本号
} as const;
```
同时修改 `package.json` 的 `name` 字段保持一致。
同时修改 `package.json` 的 `name` 字段保持一致，`version` 字段管理应用版本号。
> **注意**：localStorage key 已从 `"my-app.theme.preference"` 变更为 `"theme.preference"`。如果从旧版本升级，用户的主题偏好设置将丢失，需重新选择。
@@ -68,19 +67,23 @@ bun run dev
## 项目管理
| 命令 | 说明 |
| -------------------- | ---------------------------------------------------------- |
| `bun run dev` | 启动开发模式（并行启动后端 + 前端 Vite 开发服务器） |
| `bun run dev:server` | 仅启动后端开发服务（`--watch` 热重载） |
| `bun run dev:web` | 仅启动前端 Vite 开发服务器 |
| `bun run build` | 生产构建（Vite 打包前端 → Bun compile 生成独立可执行文件） |
| `bun test` | 运行全部测试 |
| `bun run lint` | ESLint 代码风格检查 |
| `bun run format` | Prettier 代码格式化 |
| `bun run typecheck` | TypeScript 类型检查 |
| `bun run check` | 完整质量检查：typecheck + lint + test |
| `bun run verify` | 验证构建流程：check + build |
| `bun run clean` | 清理构建产物和临时文件 |
| 命令 | 说明 |
| ----------------------- | ---------------------------------------------------------- |
| `bun run dev` | 启动开发模式（并行启动后端 + 前端 Vite 开发服务器） |
| `bun run dev:server` | 仅启动后端开发服务（`--watch` 热重载） |
| `bun run dev:web` | 仅启动前端 Vite 开发服务器 |
| `bun run build` | 生产构建（Vite 打包前端 → Bun compile 生成独立可执行文件） |
| `bun test` | 运行全部测试 |
| `bun run lint` | ESLint 代码风格检查 |
| `bun run format` | Prettier 代码格式化 |
| `bun run typecheck` | TypeScript 类型检查 |
| `bun run check` | 完整质量检查：typecheck + lint + test |
| `bun run verify` | 验证构建流程：check + build |
| `bun run clean` | 清理构建产物和临时文件 |
| `bun run version:patch` | 升迁 patch 版本（x.y.Z） |
| `bun run version:minor` | 升迁 minor 版本（x.Y.0） |
| `bun run version:major` | 升迁 major 版本（X.0.0） |
| `bun run version:set` | 显式设置版本号 |
## 项目结构
@@ -96,7 +99,9 @@ bun run dev
├── .lintstagedrc.json # lint-staged 暂存区检查配置
├── scripts/
│ ├── dev.ts # 开发启动脚本（并行启动 API + Vite）
│ ├── build.ts # 生产构建脚本（Vite → 代码生成 → Bun compile）
│ ├── build.ts # 生产构建脚本（Vite → 代码生成 → Bun compile，含版本号注入）
│ ├── bump-version-logic.ts # 纯版本管理逻辑（parse、validate、bump、format）
│ ├── bump-version.ts # 版本升迁 CLI 脚本
│ └── clean.ts # 清理脚本
├── src/
│ ├── server/ # 后端代码
@@ -108,15 +113,16 @@ bun run dev
│ │ ├── helpers.ts # 共享响应工具（健康检查、JSON 响应）
│ │ ├── middleware.ts # API 参数校验中间件
│ │ ├── static.ts # 静态资源服务
│ │ └── routes/ # API 路由处理器
│ │ └── health.ts # 健康检查端点
│ │ └── routes/ # API 路由处理器
│ │ └── meta.ts # 应用元信息端点（GET /api/meta）
│ │ version.ts # 版本号读取
│ ├── shared/
│ │ ├── api.ts # 前后端共享 TypeScript 类型定义
│ │ └── app.ts # 应用全局常量（name、title、version 等）
│ │ └── app.ts # 应用全局常量（name、title、subtitle、description）
│ └── web/ # 前端代码
│ ├── index.html # HTML 入口
│ ├── main.tsx # React 入口（BrowserRouter + QueryClient + ErrorBoundary）
│ ├── app.tsx # 根组件（Admin 布局：Header + Sidebar + Content）
│ ├── app.tsx # 根组件（Admin 布局：Header + Sidebar + Content + 版本号展示）
│ ├── routes.tsx # 路由配置
│ ├── styles.css # 全局样式
│ ├── css.d.ts # CSS 模块类型声明