i18n-automatically
使用babel解析成AST,替换中文为指定的key之后,在还原。
采用prettier格式化代码。默认读取项目根目录的prettier配置文件(.prettierrc.js
)。
介绍
一键扫描整个项目的中文
替换成key
,并生成指定的语言包翻译文件。
- 自动检测并替换中文字符串
- 生成唯一的翻译键
- 支持递归处理整个项目目录
- 支持文案回显
- 支持一键生成指定翻译包文件
- 支持语言切换显示
结果对比
vue对比图:
点击链接查看完整对比图:https://www.diffchecker.com/WjmYT5g4/
jsx对比图:
点击链接查看完整对比图:https://www.diffchecker.com/bYgP5eUP/
ts对比图:https://www.diffchecker.com/IRWBVjHe/
js对比图:https://www.diffchecker.com/VyO3Zw6b/
tsx对比图:https://www.diffchecker.com/OaZLu99x/
扫描中文
扫描当前文件的所有的中文,并替换成key
,并生成 zh.json
文件。
批量扫描中文
弹出选择文件夹,扫描所选文件夹的所有的中文,并替换成key
,并生成 zh.json
文件。
生成语言包
弹出输入框(默认en),根据 zh.json
生成指定语言包文件
切换语言
替换之后在有key
的每一行后面会显示对应的中文, 点击切换语言会切换成对应的语言。
读取的是本地文件,比如刚才生成了 en.json
就可以切换en
语言
配置文件
属性 |
描述 |
默认值 |
i18nFilePath |
指定国际化文件的根目录。 |
'/src/i18n' |
autoImportI18n |
是否自动导入i18n模块。 |
true |
i18nImportPath |
自动导入i18n模块的路径。 |
'@/i18n' |
templateI18nCall |
在 Vue 模板中调用翻译函数的语法。 |
'$t' |
scriptI18nCall |
在 JavaScript 文件中调用翻译函数的语法。 |
'i18n.t' |
keyFilePathLevel |
生成的语言包的键中文件路径的层级。 |
2 |
excludedExtensions |
排除的文件后缀名 |
[".svg",".png",".jpg",".jpeg",".gif",".bmp",".ico",".md",".txt",".json",".css",".scss",".less",".sass",".styl"] |
excludedStrings |
排除的字符串 |
["宋体","黑体","楷体","仿宋","微软雅黑","华文","方正","苹方","思源","YYYY年MM月DD日"] |
debug |
是否开启调试模式。 |
false |
baidu.appid |
百度翻译的应用ID。 |
- |
baidu.secretKey |
百度翻译的密钥。 |
- |
申请百度翻译
https://api.fanyi.baidu.com/doc/21
按照流程申请百度翻译api权限
然后点击开发者信息, https://api.fanyi.baidu.com/manage/developer,复制appid
和secretKey
到配置文件中
提示:这里要选择高级版本。只要实名认证了,都可以高级版本,api没有那么多限制
更新提醒
1.1.0 版本以前是采用正则匹配的模式, 优点是不改变原有的代码结构,缺点是对于复杂的模版字符串容易有适配不完全的问题,需要手动处理一小部分
1.1.0 版本以后采用babel解析成AST,替换中文为指定的key之后,在还原。优点是适配更好,缺点是会改变原有的结构,比如空格,换行等都会丢失。
所以采用了prettier格式化代码。默认读取项目根目录的prettier配置文件(.prettierrc.js
)。
提醒:如果是1.1.0之前的版本,要手动更新配置文件
方法:
- 要手动删除原来的配置文件,重新生成。右键-设置 重新生成配置文件。
- 重新扫描会重新生成配置文件。
- 手动复制缺少的配置。
{
"i18nFilePath": "/src/i18n",
"autoImportI18n": true,
"i18nImportPath": "@/i18n",
"templateI18nCall": "$t",
"scriptI18nCall": "i18n.t",
"keyFilePathLevel": 2,
"excludedExtensions": [
".svg",
".png",
".jpg",
".jpeg",
".gif",
".bmp",
".ico",
".md",
".txt",
".json",
".css",
".scss",
".less",
".sass",
".styl"
],
"excludedStrings": ["宋体", "黑体", "楷体", "仿宋", "微软雅黑", "华文", "方正", "苹方", "思源", "YYYY年MM月DD日"],
"debug": false,
"baidu": {
"appid": "",
"secretKey": ""
}
}
未开发功能
开发
https://github.com/wu529778790/i18n-automatically
安装依赖
yarn
F5 启动, 调试
下载打包依赖
yarn add @vscode/vsce -g
打包
vsce package --yarn