i18n-language-xls/README.md

国际化词条转换

# i18n-language-xls

#### 介绍

node 国际化转换插件:

1. 支持Excel转换本地词条,生成国际化词条
2. 支持Excel实时同步更新转换本地词条
3. 支持本地本地词条转换生成Excel表格

#### 安装教程

```shell
npm i i18n-language-xls -D
yarn add i18n-language-xls -D
```

#### 使用说明案例

1. 新增 language.js

   ```js
    const languageRun = require('i18n-language-xls')
    languageRun({
      languageDir: 'test/language/data', // 本地词条所在目录
      xlsPath: 'test/language/language.xls', // Excel词条表格文件所在路径
      watchUpdateXls: true   // 是否实时同步更改本地国际化词条,默认false
   })
   ```

2. package.json  配置

```json
 "scripts": {
    "language": "node ./language.js"
  }
```

3. Install

```shell
npm i language
yarn language
```

#### Option

| 参数           | 说明                               |  类型   | 必填  | 默认值 |
| -------------- | ---------------------------------- | :-----: | :---: | :----: |
| languageDir    | 本地词条所在目录                   | string  |  是   |   无   |
| xlsPath        | 本地Excel文件所在路径              | string  |  是   |   无   |
| watchUpdateXls | 监听Excel变化,实时同步更新本地词条 | boolean |  否   | false  |

#### Mentions 方法

| 名称             | 描述              |
| ---------------- | ----------------- |
| updateExcel()    | 本地词条转换Excel |
| updateLanguage() | Excel转换本地词条 |

#### 注意事项

1. Excel 转换 本地词条:
   Excel 会根据"表头项" 作为文件名创建对应词条文件,生成对应词条文件,动态存放在同一目录下
2. 本地词条 转换 Excel:
   获取词条所在目录,把"内部文件名"作为"Excel表头项生成Excel词条表格

#### 格式模板

+ **文件目录**
![文件目录](./src/img_storage/1.png)
+ **Excel格式**
![Excel格式](./src/img_storage/2.png)
+ **JSON格式**
![JSON格式](./src/img_storage/3.png)