hkta-i18n-collect-cli
v0.1.25
Published
i18n environment Chinese extract and input
Downloads
27
Readme
项目 git 地址:i18n-collect-cli
npm 依赖包地址:i18n-collect-cli
issue 地址:issue
請把以下數據刪除 "cs__lang": { "cs_1": "/認證獎項", "cs_2": "/重大里程", "cs_3": "補習科目", "cs_4": "我的導師履歷", "cs_5": "HKTA香港導師會", "cs_6": "box-info 課程類型", "cs_7": "register-title 課程大綱", "cs_8": "課程大綱", "cs_9": "register-title 講師介紹", "cs_10": "講師介紹", "cs_11": "、rmvb", "cs_12": "register-title pb-4 pt-4 課程章節", "cs_13": "register-title 補習形式", "cs_14": "register-title 補習地區", "cs_15": "item-wrap 主修科目", "cs_16": "item-wrap 中文全名", "cs_17": "item-wrap 住宅類型", "cs_18": "register-title greater-than-md 地區", "cs_19": "width-full 詳細地址", "cs_20": "。" }
工具的功能
该工具有4个功能
目前工具的限制
- 目前脚本 仅支持 .vue 文件 中的中文提取与写入,如果涉及其他文件夹下的内容,可根据脚本内容进行修改对应需要处理的文件内容
- 目前支持 vue 项目
- 写入的脚本需 本地 node 环境版本不能低于 10.12.0
工具依赖包的安装
- 安装工具依赖包
$ npm i -g hkta-i18n-collect-cli
目前该工具属于全局指令操作,所以需要全局安装
项目中中文的提取
从项目中的 .vue 文件 文件中收集中文字符,并将收集到的字符存储到一个键值对的 .json 文件中
- 执行 getLang 进行提取中文操作,filename 默认为 zh_cn.json
$ i18n-cli getlang <src> -f <filename> -d <dir> -i <ignoredir>
i18n-cli getlang / -f new.json -d pages,components
- src 为入口目录
- filename 为生成的语言文件的文件名,必须为json格式, 默认为zh_cn.json
- dir 为要收集的文件目录, 默认为 [pages, components]
- ignoredir 为 dir 目录下被忽略的文件目录
需要創建一個新目錄和src目錄,新目錄是爲了存儲新的pages和components,而src目錄是爲了放入舊的pages文件和components文件以便writelang獲取
如输入下面的指令后会从 pages,components 目录中提取 vue 文件内的中文并生成一个 zh.json 文件
$ i18n-cli getlang src -f zh.json -d pages,components
执行完成后会在同级目录下生成一个 zh_cn.json 文件,通过json格式化后(必须要格式化,否则后续通过 $t 写入项目会报错),内容格式形同如下:
{
'cs_common': {
'cs_1': '用户ID',
'cs_2': '搜索',
},
'cs_error': {
'cs_3': '请输入小于200字符!',
'cs_4': '请正确填写年龄([0~120])!'
}
}
- 将 zh_cn.json 文件中的中文对应的 key 用语义化字符串代替,修改后得到的 zh_cn.json 文件如下
{
'cs_common': {
'userId': '用户ID',
'search': '搜索',
},
'cs_error': {
'maxInput': '请输入小于200字符!',
'ageTip': '请正确填写年龄([0~120])!'
}
}
项目中中文的替换
将提取的中文文件(.json 文件)中的中文以 i18n (如
$t('a.b')
)的形式替换到项目对应的中文位置
- 执行 writeLang 将中文以 i18n 的模式写入文件(仅支持 components 与 pages 里的 .vue 文件)
$ i18n-cli writelang <srcDist> -f <filename> -d <dir> -i <ignoredir>
- srcDist 为复制 src 出来的文件夹名
- filename 为生成的语言文件的文件名,必须为json格式, 默认为zh_cn.json
- dir 为要替换成 $t 的文件目录, 默认为 pages, components
- ignoredir 为 dir 目录下被忽略的文件目录
注:
1、非 .vue 文件需要引用 i18n 才能使用
2、dir 可以是src下的任意文件目录
执行以上脚本后会在 src 同级目录生成 srcDist 文件夹,文件夹内仅包含 components 与 pages 文件夹下的 .vue 文件
将 srcDist 文件夹内容替换到 src 文件夹中,覆盖重复的文件
将 zh_cn.json 内数据放入项目中的多语言模块如 zh.js 文件中,运行项目,全局遍历一下是否有遗漏
注: 以上基于项目中已加入 i18n ,并且已做好配置。
该脚本还不够完善,目前仅支持部分常用模版的文案提取,有其他使用场景的,可以帮忙补充。
国际化语言提取与写入
可用于提取js文件里的关键数据,转成excel表格交给专业的人进行翻译
国际化语言的提取
将项目中使用的语言配置文件(如 zh.js)转换成 excel 文件,支持增量的提取
1、将语言文件 zh.js 转成 excel 表格,好提供给专业的人进行翻译
$ i18n-cli toexcel <url> <translateUrl> <filename>
url 必填,为js文件的路径
translateUrl 选填,为已经翻译的语言的js,用于提取语言增量
filename 默认为zh.xlsx, 默认保存路径为当前执行命令的路径,且保存路径不可修改
export default {
'common': {
'workOrder': '工单类型',
'operateSucc': '操作成功',
'testDrive': '试驾',
'detail': '详情',
'selectEquity': '选择权益',
'selectEvent': '选择事件',
'sorry': '抱歉'
...
}
...
}
如果没有选择已经翻译的语言的js时,最后生成的excel表格如下
如果选择了已经翻译的语言的js,如
export default {
'cs_common': {
'detail': 'detail',
'selectEquity': 'selectEquity',
'selectEvent': 'selectEvent',
'sorry': 'sorry'
}
}
则生成的 excel 表格如下
此时,将key列隐藏后(防止key值被修改)即可将此 excel 表格提供给专业的人员,做专业的翻译了
国际化语言的写入
将翻译好的 excel 文件转成对应的语言配置文件(如转成 en.js)
翻译完成后还需将 excel 表格的翻译内容用该脚本处理成js文件,引入到项目中做多语言的展示
1、将翻译好的文件整理成 js 文件
$ i18n-cli tojs <url> <filename>
- [filename] 多语言js文件,默认 translate.js, 默认当前位置,不能修改存储地址,如xx.js
- [url] excel文件路径,格式可以为".xls", ".xml",".xlsx",".xlsm"
如 excel 文件内容如下
执行结束后会在根目录生成一个 translate.js 文件,文件内容如下
欢迎issue
附录
1、若遇到安装该工具出现无权限问题时,建议使用管理员权限安装或将npm的依赖安装目录设置为非系统路径
2、项目中中文内容中包含 >、<、= 字符需转换成大于、小于、等于等中文字样。如:'分数>=200分的' 需转换成 '分数大于等于200分的'
3、如果是将英文转excel,则对应的英文需要转义
// bad
export default {
cs_common: {
tip: 'it"s me'
}
}
//good
export default {
cs_common: {
tip: 'it\"s me'
}
}
//good
export default {
cs_common: {
tip: 'it\'s me'
}
}