本仓库用于学习 TypeScript / React / Electron,并最终做出一个类 VSCode 的编辑器工具。
- 技术指南(TECHNICAL_GUIDE.md) - 详细的技术架构文档
- 项目架构总览和分层设计
- 核心模块(DocumentModel)详解
- React 层架构(Context、Hooks、Components)
- 数据流和状态管理机制
- 为什么需要多层嵌套
- 每个文件和函数的作用说明
- 常见开发场景示例
- 调试技巧和性能优化
- 测试策略
npm run dev:node运行 Node.js 示例(展示 DocumentModel 基础用法)npm run dev:web运行 Web 编辑器(Vite 开发服务器,访问 http://localhost:5173)
npm run build:node编译 TypeScript 代码npm run build:web构建 Web 应用
npm run typecheck执行 TypeScript 类型检查npm run lint代码规范检查(ESLint)npm run format使用 Prettier 格式化
npm run test运行测试套件(监听模式)npm run test:run运行测试套件(单次运行)npm run test:watch运行测试套件(监听模式)npm run test:ui运行测试套件(UI界面)npm run test:coverage运行测试并生成覆盖率报告
本项目使用 Vitest 作为测试框架,提供快速、现代的测试体验。
test/
├── DocumentModel.test.ts # DocumentModel 类的单元测试
└── ... # 其他测试文件
# 运行所有测试(监听模式)
npm test
# 运行所有测试(单次运行)
npm run test:run
# 运行测试并生成覆盖率报告
npm run test:coverage
# 使用 UI 界面运行测试
npm run test:ui当前 DocumentModel 类的测试覆盖率达到 98%+,包括:
- 基本文本操作测试(创建、获取、设置文本等)
- 位置与偏移转换测试
- 文本编辑操作测试(插入、删除、替换)
- 文本查找和替换测试
- 行范围获取测试
- 边界情况和错误处理测试
- 每个公共方法都应该有对应的测试
- 包含正常情况和边界情况的测试
- 使用中文测试描述,便于理解
- 测试应该独立且可重复运行
feat: ...新功能或文件fix: ...修复chore: ...工具链/配置变更refactor: ...重构test: ...测试相关
src/
├── document/
│ └── DocumentModel.ts # 文档模型核心类
├── frontend/
│ ├── components/
│ │ ├── Editor.tsx # 主编辑器组件(带行号和高亮)
│ │ ├── EditorExample.tsx # Hook 使用示例
│ │ └── DocumentViewer.tsx # 文档查看器
│ ├── context/
│ │ └── DocumentContext.tsx # React Context 状态管理
│ ├── hooks/
│ │ ├── useDocumentModel.ts # 文档操作 Hook
│ │ └── index.ts
│ ├── App.tsx # 应用入口组件
│ └── main.tsx # React 应用挂载点
├── index.ts # Node.js 示例程序
test/
├── DocumentModel.test.ts # DocumentModel 单元测试
├── DocumentModel.integration.test.ts # 集成测试
└── useDocumentModel.test.ts # Hook 测试
文本编辑器的核心数据结构,提供:
- 基本文本操作(获取、设置、获取行数、获取指定行)
- 位置与偏移量转换(Position ↔ Offset)
- 文本编辑操作(插入、删除、替换范围)
- 文本查找与替换(查找第一个、查找所有、全部替换)
- 行范围操作
类 VSCode 的编辑器界面,包含:
- 左侧行号栏(Gutter),显示行号
- 当前行高亮显示
- 暗色主题样式
- 与 DocumentModel 实时同步
DocumentContext:提供单例 DocumentModel 实例和版本管理useDocument:访问 Context 的基础 HookuseDocumentModel:封装文档操作的高级 Hook,自动触发 UI 更新
- ✅ 阶段 0:环境、仓库、Copilot 工作流
- ✅ 阶段 1:TypeScript 核心与文档模型
- ✅ 阶段 2:React 前端基础架构
- 🚧 后续:Electron 桌面应用、Monaco 编辑器集成等