Flutter Translation Sheet Generator [fts]
Command line application to make your l10n super fast. Compose your strings in yaml/json format and use GoogleSheet for auto translate.
🧰
Install:
You need to have
flutterordartSDK in your System PATH.
flutter pub global activate flutter_translation_sheet
Now just run fts in any folder to create a template configuration file.
Check --help on any sub-command of fts:
fts runfts fetchfts extractfts upgradefts --version
⚙️
Usage:
Go with your terminal in any folder (or Flutter project folder), and run fts run.
First time will create a template for you, and you will have to get your Google credentials json.
Once you get the json, go to tfconfig.yaml and in the gsheet: there are two ways to fill the credentials (you only need to use one):
- Add
credentials_path:followed by the path of your json. You can copy the json file to the root folder of your project. The path can be absolute or relative.
Example:
gsheets:
credentials_path: c:/my_project/credentials.json or ./credentials.json
⚠️
NOTE TO WINDOWS USERS: paths should be either in the form "C:\\Users\\etc", with two backslash characters, or using forwardslash characters instead such as "C:/Users/etc".
- Add
credentials:followed by the whole credentials json content
Example:
gsheets:
credentials: {
"type": "service_account",
"project_id": "project-id",
"private_key_id": "",
"private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvAIBADANBgkqhkiG9w0BAQEFAASCB-----END PRIVATE KEY-----\n",
"client_email": "[email protected]",
"client_id": "123456",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/gsheets%40evolution-cp-calculator.iam.gserviceaccount.com"
}
You can find more information in the comments in tfconfig.yaml and fill the gsheet: section, and change the output folder as needed.
Once you have your configuration file ready, run fts to generate your sample google sheets.
Take the sample data input as reference, and use it in your own project.
fts will try to keep the local input and the remote sheet in sync, and automatically generate the locales for you every time you run it.
You can leave a terminal open and use the run command while listening for file changes in your master strings folder, or your trconfig.yaml: fts run --watch. You can exit the watch with q and then press Enter.
Watch out how often you modify the files and save them. Remember that your Google service account has usage limits.
After a while of not using it, Google Sheet performance slow down on every request, so it might take a little longer to get the output generated. Once it warms up (run 1 time) the sync performance is pretty solid.
fts fetch
Unlike fts run, fetch doesn't sync, nor validates the data structure.
Uses the local strings as entry map, downloads the latest data from GoogleSheet and generates the files accordingly. Is a much faster process. Very useful when you made manual corrections in your sheets for the auto-translated locales.
Do not manually modify the master language column on your Google Sheet, change the data in the string source file and let fts do the upload.
If there are differences of master lang strings between local and remote, the entire row will be cleared and regenerated with auto translation using the latest strings, and manual changes will get lost.
Currently you have to be careful, and keep your manual translations backed up just in case you modify the master language string.
Variables:
To store "variables" or placeholders in your strings to be replaced later in your code, use the follow notation:
"Welcome back {{user}}, today is {{date}}."
It will store the values in the sheet as {{0}} {{1}} and so on, to avoid complications with GoogleTranslate (although in rare cases GTranslate will truncate the {{}} somehow, don't worry), and it will generate a vars.lock file in the directory where you point your "entry_file" in config.
So you can define your own pattern for the code/json generation:
## pattern to applies final variables in the generated json/dart Strings.
## Enclose * in the pattern you need.
## {*} = {{name}} becomes {name}
## %* = {{name}} becomes %name
## (*) = {{name}} becomes (name)
## - Special case when you need * as prefix or suffix, use *? as splitter
## ***?** = {{name}} becomes **name**
param_output_pattern: "{{*}}"
Do not confuse the data source placeholder format with
param_output_patternconfiguration. Data-source (your yaml strings) must have this form{{variable}}to be interpreted as variables. The generated output strings usesparam_output_patternconfiguration to render the variables as you please.
Utilities:
fts extract [--path] [--output]: This tiny utility command performs a shallow search (no syslinks) of your dart classes and uses a basic pattern matching to capture your code's Strings. Might come in handy when you wanna localize an app with hardcoded texts. It only process '.dart' files, and the String matching isn't very permissive (single words Strings are skipped). Pass the folder to analyse in--pathand the folder (or json file) path to save in--output. It will output a single json file cloning the structure of the source code folder tree for easy manual search. It's up to you to clean it up, adjust keys, split it up in other data source files, and USE it with "Flutter Translate Sheet". This command tool is in alpha state, but don't worry, as it doesn't touch any of analyzed files, so is safe.
It captures interpolated strings in your dart code, variables like $name, or ${obj.friends.length}, and use them as placeholders: $name becomes {{name}} and ${obj.friends.length} becomes {{length}}.
- New options added: [-s] captures all Strings (event without spaces), and [-e] allows you to define a comma separated list of file extensions to search for Strings, like
-e dart,java,kt,arb
Also... when you specify an --output that ends with .yaml, you will have a pretty cool template to plug into fts run :)
- If you run the cli on macos,
ftskeeps your iOS app bundle synced automatically with the locales! One thing less to worry about.
arb and Intl:
We have an experimental support for arb generation. In config.yaml just set (or create if it doesnt exists) this field. (This tag will soon be changed to something more "generic" as arb output).
intl:
enabled: true
Example of .arb readable metadata:
today: "Today is {{date}}, and is hot."
"@today":
description: Show today's message with temperature.
placeholders:
date:
type: DateTime
format: yMMMEd
For plurals, we have a custom way of writing the dictionary. Just use plural:variableName: so fts knows how to generate the String. Remember that other is mandatory (the default value) when you use plurals.
Raw way of adding the metadata:
### not required, but you will be a much cooler dev if you provide context :)
"@messageCount":
{
"description": "New messages count on the Home screen",
"placeholders": { "count": {} },
}
messageCount:
plural:count:
=0: No new messages
=1: You have 1 new message
=2: You have a couple of messages
other: You have {{count}} new messages
Previous yaml will output in lib/l10n/app_en.arb (or the path you defined in arb-dir inside l10n.yaml) : "messageCount": "{count,plural, =0{No new messages}=1{You have 1 new message}=2{You have a couple of messages}other{You have {count} new messages}}",
Now you can also capture internal variables in the plural/selector modifiers, and add the type and parsing information into it!
messageCount:
plural:count:
=0: No new messages
=1: You have 1 new message. You won {{money:int:compactCurrency(decimalDigits:2,name:"Euro",symbol:"€")}}, congratulations!
=2: You have a couple of messages
other: You have {{count:int}} new messages
All {{variables}} supports this special way to define name, type, format, arguments. Useful when you don't want to use the @meta arb approach.
The "format" part applies to NumberFormatter and DateFormat constructors. {{variable:Type:Format(OptionalNamedArguments)}}
Selectors (like gender), are also included for the arb generation, although not yet supported on intl for code generation:
roleWelcome:
selector:role:
admin: Hi admin!
manager: Hi manager!
other: Hi visitor.
output arb:
"mainRoleWelcome": "{role, select, admin {Hi admin!} manager {Hi manager!} other {Hi visitor.} }",
"@mainRoleWelcome": {
"description": "Auto-generated for mainRoleWelcome",
"placeholders": {
"role": {
"type": "String"
}
}
}
📝
Utilities:
You can use SimpleLangPicker() widget when you generate the dart code (included by default in `TData class]). Is meant to be a quick tester to change languages. For example, if you use GetX for translations:
return Scaffold(
appBar: AppBar(
title: Text(widget.title),
actions: [
SimpleLangPicker(
onSelected: Get.updateLocale,
selected: Get.locale,
),
],
),
...
We will try to provide a richer experience integrating more libraries outputs in the future.
📝
Considerations:
-
Is preferable to keep the trconfig.yaml in the root of your project, some commands assumes that location (like arb generation).
-
When using arb output, make sure you have l10n.yaml next to the trconfig.yaml at the root of your project.
-
In your spreadsheet, the first column will always be your "keys", don't change that, don't move the column.
-
In your trconfig.yaml, the first locale you define is your master language:
locales:
- es ## master language used in `entry_file`
- en ## language list to translate.
- ko
-
The tool only analyzes the locales in your config... will not keep updated any other sheet column with other locales.
-
You can move the columns, or add new columns, around as long as the
keysis always the first (A1). -
The 1st ROW in your sheet are the "headers", don't change the autogenerated names.
-
If fts finds the 2nd ROW empty in any column, it will take the data corrupted, and will re-upload for translation.
-
If the row count from keys is different from the master language, it will invalidate the entire sheet.
Thanks for passing by!
Contributors
✨
Thanks goes to these wonderful people (emoji key):
 IsmailAlamKhan |
 Nicolas Lopez |
 Leo |
This project follows the all-contributors specification. Contributions of any kind welcome!
4 Apr 10, 2022
2 Jan 20, 2022
8 Oct 14, 2022
2.1k Jan 1, 2023
4 Oct 16, 2022
844 Jan 1, 2023
3 Jun 24, 2022
165 Jan 4, 2023
21 Jun 14, 2022
3 Oct 21, 2022
34 Oct 30, 2022
15 Oct 11, 2021
11 Nov 5, 2022
318 Dec 27, 2022
52 Oct 17, 2022
4 Jul 11, 2022
44 Nov 13, 2022
6 Nov 28, 2022
1k Jan 6, 2023