https://github.com/kropp/kotlinx-gettext
Gettext compatible library and Gradle plugin
https://github.com/kropp/kotlinx-gettext
Last synced: about 1 year ago
JSON representation
Gettext compatible library and Gradle plugin
- Host: GitHub
- URL: https://github.com/kropp/kotlinx-gettext
- Owner: kropp
- License: apache-2.0
- Created: 2022-04-20T08:52:20.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-27T18:26:06.000Z (over 1 year ago)
- Last Synced: 2025-04-30T23:47:43.938Z (about 1 year ago)
- Language: Kotlin
- Size: 320 KB
- Stars: 45
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Gettext is a widely used internationalization (i18n) format supported by many tools.
This project provides pure Kotlin implementation of Gettext.
The project consists of several parts:
1. `kotlinx-gettext` library to use in your project to translate strings.
2. `kotlinx-gettext-plugin` Kotlin compiler plugin to extract strings for translation from Kotlin code.
3. `kotlinx-gettext-gradle-plugin` to conveniently apply Kotlin compiler plugin in your Gradle build.
## Usage
### Library
Add the `"name.kropp.kotlinx-gettext:kotlinx-gettext:0.7.0"` to the dependencies of your project.
The library is available on [Maven Central](https://search.maven.org/artifact/name.kropp.kotlinx-gettext/kotlinx-gettext).
Load translated strings and apply translations using an instance of `I18n` class.
```kotlin
val i18n = Gettext.load(Locale.GERMAN, Thread.currentThread().contextClassLoader.getResourceAsStream("de.po")!!)
println(i18n.tr("Hello world!"))
```
See `sample` module for a full example. Refer to [GNU gettext documentation](https://www.gnu.org/software/gettext/)
for more details.
### Translation
Apply Gradle plugin to extract strings and setup `gettext` task:
```kotlin
plugins {
id("name.kropp.kotlinx-gettext") version "0.7.0"
}
gettext {
potFile.set(File(projectDir, "src/messages.pot"))
keywords.set(listOf("tr","trn:1,2"))
}
```
Then invoke `./gradlew gettext` to extract strings for translations into `src/messages.pot`
Translate messages with any software or service supporting Gettext format. The result will be a number of .po files,
which you should put into resources.
## Known issues
* The library only supports Kotlin/JVM and Kotlin/JS as of now, Multiplatform Native port is in progress.
* .mo files are not (yet) supported.