A flexible tool for application localization using Google Sheets.
A flexible tool for application localization using Google Sheets.
goloc can be built for each OS/architecture supported by golang, but release archives contain binaries only for amd64 architecture for macOS, Linux and Windows.
goloc.zip
file from the latest release and unpack it into your project's root folderclient_secret.json
file from Google API Console and put it inside a newly created goloc
folder. To do so, follow these steps:
ENABLE APIS AND SERVICES
buttonGoogle Sheets API
ENABLE
Dashboard->Credentials
Create credentials->Service account key
JSON
for key type, then press Create
client_secret.json
and put it into a goloc
folder of a projectclient_secret.json
fileclient_email
valueSHARE
buttonclient_email
value into the People
input field.Each localization document consists of formats and localizations sheets. One localization document can have multiple sheets for both.
The simplest way to create a new goloc-compatible localization document is to copy the sample spreadsheet. However, you can easily create a goloc-compatible localization document yourself just by following the simple requirements described below.
On the example above you can see a goloc-compatible localizations sheet. The rules to make a localizations sheet goloc-compatible are:
key
lang_<lanaguage code>
{format_name}
in place of the formatted value (each format must be specified in the formats sheet)On the example above you can see a goloc-compatible formats sheet. The rules to make a formats sheet goloc-compatible are:
format
{}
)goloc --help
. goloc is distributed in form of separate executables for each platform, so don't forget to take that into account creating localization script.No special configuration in code is required.
Example gradle task specification:
task "fetchLocalizations"(type: Exec) {
def osName = System.getProperty('os.name').toLowerCase()
def isWindows = osName.contains("win")
def isMac = osName.contains("mac")
def isUnix = osName.contains("nix") || osName.contains("nux") || osName.contains("aix")
def params = [
'--credentials', "goloc/client_secret.json",
'--platform', 'android',
'--spreadsheet', '1MbtglvGyEey3gH8yh4c9QovCIbtl5EcwqWqTZUiNga8',
'--tab', "localizations",
"--key-column", "key",
'--resources', "app/src/main/res/",
'--default-localization', 'en',
'--default-localization-file-path', "app/src/main/res/values/localized_strings.xml"
]
if (isWindows) {
params = ['cmd', '/c', 'goloc\\windows_amd64.exe'] + params
} else if (isMac) {
params = ['./goloc/darwin_amd64'] + params
} else if (isUnix) {
params = ['./goloc/linux_amd64'] + params
} else {
logger.error('Your OS is not supported.')
return
}
commandLine params
}
Localized strings can be accessed through AppLocalizations.of(context)
Requirements:
sprintf: ^4.0.2
to the dependencies
section of pubspec.yaml
AppLocalizationsDelegate()
to localizationsDelegates
of the app widget constructorsupportedLocales
of the app widget constructorDefaultIntlLocaleDelegate()
to localizationsDelegates
of the app widget constructor. This will make intl
-dependent formatters use currently selected locale.class DefaultIntlLocaleDelegate extends LocalizationsDelegate<Null> {
@override
bool isSupported(Locale locale) => true;
@override
Future<Null> load(Locale locale) {
Intl.defaultLocale = locale.toLanguageTag();
return Future.value(null);
}
@override
bool shouldReload(LocalizationsDelegate<AppLocalizations> old) => false;
}
Example bash localization script:
#!/bin/bash
case "$OSTYPE" in
darwin*) EXECUTABLE="darwin_amd64" ;;
linux*) EXECUTABLE="linux_amd64" ;;
msys*) EXECUTABLE="windows_amd64.exe" ;;
*)
echo "Platform is not supported: $OSTYPE"
exit 1
;;
esac
goloc/${EXECUTABLE} -c goloc/client_secret.json -p flutter -s 1MbtglvGyEey3gH8yh4c9QovCIbtl5EcwqWqTZUiNga8 -t localizations -r lib/intl
Due to the security improvements in the macOS Catalina, any 3rd party application downloaded from the internet has to be notarized to be launched without additional actions from the user side. Since goloc is entirely free, I can't afford Apple Developer Program subscription for notarizing macOS builds. Luckily, Apple has left a way to launch a non-notarized app, but it requires some actions.
Here's the instruction on how to launch goloc on macOS Catalina:
Security & Privacy
:
Open Anyway
:
Open
. Next time you launch goloc, macOS won't complain anymore.Released under the MIT License.