Chinese Replacer

一个VSCode插件，用于根据多语言文件自动替换选中的中文文本为对应的国际化key值。

功能特性

• 🔍 智能匹配: 根据选中的中文文本，在多语言文件中查找对应的key值
• 🔄 自动替换: 将选中的中文文本替换为国际化函数调用（如 t('key')）
• ⚙️ 灵活配置: 支持自定义多语言文件路径和函数前缀
• 🚀 自动搜索: 可以自动搜索项目中常见的多语言文件位置
• ➕ 快速添加: 未找到匹配key时，可以快速添加新的翻译条目

安装

1. 在VSCode中打开插件市场
2. 搜索 "Chinese Replacer"
3. 点击安装

使用方法

基本使用

1. 在代码中选中包含中文的文本
2. 使用以下任一方式进行替换：
   • 快捷键: 按 Ctrl+Alt+R (Mac: Cmd+Alt+R)
   • 右键菜单: 右键点击选中的文本，选择"替换选中的中文为国际化key"
   • 命令面板: 按 Ctrl+Shift+P 打开命令面板，输入"替换选中的中文为国际化key"
3. 插件会自动在多语言文件中查找匹配的中文，并替换为对应的key

示例

假设你的 zh.js 文件内容如下：

module.exports = {
  common: {
    confirm: "确认",
    cancel: "取消"
  },
  user: {
    login: "登录",
    logout: "退出"
  }
};

当你选中代码中的 "确认" 文本时，插件会将其替换为 t('common.confirm')。

配置选项

可以在VSCode设置中配置以下选项：

chineseReplacer.langFilePath

• 类型: string
• 默认值: ""
• 描述: 多语言文件的相对路径或绝对路径
• 示例: "src/locales/zh.js", "i18n/zh.json"

chineseReplacer.keyPrefix

• 类型: string
• 默认值: "t"
• 描述: 替换时使用的函数前缀
• 示例: 设置为 "$t" 会生成 $t('key')

chineseReplacer.autoSearch

• 类型: boolean
• 默认值: true
• 描述: 是否自动搜索项目中的多语言文件

chineseReplacer.searchPaths

• 类型: array
• 默认值: ["src/locales/zh.js", "src/lang/zh.js", "locales/zh.js", "lang/zh.js", "i18n/zh.js"]
• 描述: 自动搜索多语言文件的可能路径

命令

插件提供以下命令：

• chinese-replacer.replaceSelected: 替换选中的中文为国际化key
• chinese-replacer.selectLangFile: 选择多语言文件

右键菜单

插件在以下位置添加了右键菜单选项（显示在菜单顶部）：

• 编辑器右键菜单: 当选中文本时，右键菜单中会在顶部显示"替换选中的中文为国际化key"选项
• 文件资源管理器右键菜单: 在 .js 或 .json 文件上右键，会在顶部显示"选择多语言文件"选项

快捷键

• Ctrl+Alt+R (Windows/Linux) / Cmd+Alt+R (Mac): 替换选中的中文文本

支持的文件格式

• JavaScript文件 (.js): 支持 module.exports 格式
• JSON文件 (.json): 标准JSON格式

JavaScript格式示例

module.exports = {
  common: {
    confirm: "确认",
    cancel: "取消"
  }
};

JSON格式示例

{
  "common": {
    "confirm": "确认",
    "cancel": "取消"
  }
}

工作流程

1. 配置语言文件: 首次使用时，插件会尝试自动查找多语言文件，或者你可以手动配置路径
2. 选择中文文本: 在编辑器中选中包含中文的文本
3. 执行替换: 使用快捷键或命令面板执行替换操作
4. 自动匹配: 插件在多语言文件中查找匹配的中文内容
5. 完成替换: 如果找到匹配项，自动替换为国际化函数调用
6. 添加新条目: 如果没有找到匹配项，可以选择添加新的翻译条目

注意事项

• 确保多语言文件路径正确配置
• 支持嵌套对象结构的key值查找
• 替换后的代码需要确保对应的国际化函数已正确导入
• 建议在使用前备份重要文件

故障排除

插件无法找到多语言文件

1. 检查配置的文件路径是否正确
2. 确保文件存在且格式正确
3. 尝试使用"选择多语言文件"命令手动选择

替换后的代码不工作

1. 确保国际化函数（如 t）已正确导入
2. 检查函数前缀配置是否与项目中使用的一致
3. 验证生成的key值在多语言文件中确实存在

更新日志

1.0.0

• 初始版本发布
• 支持中文文本替换为国际化key
• 支持自动搜索和手动配置多语言文件
• 支持添加新的翻译条目

作者

zhangxue