https://github.com/icapps/translations
A gem to import the translations from the icapps translations portal.
https://github.com/icapps/translations
Last synced: about 1 month ago
JSON representation
A gem to import the translations from the icapps translations portal.
- Host: GitHub
- URL: https://github.com/icapps/translations
- Owner: icapps
- License: mit
- Created: 2015-10-07T08:35:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-07-29T15:44:46.000Z (almost 8 years ago)
- Last Synced: 2026-02-24T23:42:14.005Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 34.2 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# icapps Translations
Import the translations from the icapps translations portal.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'icapps-translations'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install icapps-translations
## Usage
- `translations init`: Run from your project root in order to setup the translations configuration.
- `translations import`: Run from your project root in order to import the translations into the matching _.strings_ files.
_You can pass the `--verbose` parameter to both commands in order to get more detailed information on what is happening._
### Xcode
The 'translations' gem currently supports the following folder structure for **iOS**:
`*/en.lproj/Localizable.strings`
In this case the language's short name is 'en' and the filename in the configuration is set to 'Localizable.strings'. The en.lproj folder can be nested inside other folders.
### Android
We currently check if the folder has an android project by looking for `.gradle` files. So this is currently the only supported way for Android.
The 'translations' gem currently supports the following folder structure for **Android**:
`app/src/main/res/values-en/strings.xml`
In this case the language's short name is 'en' and the filename in the configuration is set to 'strings.xml'. It's important that this structure is available as defined above. This is currently not configurable.
When you have a `default_language` set to 'en' in your configuration file the `values-en` will be `values` instead.
### React Native
We currently check if the folder has an react project by looking for `package.json` files.
The 'translations' gem currently supports the following folder structure for **React**:
`labels/en.json`
In this case the language's short name is 'en' and the filename in the configuration is set to 'en.json'. It's important that this structure is available as defined above. This is currently not configurable.
## Build gem
Start by updating the version number in the `lib/icapps/translations/version.rb` file.
Then build the gem by running the following commands:
rake build
rake release
## Contributing
1. Fork it ( https://github.com/icapps/translations/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Run `rubycop` in order to be compliant to our coding style.
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request