|
| 1 | +--- |
| 2 | +description: Stock SDK 项目开发规范 |
| 3 | +globs: |
| 4 | +alwaysApply: true |
| 5 | +--- |
| 6 | + |
| 7 | +# Stock SDK 项目规范 |
| 8 | + |
| 9 | +## 项目概述 |
| 10 | + |
| 11 | +这是一个用于获取股票行情数据的 TypeScript SDK，支持 A 股、港股、美股和公募基金。该 SDK 可在浏览器和 Node.js 环境中运行，零依赖，轻量。 |
| 12 | + |
| 13 | +## 技术栈 |
| 14 | + |
| 15 | +- **语言**: TypeScript 5.x |
| 16 | +- **运行环境**: Node.js 18+ / 浏览器 |
| 17 | +- **构建工具**: tsup |
| 18 | +- **测试框架**: Vitest |
| 19 | +- **文档工具**: VitePress |
| 20 | +- **包管理器**: Yarn 1.x |
| 21 | + |
| 22 | +## 项目结构 |
| 23 | + |
| 24 | +``` |
| 25 | +src/ |
| 26 | +├── core/ # 核心功能模块（请求、解析、工具函数） |
| 27 | +├── indicators/ # 技术指标计算（MA、MACD、BOLL、KDJ 等） |
| 28 | +├── providers/ # 数据提供商 |
| 29 | +│ ├── eastmoney/ # 东方财富 K 线数据 |
| 30 | +│ └── tencent/ # 腾讯行情数据 |
| 31 | +├── sdk.ts # SDK 主类 |
| 32 | +├── types.ts # 类型定义 |
| 33 | +└── index.ts # 导出入口 |
| 34 | +``` |
| 35 | + |
| 36 | +## 代码规范 |
| 37 | + |
| 38 | +### TypeScript 规范 |
| 39 | + |
| 40 | +1. **始终使用严格类型**，避免使用 `any` |
| 41 | +2. **所有公共 API 必须有完整的类型定义** |
| 42 | +3. **使用 `interface` 定义对象类型**，使用 `type` 定义联合类型或工具类型 |
| 43 | +4. **导出的函数和类必须有 JSDoc 注释** |
| 44 | + |
| 45 | +```typescript |
| 46 | +/** |
| 47 | + * 获取 A 股实时行情 |
| 48 | + * @param codes - 股票代码数组，如 ['sh600519', 'sz000858'] |
| 49 | + * @returns 行情数据数组 |
| 50 | + */ |
| 51 | +export async function getQuotes(codes: string[]): Promise<Quote[]> { |
| 52 | + // ... |
| 53 | +} |
| 54 | +``` |
| 55 | + |
| 56 | +### 命名规范 |
| 57 | + |
| 58 | +- **文件名**: 使用 camelCase，如 `aShareKline.ts` |
| 59 | +- **类名**: 使用 PascalCase，如 `StockSDK` |
| 60 | +- **函数名**: 使用 camelCase，如 `getFullQuotes` |
| 61 | +- **常量**: 使用 UPPER_SNAKE_CASE，如 `DEFAULT_TIMEOUT` |
| 62 | +- **类型/接口**: 使用 PascalCase，如 `QuoteData` |
| 63 | + |
| 64 | +### 代码风格 |
| 65 | + |
| 66 | +1. **使用 ES Module 导入/导出** |
| 67 | +2. **异步操作使用 async/await** |
| 68 | +3. **避免使用 `export default`**，除非是主入口文件 |
| 69 | +4. **错误处理要明确**，提供有意义的错误信息 |
| 70 | + |
| 71 | +## 新增功能开发流程 |
| 72 | + |
| 73 | +### 添加新的数据接口 |
| 74 | + |
| 75 | +1. 在 `src/providers/` 下对应的提供商目录中创建新文件 |
| 76 | +2. 在 `src/types.ts` 中定义相关类型 |
| 77 | +3. 在 `src/sdk.ts` 中添加公共方法 |
| 78 | +4. 在 `src/index.ts` 中导出新类型 |
| 79 | +5. 完成开发后检查清单（见下方） |
| 80 | + |
| 81 | +### 添加新的技术指标 |
| 82 | + |
| 83 | +1. 在 `src/indicators/` 目录下创建新的指标文件 |
| 84 | +2. 在 `src/indicators/types.ts` 中定义配置类型 |
| 85 | +3. 在 `src/indicators/index.ts` 中导出 |
| 86 | +4. 在 `src/indicators/addIndicators.ts` 中集成 |
| 87 | +5. 完成开发后检查清单（见下方） |
| 88 | + |
| 89 | +## ⚠️ 开发完成后必做检查清单 |
| 90 | + |
| 91 | +**每次对 `src/` 目录下的代码进行新增或修改功能时（如增加方法、增加指标等），必须完成以下所有步骤：** |
| 92 | + |
| 93 | +### 1. 确保构建成功 |
| 94 | + |
| 95 | +```bash |
| 96 | +yarn build |
| 97 | +``` |
| 98 | + |
| 99 | +- 构建必须无错误通过 |
| 100 | +- 检查 `dist/` 目录下的输出文件是否正确生成 |
| 101 | + |
| 102 | +### 2. 补充测试用例并确保单测通过 |
| 103 | + |
| 104 | +```bash |
| 105 | +yarn test |
| 106 | +``` |
| 107 | + |
| 108 | +- 为新增/修改的功能编写对应的测试用例 |
| 109 | +- 测试文件位于 `src/index.test.ts` |
| 110 | +- 确保所有测试通过，无失败用例 |
| 111 | + |
| 112 | +### 3. 更新 README 文档 |
| 113 | + |
| 114 | +- **中文文档**: 更新 `README.md` |
| 115 | +- **英文文档**: 同步更新 `README_EN.md` |
| 116 | +- 如果新增了公共 API，需要在 API 列表中添加说明 |
| 117 | + |
| 118 | +### 4. 更新 website 文档 |
| 119 | + |
| 120 | +- **中文文档**: 更新 `website/` 目录下对应的 `.md` 文件 |
| 121 | + - API 文档在 `website/api/` 目录 |
| 122 | + - 使用指南在 `website/guide/` 目录 |
| 123 | +- **英文文档**: 同步更新 `website/en/` 目录下对应的 `.md` 文件 |
| 124 | + - API 文档在 `website/en/api/` 目录 |
| 125 | + - 使用指南在 `website/en/guide/` 目录 |
| 126 | +- 确保中英文文档内容一致 |
| 127 | + |
| 128 | +### 5. 更新 Playground（如需要） |
| 129 | + |
| 130 | +- 如果新增的功能适合在 Playground 中演示，需要更新： |
| 131 | + - `website/playground/index.md` |
| 132 | + - `website/en/playground/index.md` |
| 133 | +- 确保 Playground 示例可以正常运行 |
| 134 | + |
| 135 | +### 检查清单总结 |
| 136 | + |
| 137 | +``` |
| 138 | +□ yarn build 成功 |
| 139 | +□ yarn test 通过 |
| 140 | +□ README.md 已更新 |
| 141 | +□ README_EN.md 已更新 |
| 142 | +□ website/ 中文文档已更新 |
| 143 | +□ website/en/ 英文文档已更新 |
| 144 | +□ Playground 已更新（如需要） |
| 145 | +``` |
| 146 | + |
| 147 | +## 构建与发布 |
| 148 | + |
| 149 | +```bash |
| 150 | +# 构建 |
| 151 | +yarn build |
| 152 | + |
| 153 | +# 本地开发 |
| 154 | +yarn dev |
| 155 | + |
| 156 | +# 文档开发 |
| 157 | +yarn dev:docs |
| 158 | + |
| 159 | +# 文档构建 |
| 160 | +yarn build:docs |
| 161 | +``` |
| 162 | + |
| 163 | +## 文档规范 |
| 164 | + |
| 165 | +- 文档位于 `website/` 目录 |
| 166 | +- 支持中英文双语（英文在 `website/en/`） |
| 167 | +- API 文档在 `website/api/` 目录 |
| 168 | +- 使用 VitePress 构建 |
| 169 | + |
| 170 | +## Git 提交规范 |
| 171 | + |
| 172 | +使用语义化提交信息： |
| 173 | + |
| 174 | +- `feat`: 新功能 |
| 175 | +- `fix`: 修复 bug |
| 176 | +- `docs`: 文档更新 |
| 177 | +- `refactor`: 代码重构 |
| 178 | +- `test`: 测试相关 |
| 179 | +- `chore`: 构建/工具相关 |
| 180 | + |
| 181 | +示例: `feat: 添加创业板指数支持` |
| 182 | + |
| 183 | +## 注意事项 |
| 184 | + |
| 185 | +1. **保持零依赖**：不引入任何运行时依赖 |
| 186 | +2. **双端兼容**：代码需要同时在浏览器和 Node.js 中运行 |
| 187 | +3. **向后兼容**：公共 API 的变更需要考虑向后兼容性 |
| 188 | +4. **中文支持**：处理 GBK 编码时使用 `decodeGBK` 工具函数 |
0 commit comments