Fix bug,发布0.0.1版本

This commit is contained in:
tianjianyong 2025-07-20 12:50:44 +08:00
parent 2c3e291411
commit 9a3306ac86
7 changed files with 354 additions and 5 deletions

View File

@ -0,0 +1,10 @@
{
"permissions": {
"allow": [
"Bash(npm run compile:*)",
"Bash(npm install:*)",
"Bash(vsce package)"
],
"deny": []
}
}

10
.vscodeignore Normal file
View File

@ -0,0 +1,10 @@
.vscode/**
.vscode-test/**
src/**
.gitignore
.yarnrc
vsc-extension-quickstart.md
**/tsconfig.json
**/.esyncignore
**/*.map
**/*.ts

45
CLAUDE.md Normal file
View File

@ -0,0 +1,45 @@
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Project Overview
This is a VSCode extension plugin for translating between Chinese and English variable names. It translates selected Chinese text to English variable names and vice versa, with support for multiple naming conventions (camelCase, PascalCase, snake_case).
## Architecture
- **Core Extension**: `src/extension.ts` - Main VSCode extension entry point
- **Translation Service**: `src/translationService.ts` - Handles Google Translate and Baidu Translate API integrations
- **Naming Formatter**: `src/namingFormatter.ts` - Converts translated text to proper variable naming conventions
## Build Commands
- `npm run compile` - Compile TypeScript to JavaScript
- `npm run watch` - Watch mode for development
- `npm run vscode:prepublish` - Pre-publish compilation
## Development Setup
1. Install dependencies: `npm install`
2. Compile TypeScript: `npm run compile`
3. Press F5 in VSCode to launch Extension Development Host
4. Test commands: `Ctrl+Alt+E` (translate to English), `Ctrl+Alt+C` (translate to Chinese)
## Key Configuration Settings
- `translate.namingConvention`: Variable naming style (camelCase/PascalCase/snake_case)
- `translate.translationService`: Translation provider (google/baidu)
- `translate.baiduAppId`: Baidu API app ID
- `translate.baiduSecretKey`: Baidu API secret key
## Extension Commands
- `translate.toEnglish`: Translate selected Chinese text to English variable name
- `translate.toChinese`: Translate selected English text to Chinese
## File Structure
- `src/` - TypeScript source files
- `out/` - Compiled JavaScript output
- `docs/design.md` - Design documentation in Chinese
- `package.json` - Extension manifest with commands and configuration

139
docs/开发指南.md Normal file
View File

@ -0,0 +1,139 @@
# VSCode翻译插件开发指南
## 环境准备
### 1. 安装Node.js
确保已安装Node.js 16+版本:
```bash
node --version
```
### 2. 安装依赖
```bash
npm install
```
### 3. 安装开发工具
```bash
# 安装VSCode扩展打包工具
npm install -g @vscode/vsce
```
## 开发流程
### 1. 编译代码
```bash
# 开发模式(监听文件变化自动编译)
npm run watch
# 生产模式编译
npm run compile
```
### 2. 调试扩展
1. 按 `F5` 启动扩展开发主机
2. 在新窗口中测试扩展功能
3. 在原始窗口中查看调试控制台输出
### 3. 代码检查
确保没有TypeScript错误
```bash
npm run compile
```
## 打包发布
### 1. 本地打包
```bash
# 创建VSIX扩展包
vsce package
# 使用优化参数打包
vsce package --allow-missing-repository --allow-star-activation
```
### 2. 发布到市场
```bash
# 首次发布需要Azure DevOps账号
vsce publish
# 更新版本发布
vsce publish minor # 次版本更新
vsce publish patch # 补丁版本更新
```
### 3. 版本管理
修改`package.json`中的版本号:
```json
{
"version": "0.0.2"
}
```
## 文件结构说明
```
vscode-translate-plugin/
├── src/ # 源代码目录
│ ├── extension.ts # 扩展主入口
│ ├── translationService.ts # 翻译服务
│ └── namingFormatter.ts # 命名格式化
├── out/ # 编译输出目录
├── docs/ # 文档目录
├── package.json # 扩展配置
└── tsconfig.json # TypeScript配置
```
## 配置项说明
### package.json关键配置
- `activationEvents`: 扩展激活事件
- `contributes.commands`: 注册命令
- `contributes.menus`: 右键菜单配置
- `contributes.keybindings`: 快捷键配置
- `contributes.configuration`: 用户设置
### 常用开发命令
```bash
# 开发相关
npm run compile # 编译TypeScript
npm run watch # 监听编译
npm run vscode:prepublish # 预发布编译
# 打包相关
vsce package # 打包为VSIX
vsce publish # 发布到市场
vsce ls # 查看包含的文件
```
## 调试技巧
### 1. 查看日志
在VSCode开发者工具中查看控制台输出
- 帮助 -> 切换开发者工具
- 查看Console标签页的日志
### 2. 断点调试
在`src/extension.ts`中设置断点使用F5启动调试。
### 3. 测试不同场景
- 测试中文转英文变量名
- 测试英文转中文翻译
- 测试不同命名规范camelCase、PascalCase、snake_case
- 测试不同翻译服务Google、百度
## 常见问题解决
### 1. 扩展不激活
检查`activationEvents`配置是否正确。
### 2. 右键菜单不显示
确保`when`条件正确,如`editorHasSelection`。
### 3. 快捷键无效
检查快捷键冲突和`when`条件。
### 4. 打包错误
- 检查TypeScript编译错误
- 确保所有依赖已安装
- 检查package.json格式

