141 lines
3.0 KiB
Markdown
141 lines
3.0 KiB
Markdown
# VSCode 中英文变量名翻译插件设计文档
|
||
|
||
## 1. 项目概述
|
||
|
||
### 1.1 项目目标
|
||
开发一个VSCode插件，实现以下核心功能：
|
||
- 把选中的中文翻译成英文变量名并替换
|
||
- 支持选中英文文本翻译为中文
|
||
- 提供变量命名规范化处理（支持驼峰命名、帕斯卡命名、下划线命名）
|
||
|
||
### 1.2 技术栈选择
|
||
- 开发语言：TypeScript
|
||
- 开发框架：VSCode Extension API
|
||
- 翻译服务：OpenAI API（提供更准确的上下文翻译）
|
||
- 开发工具：VSCode、Node.js
|
||
|
||
## 2. 系统架构
|
||
|
||
### 2.1 核心模块
|
||
1. **选中文本翻译模块**
|
||
- 获取用户选中的中文文本
|
||
- 处理选中的中文内容
|
||
- 触发翻译流程
|
||
|
||
2. **翻译服务模块**
|
||
- 集成Google Translate API 和百度翻译API
|
||
- 处理翻译请求
|
||
- 缓存常用翻译结果
|
||
|
||
3. **变量命名处理模块**
|
||
- 驼峰命名转换
|
||
- 变量命名规范检查
|
||
- 特殊字符处理
|
||
|
||
4. **用户界面模块**
|
||
- 翻译结果展示
|
||
- 快捷命令注册
|
||
- 配置界面
|
||
|
||
### 2.2 数据流
|
||
1. 用户输入/选择文本
|
||
2. 触发翻译事件
|
||
3. 调用翻译服务
|
||
4. 处理翻译结果
|
||
5. 更新编辑器文本
|
||
|
||
## 3. 功能详细设计
|
||
|
||
### 3.1 中文翻译为英文变量名
|
||
- 获取用户选中的中文文本
|
||
- 调用翻译API获取英文翻译
|
||
- 应用变量命名规范
|
||
- 替换原文本
|
||
|
||
### 3.2 选中文本翻译
|
||
- 注册命令`translate.toEnglish`和`translate.toChinese`
|
||
- 获取选中文本范围和内容
|
||
- 调用翻译服务
|
||
- 在状态栏或悬浮窗显示翻译结果
|
||
- 提供快速替换选项
|
||
|
||
### 3.3 变量命名规范化
|
||
- 支持驼峰命名(camelCase)
|
||
- 支持帕斯卡命名(PascalCase)
|
||
- 支持下划线命名(snake_case)
|
||
- 自动移除特殊字符
|
||
- 处理多词组合
|
||
|
||
### 3.4 配置选项
|
||
- 翻译服务API配置
|
||
- 默认变量命名风格
|
||
- 快捷键自定义
|
||
- 自动翻译开关
|
||
- 翻译结果展示方式
|
||
|
||
## 4. 性能优化
|
||
|
||
### 4.1 翻译性能
|
||
- 实现本地翻译缓存
|
||
- 批量翻译请求合并
|
||
- 设置翻译频率限制
|
||
|
||
### 4.2 编辑器性能
|
||
- 防抖处理输入事件
|
||
- 异步处理翻译请求
|
||
- 优化文本替换操作
|
||
|
||
## 5. 错误处理
|
||
|
||
### 5.1 翻译服务异常
|
||
- API调用失败重试机制
|
||
- 错误信息友好展示
|
||
- 降级使用备用翻译服务
|
||
|
||
### 5.2 输入异常
|
||
- 非法字符检测
|
||
- 超长输入限制
|
||
- 特殊格式处理
|
||
|
||
## 6. 安全性考虑
|
||
|
||
### 6.1 API密钥管理
|
||
- 安全存储API密钥
|
||
- 加密传输敏感信息
|
||
- 访问权限控制
|
||
|
||
### 6.2 数据安全
|
||
- 本地缓存加密
|
||
- 用户数据保护
|
||
- 隐私政策遵守
|
||
|
||
## 7. 后续优化方向
|
||
|
||
### 7.1 功能扩展
|
||
- 支持更多翻译服务
|
||
- 添加自定义词典
|
||
- 批量翻译功能
|
||
- 翻译历史记录
|
||
|
||
### 7.2 用户体验
|
||
- 智能上下文理解
|
||
- 实时翻译预览
|
||
- 多语言支持
|
||
- 统计分析功能
|
||
|
||
## 8. 开发计划
|
||
|
||
### 8.1 第一阶段
|
||
- 基础框架搭建
|
||
- 核心翻译功能实现
|
||
- 基本UI组件开发
|
||
|
||
### 8.2 第二阶段
|
||
- 性能优化
|
||
- 错误处理完善
|
||
- 配置功能实现
|
||
|
||
### 8.3 第三阶段
|
||
- 功能测试与修复
|
||
- 文档编写
|
||
- 发布与维护 |