lms
ee1ff7f444
- 删除 01~05 旧中文教程目录 - 将 03 核心功能教程拆分为各 framework 模块的子文档 - 06 工具脚本移入 modules/frameworks/编辑器工具/UI工具/ - 非框架内容合并进 rules/20-开发规则.md 与 rules/40-工作流清单.md - 更新所有交叉链接与文档关联表 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
90 lines
2.8 KiB
Markdown
90 lines
2.8 KiB
Markdown
# Hook 共享层
|
||
|
||
> 本目录存放 UnityAI / StrayFog 框架知识库共享的 hook 脚本和规则。
|
||
>
|
||
> 各 AI 工具自己的私有目录只放适配器，不重复维护 hook 逻辑。
|
||
|
||
---
|
||
|
||
## 脚本清单
|
||
|
||
| 脚本 | 用途 |
|
||
|---|---|
|
||
| [archive-check.ps1](archive-check.ps1) | 读取 git diff 中变更的 `.md` 文件，解析 `## 文档关联` 表，输出需要同步检查的关联文档 |
|
||
| [sync-doc-associations.ps1](sync-doc-associations.ps1) | Python 脚本的 PowerShell 包装器 |
|
||
| [sync_doc_associations.py](sync_doc_associations.py) | 在关联文档中追加变更提醒（只追加、不覆盖，执行后需 review） |
|
||
| [commit-check.ps1](commit-check.ps1) | 提交前检查：推断变更文件所属模块，校验提交信息格式 |
|
||
| [commit-module-mappings.json](commit-module-mappings.json) | `commit-check.ps1` 使用的目录-模块映射配置 |
|
||
|
||
---
|
||
|
||
## 归档检查
|
||
|
||
所有任务结束后都应执行归档检查，判断是否需要同步更新长期文档。
|
||
|
||
```powershell
|
||
# PowerShell
|
||
.\docs\hooks\archive-check.ps1
|
||
```
|
||
|
||
该脚本只输出建议，不会自动修改任何文档。最终是否更新关联文档，需要用户确认。
|
||
|
||
---
|
||
|
||
## 文档关联同步
|
||
|
||
如需在关联文档中自动留下变更提醒，可运行：
|
||
|
||
```powershell
|
||
.\docs\hooks\sync-doc-associations.ps1
|
||
```
|
||
|
||
该脚本只追加、不覆盖，执行后必须 review。
|
||
|
||
---
|
||
|
||
## 提交检查
|
||
|
||
提交前可运行：
|
||
|
||
```powershell
|
||
.\docs\hooks\commit-check.ps1 -Message "[entity][docs]: 补充实体池说明"
|
||
```
|
||
|
||
检查项包括：
|
||
|
||
- 提交信息是否符合 `[模块][类型]: 描述` 格式
|
||
- 变更文件是否能映射到已知模块
|
||
- 模块映射配置来自 [commit-module-mappings.json](commit-module-mappings.json)
|
||
|
||
---
|
||
|
||
## 触发方式
|
||
|
||
| 触发方式 | 命令/路径 | 说明 |
|
||
|---|---|---|
|
||
| Codex Stop hook | `.codex/hooks/archive-reminder.ps1` | 若已配置，每次任务结束自动调用 `hooks/archive-check.ps1` |
|
||
| Claude Code 手动 | 直接运行脚本 | 任务结束时手动调用 `hooks/archive-check.ps1` |
|
||
| 手动脚本 | `hooks/archive-check.ps1` | 直接运行 PowerShell 脚本 |
|
||
|
||
---
|
||
|
||
## 新增 Hook 时
|
||
|
||
1. 把脚本放入 `hooks/`。
|
||
2. 在本文件中登记。
|
||
3. 在 [ai/AI接入入口.md](../ai/AI接入入口.md) 中说明触发方式。
|
||
4. 如果涉及提交信息格式，同步更新 [rules/40-工作流清单.md](../rules/40-工作流清单.md)。
|
||
|
||
---
|
||
|
||
## 文档关联
|
||
|
||
> 当本文档发生变更时，应同步检查以下关联文档，避免信息不一致。
|
||
|
||
| 文档 | 关联原因 |
|
||
|---|---|
|
||
| [ai/AI接入入口.md](../ai/AI接入入口.md) | AI 接入入口引用 hook 共享层 |
|
||
| [rules/项目规则入口.md](../rules/项目规则入口.md) | 规则入口索引归档触发机制 |
|
||
| [rules/40-工作流清单.md](../rules/40-工作流清单.md) | 提交前检查与工作流清单互相引用 |
|