KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #ai-agents #dsh-plugin #codex #developer-tools #claude-code #windows #desktop-app #typescript #rust #ai-agent #cli

kotlinx-gettext

★ 57 Open GitHub ↗

Gettext compatible library and Gradle plugin

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Kotlinx Gettext](https://raw.githubusercontent.com/kropp/kotlinx-gettext/main/kotlinx-gettext.png)

![maven](https://img.shields.io/maven-central/v/name.kropp.kotlinx-gettext/kotlinx-gettext)
![license](https://img.shields.io/github/license/kropp/kotlinx-gettext)

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.

kotlinx-gettext

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README