146
docs/用户指南.md Normal file
View File

@ -0,0 +1,146 @@
# VSCode中英文变量名翻译插件 - 用户指南
- 作者:田建勇
- 邮件tianjianyong@gmail.com
- 版本0.0.1
- 时间2025-7-20
## 简介
这是一个VSCode扩展插件可以帮助您快速在中文和英文之间进行翻译特别适用于编程时的变量命名。
主要功能:
- 将中文翻译为符合命名规范的英文变量名
- 将英文翻译为中文
- 支持多种命名规范:驼峰命名、帕斯卡命名、下划线命名
- 支持Google翻译和百度翻译服务
## 安装方法
### 方法1通过VSIX文件安装推荐
1. **下载扩展包**
- 获取 `vscode-translate-plugin-0.0.1.vsix` 文件
2. **安装扩展**
- 打开VSCode
- 点击左侧扩展图标(或按 `Ctrl+Shift+X`
- 点击右上角的"..."菜单(更多操作)
- 选择"从VSIX安装..."
- 选择下载的 `vscode-translate-plugin-0.0.1.vsix` 文件
- 安装完成后重启VSCode
### 方法2命令行安装
如果您有VSIX文件可以使用命令行安装
```bash
code --install-extension vscode-translate-plugin-0.0.1.vsix
```
## 使用方法
### 基本使用
#### 中文转英文变量名
1. 在编辑器中选中要翻译的中文文本
2. 使用以下任一方法:
- **右键菜单**:右键 → "翻译为英文变量名"
- **快捷键**`Ctrl+Alt+E`Mac: `Cmd+Alt+E`
3. 选中文本将被替换为格式化后的英文变量名
#### 英文转中文
1. 在编辑器中选中要翻译的英文文本
2. 使用以下任一方法:
- **右键菜单**:右键 → "翻译为中文"
- **快捷键**`Ctrl+Alt+C`Mac: `Cmd+Alt+C`
3. 会弹窗显示翻译结果,可选择是否替换原文本
### 使用示例
#### 示例1中文变量名翻译
```
// 选中"用户列表" → 翻译为英文变量名
temp -> userList
```
#### 示例2英文翻译为中文
```
// 选中"userList" → 翻译为中文
userList -> 用户列表
```
## 配置设置
### 打开设置
1. 打开VSCode设置`Ctrl+,` 或 `Cmd+,`
2. 搜索"translate"
### 可配置项
#### 1. 变量命名规范
- **设置项**`translate.namingConvention`
- **选项**
- `camelCase`(默认):驼峰命名,如 `userName`
- `PascalCase`:帕斯卡命名,如 `UserName`
- `snake_case`:下划线命名,如 `user_name`
#### 2. 翻译服务提供商
- **设置项**`translate.translationService`
- **选项**
- `google`默认Google翻译
- `baidu`:百度翻译
#### 3. 百度翻译API配置可选
如果使用百度翻译服务,需要配置:
- **设置项**`translate.baiduAppId`
- **设置项**`translate.baiduSecretKey`
### 配置示例
```json
{
"translate.namingConvention": "camelCase",
"translate.translationService": "google"
}
```
## 常见问题
### Q: 右键菜单不显示翻译选项?
A: 确保已选中文本且扩展已正确安装。尝试重启VSCode。
### Q: 快捷键不起作用?
A:
1. 检查是否已选中文本
2. 检查是否有快捷键冲突:文件 → 首选项 → 键盘快捷方式
3. 可以尝试重新设置快捷键
### Q: 翻译失败?
A:
1. 检查网络连接
2. 如果使用百度翻译确保API密钥正确配置
3. 尝试切换翻译服务提供商
### Q: 如何卸载扩展?
A:
1. 打开扩展面板Ctrl+Shift+X
2. 找到"中英文变量名翻译"扩展
3. 点击"卸载"按钮
4. 重启VSCode
## 支持语言
- **源语言**:中文、英文
- **目标语言**:根据所选翻译服务支持的语言
## 注意事项
1. **网络要求**:需要网络连接才能使用翻译功能
2. **文本长度**:建议翻译较短的文本,长文本可能影响准确性
3. **API限制**免费API可能有使用频率限制
4. **变量命名**:翻译结果会自动转换为合法的变量名格式
## 获取帮助
如果遇到问题或有建议,请查看下列信息,并联系作者:
- 检查扩展的详细说明和更新日志
- 查看VSCode的开发者控制台获取错误信息

View File

@ -5,14 +5,13 @@
"version": "0.0.1",
"publisher": "tianjianyong",
"engines": {
"vscode": "^1.60.0"
"vscode": "^1.85.0"
},
"categories": [
"Other"
],
"activationEvents": [
"onCommand:translate.toEnglish",
"onCommand:translate.toChinese"
"*"
],
"main": "./out/extension.js",
"contributes": {
@ -31,12 +30,12 @@
{
"when": "editorHasSelection",
"command": "translate.toEnglish",
"group": "translation"
"group": "1_modification@1"
},
{
"when": "editorHasSelection",
"command": "translate.toChinese",
"group": "translation"
"group": "1_modification@2"
}
]
},

Binary file not shown.