整理报告.md
3.33 KB
Scripts 目录整理报告
整理日期: 2026-02-15
✅ 整理完成
新目录结构
scripts/
├── README.md # 主说明文档
├── CLAUDE.md # Claude Code 指南（待处理）
│
├── api-generator/ # API 代码生成工具
│ ├── README.md # 使用说明
│ ├── GUIDE.md # 详细指南
│ ├── generateApiFromOpenAPI.js # 主脚本 ⭐
│ ├── apiDiff.js # API 对比工具
│ └── test-generate.js # 测试脚本
│
├── doc-parser/ # 文档解析工具
│ ├── README.md # 使用说明
│ ├── QUICKSTART.md # 快速开始
│ ├── .env.example # 环境变量示例
│ ├── parse-docs.js # 主脚本 ⭐
│ ├── parse-config.js # 配置文件
│ ├── smart-field-extractor.js # 字段提取器
│ ├── product-splitter.js # 产品分割器
│ └── parse-docs.test.js # 测试文件
│
└── changelog/ # CHANGELOG 管理工具
├── README.md # 使用说明
├── check-changelog.sh # 漏记检查 ⭐
└── archive-changelog.sh # 归档脚本
npm scripts 已更新
| 命令 | 新路径 |
|---|---|
pnpm api:generate |
scripts/api-generator/generateApiFromOpenAPI.js |
pnpm parse:docs |
scripts/doc-parser/parse-docs.js |
pnpm changelog:check |
scripts/changelog/check-changelog.sh |
⚠️ 未使用文件列表
以下文件没有在 package.json 或其他脚本中直接调用，请判断是否需要保留：
1. scripts/changelog/archive-changelog.sh
状态: 🟡 未直接引用
功能: CHANGELOG 归档脚本，当记录超过 20 条时自动归档
使用方式: 手动运行 ./scripts/changelog/archive-changelog.sh
建议:
- 保留 - 作为手动维护工具
- 删除 - 不再需要归档功能
2. scripts/api-generator/test-generate.js
状态: 🟡 未直接引用
功能: 测试生成的 API 文件是否正确
使用方式: 手动运行 node scripts/api-generator/test-generate.js
建议:
- 保留 - 作为开发调试工具
- 删除 - 已有其他测试方式
3. scripts/CLAUDE.md
状态: 🟡 需要评估 功能: 给 Claude Code 的说明文档 位置: 当前在 scripts 根目录 建议:
- 保留在当前位置 - 作为 Claude 指南
- 移动到 doc-parser 目录 - 因为主要与文档解析相关
- 删除 - 内容已整合到其他文档
📝 整理后的改进
- ✅ 功能分组清晰 - 按用途分为 3 个子目录
- ✅ 每个子目录有 README - 包含使用说明和文件介绍
- ✅ 路径引用已更新 - package.json 已同步更新
- ✅ 单个文件已收录 - 所有脚本都在对应的功能目录中
🔧 后续操作建议
- 确认未使用文件 - 对上述 3 个文件做出保留/删除决定
- 更新 CLAUDE.md - 如果项目根目录的 CLAUDE.md 已包含相关内容，可以删除 scripts/CLAUDE.md
-
测试脚本 - 运行
pnpm api:generate和pnpm parse:docs确保路径更新正确