# i18nhelper-vscode

**Repository Path**: neat-logic/i18nhelper-vscode

## Basic Information

- **Project Name**: i18nhelper-vscode
- **Description**: vscode插件，能根据选中的文本，在i18n语言文件中查找匹配的key并进行替换，如果key不存在，会自动添加新的key并完成翻译。
- **Primary Language**: JavaScript
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 10
- **Forks**: 6
- **Created**: 2023-03-17
- **Last Updated**: 2024-11-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: vscode插件, i18n, i18n自动翻译, i18n自动替换

## README

中文 / [English](README.en.md)

<p>
    <a href="https://opensource.org/license/gpl-3-0/" alt="License">
        <img src="https://img.shields.io/badge/License-GPL--3.0-green" /></a>
<a target="_blank" href="https://join.slack.com/t/neatlogichome/shared_invite/zt-1w037axf8-r_i2y4pPQ1Z8FxOkAbb64w">
<img src="https://img.shields.io/badge/Slack-Neatlogic-orange" /></a>
<a target="_blank" href="https://marketplace.visualstudio.com/items?itemName=neatlogic.i18nhelper"><img alt="Visual Studio Marketplace Installs" src="https://img.shields.io/visual-studio-marketplace/i/neatlogic.i18nhelper"></a></p>

---
## 功能

自动转换选中文本为i18n中的key，如果中文不存在，则自动往对应的i18n配置文件中写入key和文本内容。
![intro.gif](images/intro.gif)

## 使用要求

本插件要求i18n文件已经按类型组织起来，例如分别有两个i18n配置文件page/zh.json和button/zh.json，分别管理页面翻译和按钮翻译，内部组织结构是：

page/zh.json:
``` json
{
"name":"名称",
"age":"年龄"
}
```
button/zh.json
``` json
{
"submit":"提交",
"delete":"删除"
}
```

页面引用：`$t('page.name')`或`$t('button.submit')`

如果您的i18n组织架构和上面类似，则可以使用本插件方便的管理所有key和文案。


## 使用方式

### 第一次使用
1. 在编辑器中打开鼠标右键菜单，点击i18nhelper:配置 配置文件路径。

``` json
{
  "i18nhelper": [
    {
      "type": "page",
      "path": "/src/resources/assets/languages/page/zh.json",
      "path_en": "/src/resources/assets/languages/page/en.json",//target language config file
      "path_jp": "/src/resources/assets/languages/page/jp.json"//target language config file
    },
    {
      "type": "button",
      "path": "/src/resources/assets/languages/button/zh.json",
      "path_en": "/src/resources/assets/languages/button/en.json",//target language config file
      "path_jp": "/src/resources/assets/languages/button/jp.json"//target language config file
    }
  ],
   "translate": {
    "source": "zh",
    "target": ["en","jp"],//target language list
    "appid": "百度appid",
    "secret": "百度密钥"
  }
}
```
path是从workspace开始的相对路径，type是页面引用时的分类前缀。

2. 选中一段文本，打开鼠标右键，点击i18nhelper:替换，插件会自动根据选中文本替换成配置文件中对应的key，如果key不存在，可以通过输入框输入新的key，插件会自动把key和文本写入对应分类的配置文件中。

3. 如果配置了translate，会启动自动翻译，翻译来源百度开放api，请自行到[百度翻译](http://api.fanyi.baidu.com/)开放平台申请账号。
   
4. 配置快捷键，目标命令:i18nhelper.replace。