https://github.com/noah227/hx-i18n-helper
https://github.com/noah227/hx-i18n-helper
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/noah227/hx-i18n-helper
- Owner: noah227
- Created: 2024-04-16T08:34:46.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-15T06:22:03.000Z (about 1 year ago)
- Last Synced: 2024-05-15T22:04:04.612Z (about 1 year ago)
- Language: JavaScript
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# hx-i18n-helper
> HBuilderX开发国际化辅助工具，解放无聊的手动操作
* 快速初始化
* 快速同步
## 使用
```js
const {i18nHelper} = require("../dist/index.js")
const helper = i18nHelper()
// 初始化所需要的nls文件，默认nls文件将自动检测处理（创建）
helper.initLocales(["ja", "fr"])
// 此过程会从package.json里提取部分可能存在i18n应用的key进行拍平处理，生成默认的nls文件
// 如果后续package.json有变动的i18n相关的键，重新调用此函数以更新nls文件内容
helper.generateNls()
// 从默认nls文件向其他nls文件同步，同步会跳过已经配置过的内容
// （比如package.nls.en.js中的description字段翻译过了，那么在同步时会跳过该字段）
helper.syncLocales()
// 生成一个简单的键值对辅助文件，对于js代码内需要使用i18n的地方进行智能推断辅助
helper.generateJsHelper()
// 支持自定义输出文件名
// 如果觉得在js代码里使用key太长了可以传第二个参数启用简化
// helper.generateJsHelper("helper.js", true)
// 自动判断locale并从i18n文件中获取内容，主要是在js代码中辅助使用
helper.i18nGet("key", "这是默认值123")
// 批量获取i18n内容，返回Object
helper.i18nGets(["key1", "key2"])
// 也可以配置默认值
helper.i18nGets(["key1", ["key2", "这是默认值123"]])
```
## 使用实例
* [hx-restart-ide](https://github.com/noah227/hx-restart-ide)