liquidsoul / localizationconverter

A command-line tool to convert mobile localization files

LocalizationConverter

A simple command-line tool to convert Android strings.xml files into iOS Localizable.strings and Localizable.stringsdict files.

Installation

The tool can be installed using brew. All you have to do is run the following command:

brew install liquidsoul/formulae/l10nconverter

Usage

You need to pass the action to the tool to execute the conversion or get the usage help:

l10nconverter help

You can convert a android strings directory with this command:

l10nconverter convertAndroidFolder android/ --output=ios/

The tool expects the folder to have the following layout:

android
├── values
│   └── strings.xml
└── values-fr
    └── strings.xml

Which is the standard Android resources layout. See the Android String Resources documentation for more details.

It will output the following folder tree containing iOS localization files:

ios
├── Base.lproj
│   ├── Localizable.strings
│   └── Localizable.stringsdict
└── fr.lproj
    ├── Localizable.strings
    └── Localizable.stringsdict

The presence of stringsdict files will depend on the existance of plurals in your localization. None will be generated if you do not have plurals keys. You can look at the Apple documentation for more information on plurals on iOS.

⚠️ Limitations ⚠️

• Does not support String Array keys
• Support only one variable for plurals entries. An iOS stringsdict file can support multiple variables
• Require to use integer format specifier (%d) to format plurals

Development information

The Makefile is the central point to run the different commands for this project.
To setup the dependencies and run the tests:

make install
make test

Note that this assumes that brew is installed.

The project uses the Swift Package Manager so you can use it directly to build and run tests on the project.

To generate a release build:

make release

This will output a binary in the release/ folder of the project.

localizationconverter's Issues

Keep plurals keys in Localizable.strings

I tried to use swiftgen and it only parses the Localizable.strings file without considering the stringsdict file. However, the LocalizationConverter do not duplicate the plural keys in both file.
Maybe it should have an option to do that, like --keep-plural-keys?

attranslate - A rewrite of LocalizationConverter

Hi,

To prevent duplication, I would like to inform you that attranslate is a modern rewrite of LocalizationConverter: https://github.com/fkirc/attranslate
Of course, it is still fine to use LocalizationConverter, but the maintenance situation seems unclear.

Converter does not support double quotes (") in localized values

Converter does not escape " characters when formatting Localizable.strings files.
Note that there is no error but that the Localizable.strings files cannot be parsed by Xcode when used.
You can check this by running plutil on the file.

Example of incorrectly converted strings.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<resources>
    <string name="double_quoted_value">Click "This"</string>
</resources>

Add --version option

There must be a way to know which version of the tool is installed.
To do this, let's add a --version option which should print the actual version of the tool.
One issue is that there is no version information in the code base right now. The only version information is the release tag added to the git repository and referenced in the brew formula

Code coverage report

Code coverage is generated but it seems like it cannot be gathered by tools like codecov or even slather.
This may be because this project is a OS X Command Line Tool and that it required me to add all the source files to the Unit test target.
I looked at another swift command-line tool SwiftLint to see how they have set up the project and apparently, it's an OS X App from which they extract the executable to use it from the command line.
Maybe it the way to go, maybe not...

error: package at '/private/tmp/l10nconverter-20190425-27363-10vuqt4' is using Swift tools version 3.1.0 which is no longer supported; use 4.0.0 or newer instead

New issue checklist

• I have read all of the README.
• I have searched existing issues and this is not a duplicate.

General information

• Tool version(s):
• OS version(s):
• Related issues:

Expected behavior

...

Actual behavior

...

Steps to reproduce

...

Crash log? Screenshots? Videos? Sample project?

...

Converter fails to parse format tags in Android strings.xml file

Android strings resource can contain format tags <b>, <i> and <u>.
The current implementation fails when one of this tag is used.

Example of strings.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<resources>
    <string name="hello.world">Hello <b><u>world</u></b>!</string>
</string>
</resources>