Flutter Google Sheets转换ARB插件gsheet_to_arb的使用

• 从Google表格导入Application Resource Bundle（ARB）
• 自动创建Dart intl 类
• 按类别（上下文）分组翻译
• 支持占位符和复数

使用方法

从Google表格导入翻译文件

1. 设置插件配置yaml文件（只需执行一次）。
2. 从Google表格导入ARB和源文件：

pub run gsheet_to_arb:import

或者对于Flutter项目：

flutter pub run gsheet_to_arb:import

设置

1. 基于模板创建翻译电子表格

• 复制模板到您的Google Drive账户 - 文件 -> 创建副本
• 保存电子表格的DOCUMENT_ID - https://docs.google.com/spreadsheets/d/DOCUMENT_ID/edit#gid=0
• 更多关于电子表格结构的详细信息，请参见电子表格格式部分。

2. 创建Google Sheets API凭据

通过客户端或服务器认证创建Google Sheets API凭据。

3. 配置您的Dart项目

1. 在pubspec.yaml中添加gsheet_to_arb开发依赖：

dev_dependencies:
  gsheet_to_arb: ^0.1.8

1. 更新依赖项：

   pub update

2. 创建插件配置：

pub run gsheet_to_arb:import --create-config

• 这将在pubspec.yaml文件中添加插件配置，并为Google Sheets凭据创建gsheet_to_arb.yaml认证文件。

1. 更新在pubspec.yaml中创建的插件配置，例如：

gsheet_to_arb: 
    arb_file_prefix: 'intl' # 生成的ARB文件的后缀，例如intl_en.arb
    localization_file_name: 'l10n' # 生成的Dart文件名，例如L10n.dart
    output_directory: 'lib/l10n' # 所有Dart和ARB数据存储的位置
    add_context_prefix: false # 是否为键添加类别前缀，例如common_app_title
    gsheet: 
        auth_file: './gsheet_to_arb.yaml' # 包含Google Sheets认证配置的文件
        category_prefix: "# " 
        document_id: 'TODO'
        sheet_id: '0'
        columns: # 可选设置，未使用时将回退到默认值
            key: 0 # 翻译键所在的列，默认为0
            description: 1 # 描述所在的列，默认为1
            first_language_key: 2 # 第一个语言列，假设所有后续列也包含语言翻译，默认为2
        rows: # 可选设置，未使用时将回退到默认值
            header_row: 0 # 包含每列标题的行，默认为0
            first_translation_row: 1 # 包含翻译的第一行，默认为1

1. 更新在gsheet_to_arb.yaml中创建的Google Sheets认证配置。
   • 添加客户端凭据：

oauth_client_id: 
    client_id: "TODO"
    client_secret: "TODO"

• 或者添加服务账户凭据：

service_account_key: 
    client_id: "TODO"
    client_email: "TODO"
    private_key: "TODO"

电子表格格式

行

• 第一行保留用于标题部分，包含相关列的标签。
• 其他行：
  • 如果行以category_prefix值（默认为#）开头，则所有后续行将使用该类别作为上下文（参见：ARB上下文和add_context_prefix参数）。
  • 空行被忽略。
  • 键列为空的行被忽略。

列

• 第一列key包含键名称或类别前缀。
• 第二列description包含项目描述。
• 所有后续列（语言代码，例如en、pl等）包含翻译文件。
• 将从第一个语言列开始解析，直到最后一个列或第一个空列，以先出现者为准。

值

占位符

• 简单地在翻译中添加{placeholder_name}。

复数

• 复数由键元数据识别 - 如果键以以下之一结尾：
  • zero, one, two, few, many, other - 则被视为复数。
• 复数使用特殊占位符{count}来标记用作翻译参数的值。

示例代码

以下是完整的示例代码，展示如何使用生成的Dart类：

import 'package:intl/intl.dart';

import 'l10n/_messages_all.dart';
import 'l10n/l10n.dart';

void main() async {
  print('MAIN');

  // 设置默认区域为波兰语
  Intl.defaultLocale = 'pl';
  await initializeMessages(Intl.defaultLocale);

  // 初始化本地化类
  final l10n = L10n();

  // 打印翻译结果
  print(l10n.title); // 输出标题
  print(l10n.login); // 输出登录文本
  print(l10n.singleArgument('arg')); // 输出单个参数的翻译
  print(l10n.twoArguments('arg1', 'arg2')); // 输出两个参数的翻译

  // 测试复数
  print(l10n.numberOfSongsAvailable(0)); // 输出歌曲数量为0的翻译
  print(l10n.numberOfSongsAvailable(1)); // 输出歌曲数量为1的翻译
  print(l10n.numberOfSongsAvailable(2)); // 输出歌曲数量为2的翻译
  print(l10n.numberOfSongsAvailable(5)); // 输出歌曲数量为5的翻译
  print(l10n.numberOfSongsAvailable(10)); // 输出歌曲数量为10的翻译
}