refactor: reorganize project structure and improve code quality
- Move CI/CD configs to config/ci/ directory - Reorganize scripts into categorized directories (deployment, monitoring, testing, utils) - Consolidate documentation into docs/ directory with proper structure - Update linting and testing configurations - Remove obsolete test reports and performance summaries - Add new documentation for code quality tools and contact form security - Improve project organization and maintainability - Fix lint-staged config to only lint JS/TS files - Disable react/react-in-jsx-scope rule for Next.js compatibility - Ignore scripts and test config directories in ESLint
This commit is contained in:
+252
@@ -0,0 +1,252 @@
|
||||
# Findings
|
||||
|
||||
## 项目现状分析
|
||||
|
||||
### 发现时间
|
||||
2026-03-24
|
||||
|
||||
### 项目基本信息
|
||||
- **项目名称**: novalon-website
|
||||
- **项目类型**: Next.js 16 + React 19 企业官网
|
||||
- **技术栈**: TypeScript, Tailwind CSS, Drizzle ORM, NextAuth.js
|
||||
- **版本**: 1.0.0-phase1
|
||||
|
||||
## 关键发现
|
||||
|
||||
### 1. 测试体系复杂度过高
|
||||
|
||||
#### 发现内容
|
||||
项目存在三个独立的测试框架:
|
||||
1. **e2e/** - Playwright测试框架(TypeScript)
|
||||
- 完整的E2E测试套件
|
||||
- 包含冒烟测试、回归测试、性能测试等
|
||||
- 测试配置文件:playwright.config.ts, playwright.config.admin.ts等
|
||||
|
||||
2. **e2e-tests/** - Python Playwright测试框架
|
||||
- 使用pytest框架
|
||||
- 包含基础页面测试
|
||||
- 配置文件:pytest.ini, requirements.txt
|
||||
|
||||
3. **test-framework/** - 共享测试框架
|
||||
- 独立的package.json
|
||||
- 包含共享的测试工具和页面对象
|
||||
- 配置文件:playwright.config.ts, tsconfig.json
|
||||
|
||||
#### 影响
|
||||
- 维护成本高:需要维护三套测试框架
|
||||
- 测试执行复杂:需要在不同环境中运行不同测试
|
||||
- 代码重复:多个框架中存在相似的测试逻辑
|
||||
- 学习成本高:团队成员需要熟悉多个测试框架
|
||||
|
||||
#### 建议
|
||||
- 保留e2e/作为主要测试框架(Playwright + TypeScript)
|
||||
- 迁移e2e-tests/和test-framework/中有价值的测试用例到e2e/
|
||||
- 统一测试配置和报告格式
|
||||
- 清理冗余的测试代码
|
||||
|
||||
### 2. 配置文件分散且重复
|
||||
|
||||
#### 发现内容
|
||||
环境配置文件:
|
||||
- `.env.example` - 开发环境示例
|
||||
- `.env.production` - 生产环境配置
|
||||
- `.env.production.example` - 生产环境示例
|
||||
- `e2e/.env.example` - E2E测试环境示例
|
||||
- `e2e-tests/.env.example` - Python测试环境示例
|
||||
|
||||
CI/CD配置:
|
||||
- `.github/workflows/lighthouse.yml` - GitHub Actions
|
||||
- `.woodpecker/ci.yml` - Woodpecker CI
|
||||
- `.woodpecker/deploy.yml` - Woodpecker部署
|
||||
- `.woodpecker/quality-gate.yml` - Woodpecker质量门禁
|
||||
- `.woodpecker/test-tiered-simple.yml` - 分层测试
|
||||
- `.woodpecker/test-tiered.yml` - 分层测试
|
||||
|
||||
#### 影响
|
||||
- 配置维护困难:需要在多个地方更新配置
|
||||
- 容易出错:配置不一致导致问题
|
||||
- 环境混乱:不清楚使用哪个配置文件
|
||||
|
||||
#### 建议
|
||||
- 合并环境配置文件,使用单一配置文件
|
||||
- 选择一个主要的CI/CD系统(建议Woodpecker)
|
||||
- 统一配置管理策略
|
||||
|
||||
### 3. 文档文件杂乱
|
||||
|
||||
#### 发现内容
|
||||
根目录下的文档文件:
|
||||
- `README.md` - 主文档
|
||||
- `DEPLOYMENT.md` - 部署文档
|
||||
- `IMPLEMENTATION-REPORT.md` - 实现报告
|
||||
- `README-TIERED-TESTING.md` - 分层测试文档
|
||||
- `SECURITY.md` - 安全文档
|
||||
- `TESTING_REPORT.md` - 测试报告
|
||||
|
||||
测试报告目录:
|
||||
- `test-reports/` - 测试报告
|
||||
- `test-analysis/` - 测试分析
|
||||
- `performance/` - 性能测试报告
|
||||
|
||||
#### 影响
|
||||
- 文档查找困难:文档分散在多个位置
|
||||
- 文档维护困难:不清楚哪个文档是最新版本
|
||||
- 文档重复:多个文档可能包含相似内容
|
||||
|
||||
#### 建议
|
||||
- 创建docs/目录,统一管理所有文档
|
||||
- 分类整理文档(架构、开发、部署、测试等)
|
||||
- 清理过时的文档
|
||||
- 建立文档更新机制
|
||||
|
||||
### 4. 临时文件和构建产物
|
||||
|
||||
#### 发现内容
|
||||
根目录下的临时文件:
|
||||
- `performance/load-test-summary.json` - 性能测试报告
|
||||
- `performance/stress-test-summary.json` - 压力测试报告
|
||||
- `performance/phase2-load-test-summary.json` - 阶段2性能报告
|
||||
|
||||
Git忽略规则:
|
||||
- `.gitignore`中忽略了`docs`目录(第343行)
|
||||
|
||||
#### 影响
|
||||
- 仓库体积增大:临时文件被提交到仓库
|
||||
- 构建产物污染:不清楚哪些文件应该被忽略
|
||||
- 文档被忽略:docs目录被忽略可能导致文档丢失
|
||||
|
||||
#### 建议
|
||||
- 更新.gitignore,确保临时文件和构建产物被正确忽略
|
||||
- 移除docs目录的忽略规则
|
||||
- 清理已提交的临时文件
|
||||
|
||||
### 5. 组件测试文件组织
|
||||
|
||||
#### 发现内容
|
||||
测试文件与组件文件混在一起:
|
||||
- `src/components/effects/gradient-flow.test.tsx`
|
||||
- `src/components/analytics/analytics.test.tsx`
|
||||
- `src/app/(marketing)/about/page.test.tsx`
|
||||
- `src/app/admin/content/page.test.tsx`
|
||||
|
||||
#### 影响
|
||||
- 目录结构混乱:测试文件与源码文件混在一起
|
||||
- 构建配置复杂:需要排除测试文件
|
||||
- 代码审查困难:需要过滤测试文件
|
||||
|
||||
#### 建议
|
||||
- 考虑将测试文件集中管理(如`__tests__`目录)
|
||||
- 或保持现有结构但确保配置正确排除测试文件
|
||||
|
||||
### 6. 类型定义分散
|
||||
|
||||
#### 发现内容
|
||||
类型定义文件:
|
||||
- `src/types/next-auth.d.ts` - NextAuth类型定义
|
||||
- `src/types/jest-dom.d.ts` - Jest类型定义
|
||||
- `src/lib/api/types.ts` - API类型定义
|
||||
|
||||
#### 影响
|
||||
- 类型查找困难:类型定义分散在多个位置
|
||||
- 类型重复:可能存在重复的类型定义
|
||||
- 导入混乱:不清楚从哪里导入类型
|
||||
|
||||
#### 建议
|
||||
- 统一类型定义位置
|
||||
- 建立类型定义规范
|
||||
- 使用TypeScript路径别名简化导入
|
||||
|
||||
### 7. 脚本文件组织
|
||||
|
||||
#### 发现内容
|
||||
scripts目录下的脚本文件:
|
||||
- `scripts/fix-login-issue.sh` - 修复登录问题
|
||||
- `scripts/test-contact-page.sh` - 测试联系页面
|
||||
- `scripts/fix-dev-server.sh` - 修复开发服务器
|
||||
- `scripts/verify-tiered-testing.sh` - 验证分层测试
|
||||
- `scripts/validate-woodpecker-config.js` - 验证Woodpecker配置
|
||||
- `scripts/setup-lightweight-monitoring.sh` - 设置轻量级监控
|
||||
- `scripts/start-monitoring.sh` - 启动监控
|
||||
- `scripts/check-monitoring-env.sh` - 检查监控环境
|
||||
- `scripts/setup-monitoring.sh` - 设置监控
|
||||
- `scripts/deploy-production.sh` - 部署生产环境
|
||||
- `scripts/restore.sh` - 恢复备份
|
||||
- `scripts/backup.sh` - 备份数据
|
||||
- `scripts/check-color-contrast.ts` - 检查颜色对比度
|
||||
- `scripts/check-heading-hierarchy.ts` - 检查标题层级
|
||||
|
||||
#### 影响
|
||||
- 脚本查找困难:脚本文件过多且命名不统一
|
||||
- 脚本分类不清:不清楚脚本的用途和分类
|
||||
- 脚本维护困难:缺少脚本文档
|
||||
|
||||
#### 建议
|
||||
- 分类组织脚本文件(部署、测试、监控、工具等)
|
||||
- 统一脚本命名规范
|
||||
- 为每个脚本添加文档说明
|
||||
|
||||
## 技术债务
|
||||
|
||||
### 高优先级
|
||||
1. 测试框架整合 - 影响维护成本和开发效率
|
||||
2. 配置文件统一 - 影响部署和运维效率
|
||||
3. 文档体系整理 - 影响团队协作和知识传承
|
||||
|
||||
### 中优先级
|
||||
4. 临时文件清理 - 影响仓库体积和构建效率
|
||||
5. 脚本文件组织 - 影响开发和运维效率
|
||||
6. 类型定义统一 - 影响代码质量和开发体验
|
||||
|
||||
### 低优先级
|
||||
7. 组件测试文件组织 - 可选优化
|
||||
8. 代码风格统一 - 长期改进
|
||||
|
||||
## 优化机会
|
||||
|
||||
### 工程化改进
|
||||
1. 引入Husky + lint-staged自动化代码检查
|
||||
2. 配置commitlint规范提交信息
|
||||
3. 集成代码覆盖率检查
|
||||
4. 建立pre-commit钩子
|
||||
|
||||
### 开发体验改进
|
||||
1. 统一开发工具配置
|
||||
2. 优化构建性能
|
||||
3. 改进错误提示
|
||||
4. 增强调试体验
|
||||
|
||||
### 团队协作改进
|
||||
1. 建立代码审查规范
|
||||
2. 制定开发流程文档
|
||||
3. 创建问题排查指南
|
||||
4. 建立知识库
|
||||
|
||||
## 风险评估
|
||||
|
||||
### 测试框架整合风险
|
||||
- **风险等级**: 高
|
||||
- **影响**: 可能导致测试覆盖率下降
|
||||
- **缓解措施**: 逐步迁移,保留备份,充分测试
|
||||
|
||||
### 配置文件合并风险
|
||||
- **风险等级**: 中
|
||||
- **影响**: 可能导致配置冲突
|
||||
- **缓解措施**: 详细记录配置差异,分步合并
|
||||
|
||||
### 目录结构重组风险
|
||||
- **风险等级**: 中
|
||||
- **影响**: 可能影响导入路径
|
||||
- **缓解措施**: 使用绝对路径导入,更新所有引用
|
||||
|
||||
## 下一步行动
|
||||
|
||||
1. 完成深度分析(Phase 1)
|
||||
2. 开始测试体系整合(Phase 2)
|
||||
3. 逐步完成其他优化阶段
|
||||
|
||||
## 参考资料
|
||||
|
||||
- Next.js官方文档: https://nextjs.org/docs
|
||||
- Playwright测试文档: https://playwright.dev
|
||||
- TypeScript最佳实践: https://www.typescriptlang.org/docs/
|
||||
- Tailwind CSS文档: https://tailwindcss.com/docs
|
||||
Reference in New Issue
Block a user