npm 包 @lingui/cli 使用教程

阅读时长 3 分钟读完

在前端开发中,语言国际化是一个非常重要的概念,特别是在开发多语言网站的时候。而在实现语言国际化时,npm 上有许多非常方便实用的包,而 @lingui/cli 就是其中一款非常优秀的 npm 包。

@lingui/cli 简介

@lingui/cli 是一个帮助开发者实现语言国际化的命令行工具,能够 Parse、Extract 和 Compile 项目中的多语言文本,使得开发者可以更加快捷地实现多语言网站的开发。

@lingui/cli 的主要功能包括:

  1. 提供一个命令行工具,用于从代码中提取多语言文本
  2. 生成可供翻译的文件,包括 CSV 和 PO 文件
  3. 编译 PO 文件,生成多语言 JSON 文件或 JavaScript 模块
  4. 提供基本的脚手架用于项目初始化

安装 @lingui/cli

安装 @lingui/cli 的方式非常简单,只需要运行以下命令即可:

@lingui/cli 示例代码

1. 从代码中提取多语言文本

首先,需要在项目的根目录下创建 lingui.config.js 文件,用于配置 @lingui/cli 的相关参数。示例配置如下:

其中,localeDir 表示多语言文件输出目录,srcPathDirs 表示需要扫描的文件目录。

接下来,通过 lingui extract 命令从代码中提取多语言文本:

然后,就可以在 locale/ 目录下看到生成的 messages.pot 文件,里面包含了需要翻译的多语言文本。

2. 生成可供翻译的文件

接下来我们需要将 messages.pot 文件转化成可翻译的 CSV 或 PO 文件,以便交给翻译人员进行翻译。可以通过以下命令生成 CSV 文件:

或者生成 PO 文件:

生成的 CSV 或 PO 文件将会保存在 locale/ 目录下。

3. 编译多语言文件

翻译完成后,需要将翻译好的多语言文本编译成可供程序调用的 JSON 文件或 JavaScript 模块。可以通过以下命令生成 JSON 文件:

或者生成 JavaScript 模块:

编译的多语言文件将会保存在 locale/ 目录下。

结语

@lingui/cli 是一个非常优秀的 npm 包,能够帮助开发者更加方便地实现语言国际化。如果您正在实现多语言网站开发,那么 @lingui/cli 值得一试。

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