Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dcordero/Rubustrings

Check Localizable.strings files of iOS Apps
https://github.com/dcordero/Rubustrings

Last synced: about 1 month ago
JSON representation

Check Localizable.strings files of iOS Apps

Host: GitHub
URL: https://github.com/dcordero/Rubustrings
Owner: dcordero
Created: 2014-09-28T22:09:40.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2019-01-16T08:21:34.000Z (almost 6 years ago)
Last Synced: 2024-12-02T18:59:49.705Z (about 1 month ago)
Language: Ruby
Homepage:
Size: 170 KB
Stars: 119
Watchers: 5
Forks: 14
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

awesome-ios - Rubustrings - Check the format and consistency of Localizable.strings files. (Localization / Other Hardware)
awesome-ios-star - Rubustrings - Check the format and consistency of Localizable.strings files. (Localization / Other Hardware)

README

# Rubustrings [![Build Status](https://travis-ci.org/dcordero/Rubustrings.svg?branch=master)](https://travis-ci.org/dcordero/Rubustrings)

Check the format and consistency of the Localizable.strings files of iOS Apps with multi-language support

[Rubustrings](https://github.com/dcordero/RubustringsXml) is also available for Android [here](https://github.com/dcordero/RubustringsXml)

## Usage

It only needs the files to validate as arguments

```
rubustrings Localizable.strings
```

Additionally to the filenames, including the option --onlyformat will only assert for the format.

## Install

```
gem install rubustrings
```

## Validators

Currently Rubustrings validates:

* **The syntaxis of the strings file**: Just the format of each line: "key" = "value";
* **Dynamic values (%@, %d, %ld,...)**: It checks that the translation include the same set of them than the original string.
* **Special characters at the beginning or at the end**: If the original string begins or ends with a white space,\n or \r it tests that the translation also does.

It also warning on:
* **Untranslated strings**: In missing translations
* **Translation significantly large**: In translations 3 times larger than original string

## Example

```
dcordero@silver:~$ rubustrings Localizable.strings
Processing file: "Localizable.strings"

Localizable.strings:217: error: beginning mismatch: "Tubasa" = " Tubasa";
Localizable.strings:220: error: number of variables mismatch: "Web %@" = "Web";
Localizable.strings:225: error: invalid format: "bad format" = "because of a missing quote;

Result: ✘ Some errors detected
```

```
dcordero@silver:~$ rubustrings Localizable.strings
Processing file: "Localizable.strings"

Result: ✓ Strings file validated succesfully
```
## XCode

Rubustrings can also be used as a custom build rule so that all .strings files
are automatically validated at build time. This will also attempt to highlight
offending lines in XCode.

![Xcode build rule example](./xcode_example.png "example")

Just add a new "Run Script Phase" with:

```
if which rubustrings>/dev/null; then
find "${SRCROOT}" -type f -name Localizable.strings -print0 | xargs -0 -n1 rubustrings
else
echo "warning: Rubustrings not installed, download from https://github.com/dcordero/Rubustrings"
fi
```

![Xcode setting example](./xcode_setting.png "configuration")

## License