Files
eSIM-Tools/scripts/CLAUDE.md
Abner 00a0e58d81 📝 docs: 更新架构与安全文档并扩展测试模块清单
- 更新 CLAUDE.md、docs/ARCHITECTURE.md 中的模块与阶段状态,补充 verify-cookie/health/public-config/notifications 等新节点,并将基础设施阶段由规划中标注为进行中
- 完善 docs/SECURITY.md 的 BFF 代理层与 withAuth 中间件说明,明确 x-esim-key 注入、函数白名单校验以及 CORS/体验验证的统一错误格式化策略
- 更新 src/giffgaff/MODULE_ARCHITECTURE.md 的安全考虑条目,补充 cookie 有效性检查间隔、CSP/Helmet 策略、HTML sanitization(escapeHtml/escapeAttr)以及通过 BFF 代理转发的传输层防护细则
- 扩展 tests/CLAUDE.md 测试范围与表格结构,新增 modules、giffgaff、security 三类的独立测试文件清单,并补充 tests/setup.js 的全局初始化说明
- 调整脚本与模块文档:scripts/CLAUDE.md 新增部署与构建相关脚本清单;src/js/modules/CLAUDE.md 更新 CaptchaManager 集成说明与模块覆盖状态,补充 notification-service/browser-utils 等相关条目
2026-06-02 22:50:26 +08:00

97 lines
2.9 KiB
Markdown

[根目录](../CLAUDE.md) > **scripts**
# 构建脚本模块
## 模块职责
提供构建、质量检查、安全扫描和自动化部署脚本。
## 脚本列表
### 构建相关
| 脚本 | 命令 | 职责 |
|------|------|------|
| `build-static.js` | `npm run build` | 静态资源复制与 dist 构建 |
| `transpile-dist-js.js` | - | dist/ JS 文件转译 |
| `inject-sentry-config.js` | - | Sentry 配置注入 |
### 质量检查
| 脚本 | 命令 | 职责 |
|------|------|------|
| `quality-check.js` | `npm run quality-check` | 代码质量检查 (14 项) |
| `security-check.js` | `npm run security-check` | 安全配置扫描 |
### 部署相关
| 脚本 | 命令 | 职责 |
|------|------|------|
| `deploy-prepare.js` | `npm run deploy-prepare` | 部署准备 (质量+安全+构建) |
| `deploy-analyze.js` | `npm run deploy-analyze` | 部署分析 |
| `test-deploy-config.js` | `npm run deploy-test` | Netlify 配置验证 |
| `deploy.sh` | - | 部署 Shell 脚本 |
### 资源优化
| 脚本 | 命令 | 职责 |
|------|------|------|
| `optimize-images.js` | `npm run optimize-images` | Sharp 图片压缩 |
| `compress.js` | `npm run compress` | Gzip/Brotli 压缩 |
### Git Hooks
| 脚本 | 命令 | 职责 |
|------|------|------|
| `pre-commit-check.js` | `npm run precommit:check` | Pre-commit 检查 |
| `pre-push-check.js` | `npm run prepush:check` | Pre-push 检查 (full/fast 模式) |
| `commit-msg-lint.js` | `npm run commitmsg:lint` | Commit message 规范检查 |
| `prepare-commit-msg.js` | - | Commit message 自动生成 |
### 工具
| 脚本 | 职责 |
|------|------|
| `logger.js` | 构建日志模块 (彩色输出) |
| `replace-console-log.js` | 替换 console.log |
| `update-script-logging.js` | 更新脚本日志 |
| `generate-agent-metadata.js` | 生成 AI Agent 元数据 |
| `apply-middleware.sh` | 应用中间件 |
| `start_simyo_server.sh/.bat` | 启动 Simyo 代理服务器 |
## 运行方式
```bash
npm run build # 构建
npm run quality-check # 质量检查
npm run security-check # 安全扫描
npm run deploy-prepare # 部署准备
npm run optimize-images # 图片优化
npm run compress # 资源压缩
```
## 相关文件清单
- `scripts/build-static.js`
- `scripts/transpile-dist-js.js`
- `scripts/inject-sentry-config.js`
- `scripts/quality-check.js`
- `scripts/security-check.js`
- `scripts/deploy-prepare.js`
- `scripts/deploy-analyze.js`
- `scripts/test-deploy-config.js`
- `scripts/deploy.sh`
- `scripts/optimize-images.js`
- `scripts/compress.js`
- `scripts/logger.js`
- `scripts/replace-console-log.js`
- `scripts/update-script-logging.js`
- `scripts/pre-commit-check.js`
- `scripts/pre-push-check.js`
- `scripts/commit-msg-lint.js`
- `scripts/prepare-commit-msg.js`
- `scripts/generate-agent-metadata.js`
- `scripts/apply-middleware.sh`
- `scripts/start_simyo_server.sh`
- `scripts/start_simyo_server.bat`