mirror of
https://wget.la/https://github.com/Wxw-Gu/WechatExplorer
synced 2026-08-17 03:27:00 +08:00
57 lines
2.7 KiB
Markdown
57 lines
2.7 KiB
Markdown
# 开发、测试与构建
|
||
|
||
本文面向希望参与 WechatExplorer 开发、验证文档或维护集成的贡献者。普通用户请从[第一次使用](../user-guide/getting-started.md)开始。
|
||
|
||
## 技术基线
|
||
|
||
- Electron + React + TypeScript;
|
||
- pnpm 7+;
|
||
- Go(构建微信连接器);
|
||
- 平台对应的 Electron/native 构建环境。
|
||
|
||
产品文档的事实来源优先级是:当前源码 → 当前 UI/Renderer → 测试 → package/config → README/docs → 历史资料。功能、API、版本、隐私和兼容性变更时,不要只改 README。
|
||
|
||
## 本地开发
|
||
|
||
```bash
|
||
pnpm install
|
||
pnpm dev
|
||
```
|
||
|
||
常用检查:
|
||
|
||
```bash
|
||
pnpm typecheck
|
||
pnpm test:unit
|
||
pnpm test:component
|
||
pnpm test:integration
|
||
pnpm test:e2e:build
|
||
```
|
||
|
||
完整测试入口 `pnpm test` 还会运行 Skill 安装指令、微信连接器、构建和 Playwright 测试;需要对应平台环境。
|
||
|
||
## 代码变更对应文档
|
||
|
||
| 代码区域 | 需要同步检查的文档 |
|
||
| --------------------------------------------------------- | ---------------------------------------------------------- |
|
||
| `src/shared/ai-search.ts`、AI Search pipeline | `user-guide/ai-search.md`、`concepts/answer-sources.md` |
|
||
| `src/shared/knowledge.ts`、`src/main/knowledge/` | `user-guide/knowledge.md`、`concepts/how-it-works.md` |
|
||
| `src/shared/voice-recognition.ts` | `user-guide/voice.md` |
|
||
| `src/shared/group-report.ts`、报告 UI | `user-guide/report.md`、API/Agent 文档 |
|
||
| `src/shared/export.ts`、导出服务/UI | `user-guide/export.md` |
|
||
| `src/main/services/recall-archive-service.ts`、防撤回设置 | `user-guide/recall-protection.md`、`user-guide/privacy.md` |
|
||
| `src/shared/local-api-test.ts`、`src/main/http-server.ts` | `agent/api.md`、`api-security.md`、打包 Skill |
|
||
| Agent Hub service/UI | `agent/agent-hub.md`、`user-guide/privacy.md` |
|
||
| 设置导航、连接页面 | `user-guide/getting-started.md`、`docs/README.md` |
|
||
|
||
## 文档检查
|
||
|
||
提交文档变更前至少执行:
|
||
|
||
```bash
|
||
git diff --check
|
||
rg -n "v2\.1\.7|TraceMemo|迹忆|mcpServers|无鉴权" README.md docs --glob '*.md' --glob '!DOCUMENTATION_AUDIT.md' --glob '!development/overview.md'
|
||
```
|
||
|
||
历史迁移说明可以出现旧版本号;正式使用指南不要把过时版本写成当前版本。负向澄清“6131 不是 MCP Server”可以保留,以防用户照抄错误配置。
|