i18n-super-cli
v1.0.1
Published
A custom i18n CLI tool for Vue projects
Maintainers
Readme
i18n-super-cli
专为VUE项目定制的国际化(i18n)CLI 工具,支持自动提取中文词条、Excel 互转、以及调用百度翻译 API 进行自动翻译。
安装
npm install i18n-super-cli --save-dev
# 或者全局安装
npm install -g i18n-super-cli快速开始
- 在项目根目录创建配置文件
i18n.config.js:
module.exports = {
// 源码根目录
rootDir: "src",
// 中文包裹配置
zhWrap: {
// 扫描 src 下的文件
rootDir: "src",
// 只处理 .vue 文件
i18nFileRules: ["**/*.vue"],
// Vue 文件中使用的国际化方法名
vueI18nFuncName: "$t",
},
// 提取配置
extract: {
// 扫描哪些文件
include: ["**/*.vue"],
exclude: ["**/node_modules/**/*"],
// 导出目录 (默认会自动根据 rootDir 生成)
// outputZh: "src/lang/modules/zh-CN",
// outputEn: "src/lang/modules/en"
},
// 翻译配置
translate: {
// 百度翻译 App ID
baiduAppId: "你的APP_ID",
// 百度翻译 Key
baiduKey: "你的密钥",
}
};- 在
package.json中添加脚本:
"scripts": {
"i18n:wrap": "i18n-super wrap",
"i18n:extract": "i18n-super extract",
"i18n:translate": "i18n-super translate",
"i18n:fill": "i18n-super fill"
}命令说明
1. 自动包裹中文 (wrap)
自动扫描源码中的中文文本,并使用 $t(...) 进行包裹。此功能基于 vve-i18n-zh-wrap-cli 实现。
i18n-super wrap2. 提取词条 (extract)
扫描指定文件中的中文词条(通过 $t('...') 识别),并生成 JSON 文件。
如果发现未翻译的词条,会在根目录生成 未翻译词条.xlsx 和 完整词条.xlsx。
i18n-super extract3. 自动翻译 (translate)
读取配置中的百度翻译 API Key,自动翻译英文 JSON 文件中尚未翻译的词条。
i18n-super translate4. 回填翻译 (fill)
读取根目录下的 resource.xlsx(通常由人工翻译后提供),将翻译结果回填到 JSON 文件中。
i18n-super fill配置项详解
配置文件名:
i18n.config.js
完整配置示例请参考包内的 i18n.config.example.js。
