Type-safe i18n: generates classes from YAML translations, catches missing keys at compile time, supports parameter interpolation, nested keys, locale enums and Ktor-based request locale resolution.
Type-safe internationalization (i18n) library and Gradle plugin for Kotlin Multiplatform projects.
{param} style arguments become function parameters// settings.gradle.kts
pluginManagement {
repositories {
mavenCentral()
gradlePluginPortal()
}
}
// build.gradle.kts
plugins {
id("io.github.erabti.patois") version "0.1.0"
}
dependencies {
implementation("io.github.erabti.patois:patois-core:0.1.0")
// Optional: Ktor server integration
implementation("io.github.erabti.patois:patois-extension-ktor:0.1.0")
}
Create YAML files in src/main/resources/translations/:
# en.yaml (or en.i18n.yaml)
greeting: Hello
welcome: "Welcome, {name}!"
errors:
notFound: Page not found
unauthorized: Access denied
# de.yaml
greeting: Hallo
welcome: "Willkommen, {name}!"
errors:
notFound: Seite nicht gefunden
unauthorized: Zugriff verweigert
// build.gradle.kts
patois {
className = "AppStrings" // Default: "AppStrings"
packageName = "com.example.i18n" // Default: auto-detected from source
baseLocale = "en" // Default: first file found
}
After running ./gradlew generateTranslations (or any compile task):
import com.example.i18n.AppStrings
import com.example.i18n.AppStringsEn
import com.example.i18n.AppStringsDe
import com.example.i18n.AppLocale
// Direct usage
val strings: AppStrings = AppStringsEn()
println(strings.greeting) // "Hello"
println(strings.welcome("World"))
println(strings.errors.notFound)
locale = AppLocale.EN
localizedStrings = locale.toStrings()
resolved = AppLocale.resolver()
For Ktor server applications, add the extension dependency and install the plugin:
import io.github.erabti.patois.ktor.installPatoisPlugin
import com.example.i18n.AppLocale
fun Application.module() {
// Install with default locale extraction (Accept-Language header)
installPatoisPlugin(AppLocale.resolver)
// Or with custom locale extraction
installPatoisPlugin(AppLocale.resolver) {
localeExtractor = PatoisLocaleExtractor { call ->
// Custom logic: check cookie, header, query param, etc.
call.request.cookies["locale"]
?: call.request.headers["Accept-Language"]
}
}
}
In route handlers, use the generated strings extension property:
import com.example.i18n.strings // Generated extension
routing {
get("/hello") {
// Automatically resolves locale from the request
call.respondText(strings.greeting)
}
get("/welcome/{name}") {
val name = call.parameters["name"] ?: "Guest"
call.respondText(strings.welcome(name))
}
}
For translation files en.yaml and de.yaml, the plugin generates:
| Module | Description |
|---|
Copyright 2024 Ahmed Erabti
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
| Option | Description | Default |
|---|
className | Generated interface/class name | "AppStrings" |
packageName | Package for generated code | Auto-detected from source |
inputDir | Directory with translation YAML files | "src/main/resources/translations" |
outputDir | Output directory for generated code | "build/generated/source/patois/main/kotlin" |
baseLocale | Locale that defines the interface contract | First file found |
argumentPattern | CURLY_BRACES ({arg}) or PRINTF_STYLE (%arg) | CURLY_BRACES |
enumName | Generated locale enum name | "AppLocale" |
resolverName | Generated resolver object name | "AppLocaleResolver" |
| Generated | Description |
|---|
AppStrings | Abstract class defining the translation interface |
AppStringsEn | Implementation for English locale |
AppStringsDe | Implementation for German locale |
AppLocale | Enum with EN, DE entries |
AppLocaleResolver | Object for resolving locale tags to enum values |
ApplicationCall.strings | Extension property (when using Ktor extension) |
RoutingContext.strings | Extension property (when using Ktor extension) |
| Platforms |
|---|
patois-core | Runtime types and locale resolution | JVM, iOS, JS |
patois-generator | Gradle plugin for code generation | JVM (Gradle) |
patois-extension-ktor | Ktor server integration | JVM |
Surfaced from shared tags and platforms — no rankings paid for.