搜索插件、代码仓与 APP 分类

插件详情v2.2.0

flappy_translator

一个工具,可从 CSV 和 Excel 文件自动生成 Flutter 本地化资源。

AndroidiOSLinuxmacOSWindows
近 30 天下载
160
喜欢数
32
Pub 分数
140

安装插件

flutter pub add flappy_translator

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Flappy Translator 是一个 Flutter 包,可从 CSV 和 Excel 文件自动生成功能性本地化资源。它通过将结构化的翻译数据转换为 Flutter 的区域设置文件,简化了国际化流程,减少了手动操作并降低了出错风险。适用于管理多种语言的团队,支持动态更新,并可无缝集成到现有工作流中。该工具确保翻译的一致性,并在无需深入了解 Flutter 国际化系统的情况下加速应用本地化。

适合场景

  • 自动化本地化文件生成
  • 管理多语言应用内容
  • 简化翻译工作流程
  • 与 CI/CD 流水线集成
  • 无需代码更改即可更新翻译
  • 与非技术翻译人员协作

主要特点

  • 支持 CSV 和 Excel 输入格式
  • 自动生成 Flutter 本地化文件
  • 保持一致的键结构
  • 可轻松集成到Flutter项目中
  • 提供清晰的错误报告
  • 促进团队协作翻译

适合对象

  • 开发多语言应用程序的开发者
  • 使用电子表格的本地化团队
  • 频繁更新翻译的项目
  • 使用自动化构建流程的团队
  • 需要可扩展国际化功能的应用程序

使用建议

  • 需要格式正确的输入文件
  • 建议进行人工审核以确保准确性
  • 最好与版本控制的翻译文件一起使用
  • 仅限静态翻译数据
  • 不是实时翻译服务
  • 依赖正确的文件编码

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

flappy_translator

This package is discontinued and no longer maintained. No further updates, fixes or compatibility changes will be released.

Please migrate to arb_generator and Flutter's official localization tooling using flutter_localizations and intl.

Migration

ICU Placeholders

Migrate variables to ICU message syntax:

Before After
Welcome %name$s Welcome {name}
ARB Files Setup

arb_generator converts CSV translations into ARB files compatible with Flutter localization tooling.

Add the following package:

  • dart pub add --dev arb_generator

Define arb_generator package settings in pubspec.yaml:

arb_generator:
  input_filepath: "assets_dev/test.csv"
  output_directory: "lib/l10n"
  filename_prepend: "app_"

See arb_generator documentation for full example.

Flutter Localization Setup

Flutter's localization tooling generates compile-time localization delegates from ARB files.

Add the following packages:

  • flutter pub add flutter_localizations --sdk=flutter
  • flutter pub add intl:any

Enable delegate generation:

flutter:
  generate: true

in pubspec.yaml.

Add l10n.yaml file:

arb-dir: lib/l10n
template-arb-file: app_en.arb
output-dir: lib/l10n
output-localization-file: app_localizations.dart

See Flutter documentation for more information.

Generate Localization Delegates
dart run arb_generator
flutter gen-l10n
Update Delegate Usage

Use the generated AppLocalizations API instead of the old I18n API:

import '../l10n/app_localizations.dart';

Text(AppLocalizations.of(context)!.welcome('Dash')),

instead of

import 'i18n.dart';

Text(I18n.of(context).welcome(name: 'Dash')),
View Original README

A tool which automatically generates Flutter localization resources from CSV and Excel files.

This is especially useful as any team member can edit the CSV/Excel file, with the subsequent translations imported into the project via a terminal command. Basic variables (strings and integers) are supported, however neither genders nor plurals are planned to be supported. If you require such functionality, consider using arb_generator.

Getting Started

In order to use the flappy_translator package, please provide your translations in a CSV or Excel file. For CSV files, delimiters , and ; have been tested to work.

keys fr en en_GB de
plainText Bonjour le monde! Hello world! Hello world! Hallo Welt!
welcome Bienvenu %name$s! Welcome %name$s! Welcome %name$s! Willkommen %name$s!
favoriteColor Quelle est votre couleur préférée? What is your favorite color? What is your favourite colour? Was ist deine Lieblingsfarbe?

