📝 添加 TeyvatGuide 项目 SKILL 文档,包含技术栈、代码风格及数据库操作规范

This commit is contained in:
BTMuli
2026-03-25 18:01:12 +08:00
parent 09211c8b7f
commit 0c41ce4725

View File

@@ -0,0 +1,125 @@
---
name: teyvat-guide
description: TeyvatGuide 项目 SKILL。处理 Vue+Tauri+TypeScript 项目开发包括组件开发、API 集成、SQLite 操作或代码规范。
---
# TeyvatGuide 项目规范
## 技术栈
- **前端**: Vue 3 (Composition API), TypeScript 6, Vuetify 4
- **桌面运行时**: Tauri 2 (Rust backend)
- **构建工具**: Vite 8
- **状态管理**: Pinia + persistedstate
- **数据库**: SQLite (via @tauri-apps/plugin-sql)
- **包管理器**: pnpm 10
## 代码风格
### 通用规则
| 规则 | 要求 |
|------|------|
| 语言 | 中文注释,英文代码 |
| 缩进 | 2 空格 |
| 引号 | 字符串用双引号Vue 模板用单引号 |
| 分号 | 必须 |
| 尾逗号 | ES5 风格 |
| 行长度 | ≤100 字符 |
### TypeScript 规范
> 详见 [typescript-standards skill](../typescript-standards/SKILL.md)
**枚举**: 使用 `const` 对象模式,禁止原生 `enum`
```typescript
// 正确
const GameServerEnum = <const>{
CN_GF01: "cn_gf01",
CN_QD01: "cn_qd01",
};
// 错误
enum GameServerEnum { ... }
```
**JSDoc**: 导出函数必须包含 `@since` 标签
```typescript
/**
* 函数描述
* @since Beta v0.9.6
* @param param - 参数描述
* @returns 返回描述
*/
```
**Import 顺序**: 1. 内置模块 2. 外部包 3. 别名 (@/*) 4. 相对导入
### Vue 规范
- 组件结构: Template → script → style
- 使用 `<script lang="ts" setup>` 语法
- 组件名用 PascalCase
- 样式用 SCSS遵循 stylelint 配置
## 路径别名
| 别名 | 路径 |
|------|------|
| `@/*` | `./src/*` |
| `@styles/*` | `./src/assets/styles/*` |
| `@comp/*` | `./src/components/*` |
| `@enum/*` | `./src/enum/*` |
| `@hooks/*` | `./src/hooks/*` |
| `@Bili/*` | `./src/plugins/Bili/*` |
| `@Hutao/*` | `./src/plugins/Hutao/*` |
| `@Mys/*` | `./src/plugins/Mys/*` |
| `@Sql/*` | `./src/plugins/Sqlite/*` |
| `@Sqlm/*` | `./src/plugins/Sqlite/modules/*` |
| `@req/*` | `./src/request/*` |
| `@store/*` | `./src/store/modules/*` |
| `@utils/*` | `./src/utils/*` |
## 数据库 (SQLite)
- 参数占位符: `$1, $2, $3...`(禁止 `?`
- 异步模式: 所有操作返回 Promise
```typescript
await db.execute(
`INSERT INTO Table(key, value, updated)
VALUES ($1, $2, datetime('now', 'localtime'))
ON CONFLICT(key) DO UPDATE SET value = $2, updated = datetime('now', 'localtime');`,
[key, value],
);
```
## 代码检查
```bash
pnpm lint # 运行所有检查
pnpm lint:fix # 自动修复
pnpm lint:vue # Vue 类型检查
pnpm lint:style # 样式检查
pnpm lint:rust:fix # Rust fmt
```
## Git 提交规范
> 详见 [git-commit-skill](../git-commit-skill/SKILL.md)
**格式**: `<emoji> <描述>`(一行 ≤100 字符,禁止 type: 声明)
```bash
git add <文件路径>
git commit -m "✨ 添加新功能"
```
## 注意事项
1. **禁止原生 enum** - 使用 const 对象模式
2. **erasableSyntaxOnly** - 应为 `true` 或移除
3. **jsx: preserve** - Vue 项目不需要 tsc 处理 jsx
4. **提交规范** - 每次修改后使用 gitmoji 风格提交