npm 包 i18n-extractor 使用教程

简介

i18n-extractor 是一个用于提取 JavaScript 代码中的国际化文本的 npm 包。它可以自动扫描代码，并将代码中用到的文本提取出来生成一个翻译文件，方便后续的多语言翻译工作。

本文将详细介绍 i18n-extractor 的使用方法，并附带一个示例代码作为演示。

安装

首先，你需要在项目中安装 i18n-extractor：

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

配置文件

i18n-extractor 支持使用配置文件来配置其行为。配置文件的默认文件名为 .i18nrc，但你也可以通过命令行参数来指定其他的配置文件。

以下是一个示例配置文件 .i18nrc：

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

其中包含了以下配置项：

  • locales: 一个字符串数组，列出了所有可用的语言代码。这些语言代码将被用于生成对应的翻译文件。
  • output: 翻译文件的输出路径，可以使用 {locale} 占位符指定语言代码。
  • input: 待扫描的代码路径，支持 glob 格式。
  • marker: 标识用于打上待翻译文本的标记字符串，默认为 i18n。
  • functionNames: 一个对象，用于指定识别哪些函数作为文本提取器，以及这些函数在 JS 代码中的名称。对象的键名应该是函数类型（如 "translate"、"plural"、"select" 等），键值应该是一个字符串数组，列出了所有可能的 JS 函数名称。
  • jsxAttributeNames: 一个对象，用于指定识别哪些 JSX 属性作为文本提取器，以及这些属性在 JSX 代码中的名称。对象的键名应该是函数类型（如 "translate"、"plural"、"select" 等），键值应该是一个字符串数组，列出了所有可能的 JSX 属性名称。
  • extensions: 待扫描的文件扩展名，如 ".js"、".jsx"。

使用方法

在项目的根目录下运行以下命令来提取所有待翻译文本：

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

此时，i18n-extractor 将会扫描指定的代码路径，并提取出其中的待翻译文本，然后将其保存到输出路径中的翻译文件中。

生成的翻译文件格式如下：

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

而源代码中的待翻译文本，则通过 marker 标记被注释掉：

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

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

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

示例代码

以下是一个演示用的 React 代码，其中包含了多种可翻译的文本：

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

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

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

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

运行 i18n-extractor，它会将所有可翻译的文本提取出来，生成一个翻译文件，其中包含了如下内容：

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

随着项目中可翻译文本的不断增多，i18n-extractor 能够帮助我们快速、准确地提取这些文本并交由翻译人员进行翻译。同时，它的配置参数也让我们能够更加灵活地进行提取，以应对不同的代码场景。

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

阅读全文

猜你喜欢

  • GraphQL：用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言，它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据，避免了传统...

    1 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events？ Server-sent Events（简称 SSE）是一种基于 HTTP 的服务器推送技术，它可以让服务器向客户端发送事件流，客户端通过监听这个事件流来...

    1 个月前
  • ECMAScript 2020（ES11）中的新特性：BigInt 转换

    在 ECMAScript 2020（ES11）中，新增了一种数据类型：BigInt。它是一种可以表示任意大整数的数据类型，可以用来解决 JavaScript 中整数运算的精度问题。

    1 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式，消除不同浏览器之间的差异，从而实现更加一致的样式效果的技术手段。在前端开发中，使用 CSS Reset 可以让我们更...

    1 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中，引入了 class 关键字，使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间，有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系，并提供一...

    1 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时，表单数据的处理是非常常见的需求。然而，由于 React 的单向数据流和组件化特性，传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具，可以帮助...

    1 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展，高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库，也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略，并且会提...

    1 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中，图片适配是一个比较棘手的问题。如果不加以处理，可能会导致图片在不同设备上显示不佳，影响用户体验。本文将介绍响应式设计中的图片适配问题，并提供解决方案。

    1 个月前
  • 解析 TypeScript 中 encapsulation（封装）的实现方式

    解析 TypeScript 中 encapsulation（封装）的实现方式 在 TypeScript 中，封装（encapsulation）是一种重要的面向对象编程的特性。

    1 个月前
  • PM2 崩溃处理：如何避免由于 PM2 进程奔溃导致应用崩溃？

    在前端开发中，我们经常使用 PM2 进行进程管理和部署。但是，当 PM2 进程崩溃时，应用也会跟着崩溃。如何避免这种情况的发生？本文将介绍 PM2 崩溃处理的方法和技巧，帮助您更好地管理和部署应用。

    1 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境，它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时，安全性是非常重要的。

    1 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准，其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法，分别是：扩展运算符、剩余运算符...

    1 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时，我们经常需要使用 Enzyme 来测试组件。然而，当我们测试涉及到动画的组件时，我们可能会遇到一些问题：动画无法渲染，导致测试失败。

    1 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展，单页应用（Single Page Application，SPA）已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面，提供了更快速、更流畅的用户体...

    1 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中，ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    1 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中，Promise.all 是一个非常常用的功能，它可以让我们在多个异步操作完成后再执行一些操作，这个功能在实际开发中非常实用。

    1 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中，经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具，它提供了一种方便的方式来操作 MongoDB ...

    1 个月前
  • 在使用 lit-element 的时候，如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候，我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而，Shadow DOM 的封闭性也带来了一些挑战，其中之一就是变量传递问题。

    1 个月前
  • Tailwind CSS 如何实现动态换肤？

    随着互联网的发展，越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验，还可以让用户在不同的环境下选择适合自己的主题，增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    1 个月前
  • 如何在 Less 中使用字符串操作函数？

    在前端开发中，样式表是不可或缺的一部分。而 Less 是一种动态样式语言，它是 CSS 的一种扩展。在 Less 中，我们可以使用字符串操作函数来处理字符串，这些函数可以帮助我们更加方便地操作字符串，...

    1 个月前

相关推荐

    暂无文章