增加了 README、CHANGELOG 和 VERSION
This commit is contained in:
parent
9a3306ac86
commit
5912aa80e1
5
.gitignore
vendored
5
.gitignore
vendored
@ -1,2 +1,5 @@
|
||||
/out
|
||||
/node_modules
|
||||
/node_modules
|
||||
|
||||
*.vsix
|
||||
.DS_Store
|
||||
85
CHANGELOG.md
Normal file
85
CHANGELOG.md
Normal file
@ -0,0 +1,85 @@
|
||||
# 更新日志 (Changelog)
|
||||
|
||||
本项目遵循 [Semantic Versioning](https://semver.org/lang/zh-CN/) 语义化版本规范。
|
||||
|
||||
所有重要更改都将在此文件中记录。
|
||||
|
||||
## [Unreleased]
|
||||
### 计划中的功能
|
||||
- 添加翻译历史记录功能
|
||||
- 支持批量翻译
|
||||
- 添加自定义词典功能
|
||||
- 优化翻译缓存机制
|
||||
- 支持更多命名规范（kebab-case等）
|
||||
|
||||
---
|
||||
|
||||
## [0.0.1] - 2024-07-21
|
||||
|
||||
### 新增功能
|
||||
- **核心翻译功能**
|
||||
- 支持中文文本翻译为英文变量名
|
||||
- 支持英文文本翻译为中文
|
||||
- 支持文本选择后的快速翻译
|
||||
|
||||
- **命名规范支持**
|
||||
- 驼峰命名法 (camelCase)
|
||||
- 帕斯卡命名法 (PascalCase)
|
||||
- 下划线命名法 (snake_case)
|
||||
|
||||
- **多翻译引擎**
|
||||
- 集成 Google Translate API
|
||||
- 集成百度翻译 API
|
||||
- 支持配置切换翻译服务提供商
|
||||
|
||||
- **用户界面**
|
||||
- 右键菜单集成（编辑器上下文菜单）
|
||||
- 快捷键支持：
|
||||
- Ctrl+Alt+E / Cmd+Alt+E：翻译为英文变量名
|
||||
- Ctrl+Alt+C / Cmd+Alt+C：翻译为中文
|
||||
- 状态栏实时反馈
|
||||
- 翻译结果确认对话框
|
||||
|
||||
- **配置系统**
|
||||
- VSCode 设置面板集成
|
||||
- 支持配置默认命名规范
|
||||
- 支持配置翻译服务提供商
|
||||
- 支持百度翻译 API 密钥配置
|
||||
|
||||
### 技术特性
|
||||
- 基于 VSCode Extension API 开发
|
||||
- TypeScript 强类型支持
|
||||
- 异步翻译处理
|
||||
- 错误处理和用户友好的错误提示
|
||||
- 网络异常处理
|
||||
|
||||
### 开发相关
|
||||
- 项目初始化和基础架构搭建
|
||||
- 完整的开发文档
|
||||
- 支持调试模式（F5启动Extension Host）
|
||||
- 支持编译和打包
|
||||
|
||||
### 兼容性
|
||||
- VSCode 版本要求：≥ 1.85.0
|
||||
- Node.js 版本要求：≥ 16.x
|
||||
- 支持平台：Windows, macOS, Linux
|
||||
|
||||
---
|
||||
|
||||
## 版本格式说明
|
||||
|
||||
版本号格式：主版本号.次版本号.修订号 (MAJOR.MINOR.PATCH)
|
||||
|
||||
- 主版本号(MAJOR)：当进行了不兼容的API修改时递增
|
||||
- 次版本号(MINOR)：当以向后兼容的方式添加功能时递增
|
||||
- 修订号(PATCH)：当进行向后兼容的问题修正时递增
|
||||
|
||||
## 如何更新此日志
|
||||
|
||||
每次发布新版本时，请：
|
||||
1. 在 [Unreleased] 部分上方添加新版本条目
|
||||
2. 将 [Unreleased] 中的已完成功能移动到新版本下
|
||||
3. 添加发布日期和版本号
|
||||
4. 按类型分类整理更改内容
|
||||
5. 确保所有重要更改都被记录
|
||||
EOF < /dev/null
|
||||
159
README.md
Normal file
159
README.md
Normal file
@ -0,0 +1,159 @@
|
||||
# VSCode 中英文变量名翻译插件
|
||||
|
||||
一个智能的VSCode扩展插件，实现中英文文本与变量名的快速互译，支持多种命名规范。
|
||||
|
||||
## ✨ 功能特性
|
||||
|
||||
- **智能翻译**：支持中文→英文变量名，英文→中文的双向翻译
|
||||
- **命名规范**：支持驼峰命名(camelCase)、帕斯卡命名(PascalCase)、下划线命名(snake_case)
|
||||
- **多翻译引擎**：集成Google翻译和百度翻译双引擎
|
||||
- **快捷操作**：支持快捷键和右键菜单，操作便捷
|
||||
- **实时预览**：翻译结果实时显示，支持确认后替换
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 安装方式
|
||||
|
||||
1. **从VSCode扩展市场安装**（推荐）
|
||||
- 打开VSCode扩展面板 (`Ctrl+Shift+X`)
|
||||
- 搜索 "中英文变量名翻译"
|
||||
- 点击安装
|
||||
|
||||
2. **手动安装**
|
||||
- 下载 `.vsix` 文件
|
||||
- 在VSCode中运行 `Extensions: Install from VSIX...`
|
||||
|
||||
### 使用方法
|
||||
|
||||
#### 翻译为英文变量名
|
||||
- **快捷键**：选中中文文本，按 `Ctrl+Alt+E` (Mac: `Cmd+Alt+E`)
|
||||
- **右键菜单**：选中中文文本 → 右键 → "翻译为英文变量名"
|
||||
|
||||
#### 翻译为中文
|
||||
- **快捷键**：选中英文文本，按 `Ctrl+Alt+C` (Mac: `Cmd+Alt+C`)
|
||||
- **右键菜单**：选中英文文本 → 右键 → "翻译为中文"
|
||||
|
||||
## ⚙️ 配置说明
|
||||
|
||||
### 设置路径
|
||||
`文件 → 首选项 → 设置 → 扩展 → 中英文变量名翻译`
|
||||
|
||||
### 配置项
|
||||
|
||||
| 配置项 | 说明 | 默认值 | 可选值 |
|
||||
|--------|------|--------|--------|
|
||||
| `translate.namingConvention` | 变量命名规范 | `camelCase` | `camelCase`, `PascalCase`, `snake_case` |
|
||||
| `translate.translationService` | 翻译服务提供商 | `google` | `google`, `baidu` |
|
||||
| `translate.baiduAppId` | 百度翻译API的AppID | `""` | 你的百度AppID |
|
||||
| `translate.baiduSecretKey` | 百度翻译API的密钥 | `""` | 你的百度密钥 |
|
||||
|
||||
### 百度翻译API配置
|
||||
|
||||
如需使用百度翻译，请：
|
||||
1. 访问[百度翻译开放平台](https://fanyi-api.baidu.com/)
|
||||
2. 注册账号并创建应用
|
||||
3. 在插件设置中填写 `AppID` 和 `密钥`
|
||||
|
||||
## 🔧 开发指南
|
||||
|
||||
### 环境要求
|
||||
- Node.js (>= 16.x)
|
||||
- VSCode (>= 1.85.0)
|
||||
- TypeScript
|
||||
|
||||
### 本地开发
|
||||
|
||||
```bash
|
||||
# 克隆项目
|
||||
git clone <repository-url>
|
||||
|
||||
# 安装依赖
|
||||
npm install
|
||||
|
||||
# 编译TypeScript
|
||||
npm run compile
|
||||
|
||||
# 进入开发模式（监听文件变化）
|
||||
npm run watch
|
||||
```
|
||||
|
||||
### 调试
|
||||
|
||||
1. 按 `F5` 启动Extension Development Host
|
||||
2. 在新窗口中测试插件功能
|
||||
3. 查看调试控制台输出
|
||||
|
||||
### 打包发布
|
||||
|
||||
```bash
|
||||
# 编译生产版本
|
||||
npm run vscode:prepublish
|
||||
|
||||
# 生成.vsix文件
|
||||
npx vsce package
|
||||
```
|
||||
|
||||
## 📁 项目结构
|
||||
|
||||
```
|
||||
vscode-translate-plugin/
|
||||
├── src/
|
||||
│ ├── extension.ts # 主扩展入口
|
||||
│ ├── translationService.ts # 翻译服务
|
||||
│ └── namingFormatter.ts # 命名格式化
|
||||
├── docs/
|
||||
│ ├── design.md # 设计文档
|
||||
│ ├── 开发指南.md # 开发指南
|
||||
│ └── 用户指南.md # 用户指南
|
||||
├── package.json # 扩展配置
|
||||
└── tsconfig.json # TypeScript配置
|
||||
```
|
||||
|
||||
## 🐛 常见问题
|
||||
|
||||
### Q: 翻译失败怎么办？
|
||||
**A**:
|
||||
1. 检查网络连接
|
||||
2. 如果使用百度翻译，确认API配置正确
|
||||
3. 尝试切换翻译服务提供商
|
||||
|
||||
### Q: 如何修改快捷键？
|
||||
**A**:
|
||||
`文件 → 首选项 → 键盘快捷方式` → 搜索 "translate" 修改对应命令的快捷键
|
||||
|
||||
### Q: 翻译结果不准确？
|
||||
**A**:
|
||||
- 建议使用百度翻译API（需配置密钥），中文翻译质量更好
|
||||
- 可结合上下文调整原文表述
|
||||
|
||||
## 🤝 贡献指南
|
||||
|
||||
欢迎提交Issue和Pull Request！
|
||||
|
||||
### 开发规范
|
||||
- 使用TypeScript编写
|
||||
- 遵循ESLint代码规范
|
||||
- 添加必要的注释和文档
|
||||
- 确保功能测试通过
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
MIT License - 详见 [LICENSE](LICENSE) 文件
|
||||
|
||||
## 📝 更新日志
|
||||
|
||||
### v0.0.1 (2024-07-21)
|
||||
- ✨ 初始版本发布
|
||||
- 🌟 支持中英文双向翻译
|
||||
- 🌟 支持三种命名规范
|
||||
- 🌟 集成Google和百度翻译API
|
||||
- 🌟 支持快捷键和右键菜单操作
|
||||
|
||||
## 📞 联系方式
|
||||
|
||||
- 提交Issue：[Git Issues](http://10.0.0.99:4000/tian/TranslateCode/issues)
|
||||
- 邮箱：tianjianyong@gmail.com
|
||||
|
||||
---
|
||||
|
||||
**享受编码，让翻译更简单！** 🎉
|
||||
1
VERSION.md
Normal file
1
VERSION.md
Normal file
@ -0,0 +1 @@
|
||||
0.0.1
|
||||
Loading…
Reference in New Issue
Block a user