Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markparker5/xcodelocalize
Tool for automatic search and localization of .strings files
https://github.com/markparker5/xcodelocalize
internationalization ios ios-swift localisation localization swift translate xcode
Last synced: 4 days ago
JSON representation
Tool for automatic search and localization of .strings files
- Host: GitHub
- URL: https://github.com/markparker5/xcodelocalize
- Owner: MarkParker5
- License: mit
- Created: 2021-08-26T12:49:53.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T14:10:15.000Z (over 1 year ago)
- Last Synced: 2023-09-19T15:29:20.134Z (about 1 year ago)
- Topics: internationalization, ios, ios-swift, localisation, localization, swift, translate, xcode
- Language: Python
- Homepage: https://pypi.org/project/xcodelocalize/
- Size: 55.7 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# XCodeLocalize
## Requirments
Python3.9+
## Installation
### Using pip:
```
pip3 install xcodelocalize
```
Аlso available installations via poetry or .whl file from github releases
## Usage
### Prepare your xcode project
1. Create Localizable.strings file and fill it with strings you want to localize.
```
/* optional description */
"[key]" = "[string]";
/* Example: */
"welcome text" = "Welcome to XCodelocalize";
```
2. Go to the project settings, add the desired languages.
3. Create localization (.strings) files for all selected languages.
[There is a nice tutorial about ios app localization by kodeco (the new raywenderlich.com)](https://www.kodeco.com/250-internationalizing-your-ios-app-getting-started)
### Localize
`cd` to project root folder and run
```
xcodelocalize [OPTIONS]
```
or
```
python3 -m xcodelocalize [OPTIONS]
```
#### Options
* `--base-language`: code of the language from which all strings will be translated. _[default: 'en']_
* `--override / --no-override`: a boolean value that indicates whether strings that already exist in the file will be translated. Retranslate if `override`, skip if `no-override`. _[default: no-override]_
* `--format-base / --no-format-base`: sort base file strings by key. _[default: no-format-base]_
* `--file`: Names of the strings files to be translated. Multiple files can be specified. If not specified, all files will be translated. _[default: None]_
Example:
```
xcodelocalize --file InfoPlist
xcodelocalize --file InfoPlist --file MainStoryboard --file Localizable
```
* `--key`: Keys of the strings to be translated. Multiple keys can be specified. If not specified, all keys will be translated. _[default: None]_
* `--language`: Language codes of the strings files to be translated. Multiple language codes can be specified. If not specified, all files will be translated. _[default: None]_
* `--log-level`: One from [progress|errors|group|string]. _[default: group]_
* `--help`: Show info
## Features:
* The tool looks for .strings files in the current directory recursively, grouping and translating fully automatically. You can even run it in the root directory and localize all your projects at once.
* Regular .strings, Info.plist, storyboards and intentdefinition files are supported.
* Formated strings with %@ are supported.
* Multiline strings are supported.
* Comments are supported and will be copied to all files. Comments must **not contain substrings in localizable strings format with comment, such as `/*[comment]*/ "[key]" = "[value]";`**.
## Automation
You can go to `Target -> Build Phases -> New Run Script Phase` in your xcode project and paste `xcodelocalize` there. It will localize necessary strings during build and your localization files will always be up to date.
---
## Bonus
Nice swift extension that allows you to do this
```swift
"welcome text".localized // will return "Welcome to XCodelocalize"
```
```swift
extension String {
var localized: String {
NSLocalizedString(self, tableName: nil, bundle: .main, value: self, comment: "")
}
func localized(_ arguments: String...) -> String {
String(format: self.localized, locale: Locale.current, arguments: arguments)
}
}
```