npm 包 translations-from-spreadsheet 使用教程

阅读时长 5 分钟读完

什么是 translations-from-spreadsheet?

translations-from-spreadsheet 是一款基于 npm 包的前端工具,旨在帮助开发者从 Google Sheet 中导出文本翻译内容到 JavaScript 或 JSON 文件之中。如果你需要构建一个多语言的网站或应用,translations-from-spreadsheet 可以帮你大大提高翻译效率。

安装

使用 npm 命令进行全局安装:

若想使用本地版本进行安装,则需在项目根目录中使用以下命令:

使用方法

准备翻译表格

首先,在 Google Sheet 中创建翻译文本表格。根据需要,你可以将数据分为不同的工作表并命名,以便更好地进行管理和组织。

获取认证凭据

为确保可以访问 Google Sheet API,我们需要首先获取 API 的认证凭据。请查看 Google Cloud 文档 获取认证凭据。(建议根据平台需求选择认证类型)

获得凭据后,请将其保存到某个文件中。在存储凭据的文件中,需要使用如下 JSON 格式进行保存。

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

请注意,这里的 "private_key" 值应该是一个多行字符串,其中包含了你的私钥。如果你需要使用非常见字符,请使用 Base64 编码。

执行翻译命令

在终端命令行中,使用 translations-from-spreadsheet 命令执行导出操作。以下是使用示例:

各参数含义:

  • --spreadsheet-id: 翻译文本表格的 ID。你可以在 Google Sheet 地址中的 docs.google.com/spreadsheets/d/<spreadsheet_id> 查看,或在 Sheet 的 "文件 -> 共享" 中找到共享链接的后缀。

  • --auth-file: 之前保存的认证凭据所在的 JSON 文件路径。

  • --output-dir: 导出文件的输出路径。该路径必须是一个文件夹路径。

  • --format: 导出翻译内容的格式。可以使用以下两种格式之一:

    • js: 将翻译内容导出为 JavaScript 文件。每个工作表都会生成一个文件。
    • json: 将翻译内容导出为 JSON 文件。每个工作表会生成一个 JSON 文件。

我们可以以如下命令执行示例得到一个 testData 目录下的 json 文件

恭喜你,现在你已经成功使用了 translations-from-spreadsheet 包,并从 Google Sheet 中导出了文本翻译内容到本地 JSON 文件之中。

使用导出的翻译内容

在导出内容后,按需加载导出的内容即可

总结

使用 translations-from-spreadsheet 实现从 Google Sheet 的文本翻译内容导出至 JSON 或 JS 文件中的流程简单且易于操作,同时可以很好地支持多语言网站或应用的开发,提高开发效率。该工具可适用多种语言和领域,帮助开发者更快地实现多语言支持,提供良好的用户体验。当然,此工具减少了复制粘贴的过程,减少输入错误的机会,同时也建立了共享的翻译源管理方式,非常利于团队合作。

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

纠错
反馈