市面上有很多 i18n(国际化)方案,其中还是以 i18next
为主流。而 poeditor 的网站也是为了支持 i18n,可以在线编辑 po 文件,对于对开发提供了很大的便利。那么今天要分享的就是:npm
包 poeditor-tool
使用教程。
通过 poeditor-tool
,我们可以用命令行的方式自动化获取、生成、上传目标语言文件到 poeditor 网站。如果你正在使用 poeditor
和 i18next
,那这个工具肯定会对你很有帮助。
安装
使用 npm
安装即可:
npm install -g poeditor-tool
- -g 是全局安装,这里仅仅是编辑器的调用,自己写代码的话就不需要全局安装。
上传配置
我们通过 poeditor 官方页面的教程可以非常快速的搭建并准备好 poeditor 的账号。步骤是这样的:
- 注册并登录账号,创建一个新项目;
- 在项目设置页面找到 API Access Token,或直接用项目ID和Token接口;
- 填写 API Access Token 信息。
执行下述命令配置 API access token:
poeditor config:set {TOKEN} {PROJECT_ID}
TOKEN 和 PROJECT_ID 从 poeditor 官网中可以获取。
下载翻译文件
执行 poeditor pull
命令即可下载翻译文件:
poeditor pull --languages "en,de,zh"
这里我们指定了下载英文、德文以及中文汉化后的版本。
上传翻译文件
执行 poeditor push
命令即可上传翻译文件:
poeditor push --languages "en,de,zh" --update-source
通过 poeditor push
开始上传。我们指定了英文、德文以及中文,并且加上了一个 --update-source
选项,这意味着 poeditor 里面新增的翻译词条也需要更新到源文件里面。
以上就是该工具的基本使用方法。
示例代码
下面为读者提供部分代码示例。
我们先来看一下 config 文件:
# .poeditor.yml token: "34343434343434343434" project_id: "434343"
下载翻译文件:
-- -------------------- ---- ------- -- ------------ ----- ----- - ------------------- ----- - -------- - - ------------------- ----- -- - -------------- ----- - - ------------------ ----- ---------- - ----------------------------- -- ---------------------------- - ------------------------- ------------- -------------- - ----- - ------ ---------- - - ------------------------------------ --------- ----- --------- - ------ ----- ------ ----- ---------- - ---------------------- -- - ----- ---- - -------------------------------------- ----- -------- - ----------------- ------------------------ ----- -- -------------- --- -- - ----------------------- --------- -------------- - ----- ------- - --------- ---- ----------- ----------- ------- -------- ---- ------------- -------- -- -- --------- ------ --- ----------------- ------- -- - ------------------- ------ ------- ------- -- - -- ----- --- -- - ---------------- ----------- --------------- -------- -- ------- ---- ----------- ------------ ------------------- ---- ------- - ---- - ---------------- ----------- ------- -------------------- ---- ---------- - --- --- --- ------------------------------- -- - ----- -------- - --- ---------------------- -- - -------------- - -------------------------------------------------- -------- --- ----- ------ - ----------------------------------------------------------------- -------- ----- ------- - ------------------------------------------------------------------- -------- ------------------------------------------- ---------- -- - ----- -------- - ---------------------------- -------- ------------------------ ----- - -- ----------------- --- ---------- ------- ----- ------------ - --- ------------------------------------------------- ------- - ----- ---- - ---------------------------------- ----- -------- - ----- ------- - ------------------- -- --------------- --- -- - --------------- - -------------------------- ------ - ------ ---- -- ---- -- ------------------------- - -- - ------------------------ - ------------ - --- ------------------------------ -------------- ------------- ------ -- ----------- - ------------------------- --------- ---------------------- ------------- ---------------------- ------------- ---------------------- ------------- ------- -------------- -- - ------------------------------ -------------- ---
上传翻译文件:
-- -------------------- ---- ------- -- ----------------------- ----- ----- - ------------------- ----- - -------- - - ------------------- ----- -- - -------------- ----- - - ------------------ ----- ---------- - -------------------------------- -- ---------------------------- - ------------------------- ------------- -------------- - ----- - ------ ---------- - - ------------------------------------ --------- ----- ----------- - ----------------------- ----- --------- - ------------------ - - - ----------- - ------ ----- ------ ----- ---------- - ---------------------- -- - ----- ---- - ----------------------------------------- -- ---------------------- - -------------- ----------- --- ---------- --- --- --------------- -------------- - ----- ------- - --------- ---- ------ ------- ------- -------- ---- ------------- ---------- ------------- ------ --- ----------------- ------- -- - ------------------- ------ ------- ------- -- - -- ----- --- -- - ---------------- ----------- ----------- ------------------- ---- ------- - ---- - ---------------- ----------- ------- -------------------- ---- ---------- - --- --- --- ------------------------------- -- - --------------- ---------------------- ----------- ------------ -------------- -- - ------------------------------ -------------- ---
总结
从本文中,我们学到了如何使用 npm
包 poeditor-tool
自动化获取、生成、上传目标语言文件到 poeditor 网站。如果你正在使用 poeditor
和 i18next
,那这个工具肯定会对你很有帮助。这篇文章重点讲述了如何安装和配置,然后利用该工具来上传和下载翻译文件,最后提供部分示例代码。希望你可以从这篇文章中学到新的知识和技巧,并进一步提高自己的前端开发能力。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005671c81e8991b448e3790