パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v2.2.0

flappy_translator

CSV および Excel ファイルから Flutter のローカリゼーションリソースを自動生成するツール。

AndroidiOSLinuxmacOSWindows
30日間ダウンロード
160
いいね数
32
Pub ポイント
140

パッケージをインストール

flutter pub add flappy_translator

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

Flappy Translator は、CSV および Excel ファイルからローカリゼーションリソースを自動生成するための Flutter パッケージです。構造化された翻訳データを 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 件

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。