Localizations can be specified for a region by appending the country code.

Add dependency
dependencies:
  flutter_localizations:
    sdk: flutter
    
dev_dependencies: 
  flappy_translator: 
Define Settings

Settings for flappy_translator must set in your project's pubspec.yaml file. input_file_path is the only required parameter.

flappy_translator:
  input_file_path: "test.csv"
  output_dir: "lib"
  file_name: "i18n"
  class_name: "I18n"
  delimiter: ","
  start_index: 1
  depend_on_context: true
  use_single_quotes: false
  replace_no_break_spaces: false
  expose_get_string: false
  expose_loca_strings: false
  expose_locale_maps: false
  generate_comments: false
  comment_languages: []
Setting Default Description
input_file_path N/A Required. A path to the input CSV/Excel file.
output_dir lib A directory to generate the output file.
file_name i18n A filename for the generated file.
class_name I18n A class name for the generated file.
delimiter , CSV files only: a delimited to separate columns in the input CSV file.
start_index 1 The column index where translations begin (i.e. column index of default language).
depend_on_context true Whether the generated localizations should depend on BuildContext
use_single_quotes false Whether the generated file should use single or double quotes for strings.
replace_no_break_spaces false Whether no break spaces (\u00A0) should be replaced with normal spaces (\u0020).
expose_get_string false The default value for whether a getString method should be exposed.
expose_loca_strings false The default value for whether a locaStrings getter should be exposed.
expose_locale_maps false The default value for whether a localeMaps getter should be exposed.
generate_comments false Whether documentation comments should be used to display translations.
comment_languages [] Languages that are displayed in the comments. Empty -> All languages are used.
Run package

Make sure that your current working directory is the project root.

flutter pub get
dart run flappy_translator
Update iOS Info.plist

For iOS, ios/Runner/Info.plist needs to be updated with an array of the languages that the app will supports:

<key>CFBundleLocalizations</key>
<array>
  <string>fr</string>
  <string>en</string>
  <string>de</string>
</array>

For more information, see Internationalizing Flutter apps.

Use the i18n generated file

The package used your input file in order to generate a file named file_name in output_dir you provided. The following example uses the default class_name I18n with a dependency on BuildContext.

Firstly, add the I18nDelegate to your delegates:

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      localizationsDelegates: const [
        I18nDelegate(),
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
      ],
      supportedLocales: I18nDelegate.supportedLocals,
      home: const Home(),
    );
  }
}

Then use the generated I18n class!

class Home extends StatelessWidget {
  const Home({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('flappy_translator'),
      ),
      body: Center(
        child: Column(
          mainAxisSize: MainAxisSize.min,
          children: <Widget>[
            Text(I18n.of(context).plainText),
            Text(I18n.of(context).welcome(name: 'Dash')),
            Text(I18n.of(context).favoriteColor),
          ],
        ),
      ),
    );
  }
}

Please see example for more information.

Material Localizations

Supporting a language (i.e. ga or cy) not included in GlobalMaterialLocalizations requires adding a material localization class and delegate. Although this is out of the scope of this package, a warning is logged to the console during code generation. More info.

Rules and functionalities

Locale

Locales are specified in the top row and are expected to be given in the form en or en_US.

Default language

The column at start_index is considered the default language. This means that:

  1. If this column does not have a value, the loca key instead will be used.
  2. If another language does not have translations for a given key, the value of the default language will be used.
Keys

Each loca key must begin with a lowercase letter, after which any combinations of lowercase, uppercase, digits or underscores are valid.

Variables

In order to include variables in loca strings, they need to be written in the format %<VAR NAME>$<VAR TYPE>. Presently only integers and strings are supported as variable types.

  • %myVariable$d (d stands for an int)
  • %myVariable$s (s stands for a String)

All variables are required. Consider the key welcome from example. The generated function signature is

String welcome({
  required String name,
})

Note that if the variable's name starts with a number, the generated variable name will be var<VAR NAME>. So, for instance, %1$d would become var1.

所属分类

依赖

依赖清单 3 项

源码仓库

使用此插件的项目

暂无相关数据。