npm 包 poeditor-tool 使用教程

市面上有很多 i18n（国际化）方案，其中还是以 i18next 为主流。而 poeditor 的网站也是为了支持 i18n，可以在线编辑 po 文件，对于对开发提供了很大的便利。那么今天要分享的就是：npm 包 poeditor-tool 使用教程。

通过 poeditor-tool，我们可以用命令行的方式自动化获取、生成、上传目标语言文件到 poeditor 网站。如果你正在使用 poeditor 和 i18next，那这个工具肯定会对你很有帮助。

安装

使用 npm 安装即可：

--- ------- -- -------------
  • -g 是全局安装，这里仅仅是编辑器的调用，自己写代码的话就不需要全局安装。

上传配置

我们通过 poeditor 官方页面的教程可以非常快速的搭建并准备好 poeditor 的账号。步骤是这样的：

  • 注册并登录账号，创建一个新项目；
  • 在项目设置页面找到 API Access Token，或直接用项目ID和Token接口；
  • 填写 API Access Token 信息。

执行下述命令配置 API access token：

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

TOKEN 和 PROJECT_ID 从 poeditor 官网中可以获取。

下载翻译文件

执行 poeditor pull 命令即可下载翻译文件：

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

这里我们指定了下载英文、德文以及中文汉化后的版本。

上传翻译文件

执行 poeditor push 命令即可上传翻译文件：

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

通过 poeditor push 开始上传。我们指定了英文、德文以及中文，并且加上了一个 --update-source 选项，这意味着 poeditor 里面新增的翻译词条也需要更新到源文件里面。

以上就是该工具的基本使用方法。

示例代码

下面为读者提供部分代码示例。

我们先来看一下 config 文件：

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

下载翻译文件：

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

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

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

上传翻译文件：

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

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

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

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

总结

从本文中，我们学到了如何使用 npm 包 poeditor-tool 自动化获取、生成、上传目标语言文件到 poeditor 网站。如果你正在使用 poeditor 和 i18next，那这个工具肯定会对你很有帮助。这篇文章重点讲述了如何安装和配置，然后利用该工具来上传和下载翻译文件，最后提供部分示例代码。希望你可以从这篇文章中学到新的知识和技巧，并进一步提高自己的前端开发能力。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005671c81e8991b448e3790

阅读全文

