npm 包 poeditor 使用教程

阅读时长 5 分钟读完

简介

poeditor 是一个在线多语言翻译管理平台,支持多种语言和多种文件格式。通过 poeditor,能够方便地管理和翻译项目中的多语言资源。本文将介绍如何使用 npm 包 poeditor 来管理项目中的多语言资源。

安装

在项目中安装 poeditor 包:

API 文档

poeditor API 可以参考 官方文档。其中,本文将用到的 API 为 uploadexport

使用

准备工作

在 poeditor 中创建一个项目,并上传需要翻译的文件。

上传文件

在代码中使用 poeditor 包上传需要翻译的文件,其中 apiTokenprojectId 可以在 poeditor 网页中找到。以下代码示例是上传一个名为 en.json 的文件:

-- -------------------- ---- -------
----- -------- - --------------------

-- -------- --- -----
----- -------- - -----------------

-- -------- ------- --
----- --------- - ------------------

-- -------
----- ------- - -
  --------- -----
  ---------- --
  -------- --------------------
  ----- -------- -------
--

-- ------ ----
------------------------- ---------- ------- ------------ --------
  ----------- -- -
    ----------------------
  --
  ------------ -- -
    ---------------------------
  ---

其中,options 对象中的属性解释如下:

  • language:翻译语言,默认为英文(en)。
  • overwrite:上传后是否覆盖 poeditor 中已有的翻译,1 表示覆盖,0 表示不覆盖,默认为 1。
  • syncing:上传后 poeditor 是否自动同步翻译中的条目和定义(terms 和 definitions),可选值为 termsdefinitionsterms_definitionsoff,默认为 terms_definitions
  • tags:上传文件时指定的标签,用于区分上传的文件。可以是一个字符串或者一个字符串数组,如果不指定则默认为 undefined

上传成功后,会返回上传结果的具体信息。其中,res.data 为一个对象,包含上传任务的 ID 和状态等信息:

-- -------------------- ---- -------
-
  ----------- -
    --------- ----------
    ------- ------
    ---------- ----
  --
  --------- -
    ------- -
      ---------- ---
    -
  -
-

导出翻译结果

在代码中使用 poeditor 包导出翻译结果,以下代码示例是导出刚刚上传的 en.json 文件的翻译结果:

-- -------------------- ---- -------
----- -------- - --------------------

-- -------- --- -----
----- -------- - -----------------

-- -------- ------- --
----- --------- - ------------------

-- -------
----- ------- - -
  --------- -----
  ----- -------
  -------- -
    ----- --------
  -
--

-- ------ ------------
------------------------- ---------- --------
  ----------- -- -
    --------------------------
  --
  ------------ -- -
    ---------------------------
  ---

其中,options 对象中的属性解释如下:

  • language:导出翻译的语言,默认为中文(zh)。
  • type:导出文件的格式,可以是 jsoncsvts 等格式,具体支持的格式可以参考官方文档,默认为 json
  • filters:导出的条件,可以是 tagstranslateduntranslatedfuzzy 等条件,可以是一个对象或者一个字符串,如果不指定则默认为 undefined

导出成功后,会返回导出结果的具体信息。其中,res.data.url 为一个字符串,表示导出文件的下载链接。

总结

通过本文的介绍,我们了解了如何使用 npm 包 poeditor 来管理项目中的多语言资源,包括上传文件和导出翻译结果。使用 poeditor,能够方便地管理和翻译项目中的多语言资源,加速国际化进程,提高开发效率和用户体验。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006733c890c4f7277583541

纠错
反馈