使用 i18n-ally 实现多语言国际化 (i18n) 的简易指南

3,591 阅读2分钟

引言

i18n-ally 是一款 VS Code 插件,为开发者提供了一套强大而简便的工具,以轻松实现国际化(i18n)。本文将介绍如何使用 i18n-ally 插件,实现应用程序的多语言支持。

插件功能

  1. 提取文本: 在代码中使用 i18n-ally 提供的命令或快捷键,将待翻译的文本提取到语言文件中。
  2. 编辑语言文件: 使用 i18n-ally 提供的可视化编辑工具,直观地编辑每种语言的翻译文本。
  3. 实时预览: i18n-ally 提供了实时预览功能,让你可以在代码中直接看到应用翻译后的效果。
  4. 生成翻译文件: 通过 i18n-ally,你可以轻松生成翻译文件,用于发布应用程序。

安装 i18n-ally 插件

首先,在 Visual Studio Code 中搜索并安装 i18n-ally 插件。在 Extensions 视图中,搜索 "i18n-ally" 并点击安装。

配置项目

  1. 创建语言文件: 在项目根目录下创建一个名为 locales 的文件夹。在该文件夹下,为每种语言创建一个 JSON 文件,例如 en.json(英语)、es.json(西班牙语)等。

  2. 配置 i18n-ally: 找到项目根目录下的.vscode文件夹,并按照以下示例配置文件:

    {
      "i18n-ally.localesPaths": ["src/locale"],
      "i18n-ally.displayLanguage": "zh-CN",
    }
    

    或者在vscode中按F1,搜索i18n,手动设置语言目录,可自动写入到.vscode/settings.json

    更多配置参考

  3. 翻译文件风格

        {
          "i18n-ally.keystyle": "nested", //{"a": {"b": {"c": "..."}}}
          "i18n-ally.keystyle": "flat",   //{"a.b.c": "..."}
        }
    

自定义翻译文件路径

例一

        //.vscode/settings.json
        {
            "i18n-ally.namespace": true,
            "i18n-ally.pathMatcher": "{locale}.json"  //locale对应国际化语言
        }
        //则对应的翻译文件目录为
        locale
          - en.json
          - zh-CN.json

例二

        //.vscode/settings.json
        {
            "i18n-ally.namespace": true,
            "i18n-ally.pathMatcher": "{locale}/*.json"  //locale对应国际化语言
        }
        
        //则对应的翻译文件目录为
        locale
          - en
           - button.json
           - login.json
          - zh-CN
           - button.json
           - login.json

更多配置参考

其他

查看效果

在vscode左侧菜单可查看到翻译情况

image.png

代码实时翻译

image.png

注意: 翻译需要申请google key或者deepl key才能使用,插件默认使用的是谷歌翻译,国内卡注册不了deepl key。

结语

通过 i18n-ally 插件,我们可以更轻松地实现多语言国际化,提高应用程序的可用性和用户体验。该插件提供了直观的可视化界面,使得管理和编辑翻译文本变得非常简单。希望这篇简易指南能够帮助你更好地使用 i18n-ally 插件,为你的应用程序增添多语言支持。

相关资料

vsCode插件: marketplace.visualstudio.com/items?itemN…

i18n-ally: i18n-ally

vue-i18n:vue-i18n