猜你喜欢

  • npm 包 bootme 使用教程

    什么是 bootme？ Bootme 是一个基于 Node.js 的自动化构建工具，旨在提高前端开发的效率和项目管理的可维护性。它可以帮助你轻松地搭建并维护一个复杂的前端工程项目，包括代码的构建、静态...

    3 年前
  • npm 包 npm_playbook_s_d 使用教程

    npm 是 Node.js 的包管理器，其中有许多优秀的包可供前端开发使用。本文将介绍一款名为 npm_playbook_s_d 的包，它的功能是根据 JSON 文件生成表格，并支持排序、筛选等功能。

    3 年前
  • npm 包 bootme-docker 使用教程

    简介 bootme-docker 是一款基于 Docker 容器的本地开发工具，它可以帮助开发者快速构建、部署和运行一个本地的 containers 应用程序，让开发者专注于业务开发而不是环境配置和部...

    3 年前
  • npm 包 bootme-githook 使用教程

    介绍 bootme-githook 是一款便捷的 npm 包，它可以帮助你在 Git 提交代码时，自动执行指定的脚本，方便你在开发中进行各种自动化操作。它的安装和使用非常简单，本文将向你介绍 boot...

    3 年前
  • npm 包 bootme-request 使用教程

    在前端开发过程中，我们经常需要使用到网络请求来获取数据或者与服务器进行交互。而 bootme-request 这个 npm 包则是一个非常实用的工具，用于进行网络请求、封装 API 接口等操作。

    3 年前
  • npm 包 bootme-gitclone 使用教程

    随着前端项目的复杂性不断增加，我们经常需要使用其他人编写的库和框架。npm 是一个广泛使用的包管理器，它可以帮助我们轻松地安装和管理大量的 Javascript 包。

    3 年前
  • npm 包 bootme-shell 使用教程

    介绍 Bootme-shell 是一个用于编写 shell 命令的 npm 包。它简化了编写 shell 脚本的过程，提高了代码的可读性和可维护性。本文将介绍如何安装和使用 bootme-shell，...

    3 年前
  • npm 包 bootme-temp 使用教程

    在前端开发中，我们常常需要用到一些开源的库和工具来提高我们的开发效率。其中，npm 是一个十分重要的工具，它是 Node.js 中的包管理器，可以让我们方便地安装、升级、管理前端依赖。

    3 年前
  • npm包bootme-template使用教程

    介绍 在前端开发中，我们经常需要编写HTML、CSS以及JavaScript等相关的代码。虽然各种框架和工具已经可以快速地帮我们生成这些代码，但是在某些情况下，生成的代码模板不能满足我们的需求。

    3 年前
  • npm 包 zooid-app-version-notifier 使用教程

    前言 在前端开发中，我们经常需要更新应用程序的版本，以便修复错误、添加新功能或提高性能。当新版本发布时，需要通知用户进行更新，zooid-app-version-notifier 就是一个可以帮我们实...

    3 年前
  • npm 包 @survivejs/components 使用教程

    随着前端技术的发展，我们越来越依赖于各种开源的 npm 包来构建我们的应用程序。其中，@survivejs/components 是一个非常受欢迎的 npm 包，它提供了许多重要的组件来帮助开发人员更...

    3 年前
  • npm 包 react-content-portal 使用教程

    react-content-portal 是一个用于创建 HTML 元素（如提示框、弹窗等）的 React 组件，可以轻松地将这些元素添加到现有的 React 应用程序中，并支持多个嵌套层级的元素。

    3 年前
  • npm 包 cordova-plugin-get-app-info 使用教程

    前言 对于使用 Cordova 开发跨平台应用的开发者来说，获取应用程序信息是一个很重要的需求。 cordova-plugin-get-app-info 是一个可以查询应用程序信息的 Cordova ...

    3 年前
  • npm 包 purifycss-extended-webpack 使用教程

    在前端开发中，优化页面加载速度是非常重要的一项工作。其中之一就是减小 CSS 文件的大小。而 purifycss-extended-webpack 这个 npm 包就可以帮助我们去除未使用的 CSS ...

    3 年前
  • npm 包 @superhero/schedule 使用教程

    随着互联网的普及，前端开发越来越受到重视，而 npm 包也成为前端开发中不可或缺的一部分。本文将介绍一款 npm 包 @superhero/schedule 的使用教程，以及如何在前端开发中使用它来提...

    3 年前
  • npm 包 content-portal 使用教程

    内容提取和渲染在前端开发过程中是非常常见的需求。而 npm 上的 content-portal 包提供了一种简单易用的方案，它可以帮助开发者快速的进行内容提取和渲染操作，极大地提高了开发效率。

    3 年前
  • npm 包 data-ok 使用教程

    简介 data-ok 是一个在前端开发中常用的 npm 包，它可以方便地进行表单验证以及数据校验。本文将介绍 data-ok 的基本使用方法，以及一些高级用法。 安装 在使用 data-ok 之前，需...

    3 年前
  • npm 包 html-jest-reporter 使用教程

    前端开发中，单元测试是不可或缺的一部分。Jest 是一个基于 JavaScript 的测试框架，在 Jest 中我们可以使用多种 Reporter 来输出测试结果，其中 html-jest-repor...

    3 年前
  • NPM 包 justo.util 使用教程

    介绍 hjusto/util 是一个提供多种实用函数的 NPM 包。它主要用于 Node.js 的后端开发，但它也可以适用于前端开发。 该包提供一些功能用于 object、function 和 str...

    3 年前
  • npm 包 lodash-ts-webpack-plugin 使用教程

    介绍 Lodash-ts-webpack-plugin 是 Lodash 库在 TypeScript 项目中的优化插件。它能够根据项目实际需要来生成最小化的 Lodash 代码包，并自动移除未使用的 ...

    3 年前

相关推荐

    暂无文章