Standardise translation functions

gradle.properties

@@ -1,9 +1,7 @@
 #dokka will run out of memory with the default metaspace
 org.gradle.jvmargs=-XX:MaxMetaspaceSize=1024m
 org.gradle.parallel=true
-
 kotlin.incremental=true
 ksp.incremental=false
 ksp.useKSP2=true
-
-projectVersion=2.2.0-SNAPSHOT
+projectVersion=2.3.0-SNAPSHOT

kord-extensions/src/main/kotlin/dev/kordex/core/builders/about/Section.kt

@@ -30,7 +30,7 @@ public class Section(public val name: String, public val description: String) :
 	}
 
 	public fun translate(key: String, locale: Locale, replacements: Array<Any?> = arrayOf()): String =
-		translations.translate(key, translationBundle, locale, replacements = replacements)
+		translations.translate(key = key, bundleName = translationBundle, locale = locale, replacements = replacements)
 
 	public fun validate() {
 		if (!::builder.isInitialized) {

kord-extensions/src/main/kotlin/dev/kordex/core/checks/types/CheckContext.kt

@@ -171,7 +171,7 @@ public open class CheckContext<out T : Event>(
 
 		replacements: Array<Any?> = arrayOf(),
 	): String =
-		translations.translate(key, locale, bundleName = bundle, replacements = replacements)
+		translations.translate(key = key, bundleName = bundle, locale = locale, replacements = replacements)
 
 	/** Quick access to translate strings using this check context's [locale]. **/
 	public fun translate(
@@ -180,7 +180,7 @@ public open class CheckContext<out T : Event>(
 
 		replacements: Array<Any?> = arrayOf(),
 	): String =
-		translations.translate(key, locale, bundleName = defaultBundle, replacements = replacements)
+		translations.translate(key = key, bundleName = defaultBundle, locale = locale, replacements = replacements)
 
 	/** Quick access to translate strings using this check context's [locale]. **/
 	public fun translate(
@@ -189,7 +189,7 @@ public open class CheckContext<out T : Event>(
 
 		replacements: Map<String, Any?>,
 	): String =
-		translations.translate(key, locale, bundleName = defaultBundle, replacements = replacements)
+		translations.translate(key = key, bundleName = defaultBundle, locale = locale, replacements = replacements)
 
 	/** Quick access to translate strings using this check context's [locale]. **/
 	public fun translate(
@@ -200,7 +200,7 @@ public open class CheckContext<out T : Event>(
 		bundle: String?,
 		replacements: Map<String, Any?>,
 	): String =
-		translations.translate(key, locale, bundleName = bundle, replacements = replacements)
+		translations.translate(key = key, bundleName = bundle, locale = locale, replacements = replacements)
 
 	/**
 	 * If this check has failed and a message is set, throw a [DiscordRelayedException] with the translated message.

kord-extensions/src/main/kotlin/dev/kordex/core/commands/Argument.kt

@@ -29,4 +29,8 @@ public data class Argument<T : Any?>(
 }
 
 internal fun Argument<*>.getDefaultTranslatedDisplayName(provider: TranslationsProvider, command: Command): String =
-	provider.translate(displayName, provider.defaultLocale, command.resolvedBundle ?: converter.bundle)
+	provider.translate(
+		key = displayName,
+		bundleName = command.resolvedBundle ?: converter.bundle,
+		locale = provider.defaultLocale
+	)

kord-extensions/src/main/kotlin/dev/kordex/core/commands/CommandContext.kt

@@ -101,7 +101,12 @@ public abstract class CommandContext(
 	): String {
 		val locale = getLocale()
 
-		return translationsProvider.translate(key, locale, bundleName, replacements)
+		return translationsProvider.translate(
+			key = key,
+			bundleName = bundleName,
+			locale = locale,
+			replacements = replacements
+		)
 	}
 
 	public override suspend fun translate(
@@ -111,6 +116,11 @@ public abstract class CommandContext(
 	): String {
 		val locale = getLocale()
 
-		return translationsProvider.translate(key, locale, bundleName, replacements)
+		return translationsProvider.translate(
+			key = key,
+			bundleName = bundleName,
+			locale = locale,
+			replacements = replacements
+		)
 	}
 }

kord-extensions/src/main/kotlin/dev/kordex/core/commands/application/ApplicationCommand.kt

@@ -121,9 +121,9 @@ public abstract class ApplicationCommand<E : InteractionCreateEvent>(
 		lowerCase: Boolean = false,
 	): Localized<String> {
 		var default = translationsProvider.translate(
-			key,
-			this.resolvedBundle,
-			translationsProvider.defaultLocale
+			key = key,
+			bundleName = this.resolvedBundle,
+			locale = translationsProvider.defaultLocale
 		)
 
 		if (lowerCase) {
@@ -133,9 +133,9 @@ public abstract class ApplicationCommand<E : InteractionCreateEvent>(
 		val translations = bot.settings.i18nBuilder.applicationCommandLocales
 			.associateWith { locale ->
 				val result = translationsProvider.translate(
-					key,
-					this.resolvedBundle,
-					locale.asJavaLocale()
+					key = key,
+					bundleName = this.resolvedBundle,
+					locale = locale.asJavaLocale()
 				)
 
 				if (lowerCase) {

kord-extensions/src/main/kotlin/dev/kordex/core/commands/application/slash/SlashGroup.kt

@@ -67,9 +67,9 @@ public class SlashGroup(
 
 		if (!descriptionTranslationCache.containsKey(locale)) {
 			descriptionTranslationCache[locale] = translationsProvider.translate(
-				this.description,
-				this.parent.resolvedBundle,
-				locale
+				key = this.description,
+				bundleName = this.parent.resolvedBundle,
+				locale = locale
 			).lowercase()
 		}
 

kord-extensions/src/main/kotlin/dev/kordex/core/commands/chat/ChatCommand.kt

@@ -137,9 +137,9 @@ public open class ChatCommand<T : Arguments>(
 		if (!signatureCache.containsKey(locale)) {
 			if (signature != null) {
 				signatureCache[locale] = translationsProvider.translate(
-					signature!!,
-					resolvedBundle,
-					locale
+					key = signature!!,
+					bundleName = resolvedBundle,
+					locale = locale
 				)
 			} else {
 				signatureCache[locale] = registry.parser.signature(arguments!!, locale)
@@ -153,9 +153,9 @@ public open class ChatCommand<T : Arguments>(
 	public open fun getTranslatedName(locale: Locale): String {
 		if (!nameTranslationCache.containsKey(locale)) {
 			nameTranslationCache[locale] = translationsProvider.translate(
-				this.name,
-				this.resolvedBundle,
-				locale
+				key = this.name,
+				bundleName = this.resolvedBundle,
+				locale = locale
 			).lowercase()
 		}
 
@@ -166,15 +166,15 @@ public open class ChatCommand<T : Arguments>(
 	public open fun getTranslatedAliases(locale: Locale): Set<String> {
 		if (!aliasTranslationCache.containsKey(locale)) {
 			val translations = if (aliasKey != null) {
-				translationsProvider.translate(aliasKey!!, resolvedBundle, locale)
+				translationsProvider.translate(key = aliasKey!!, bundleName = resolvedBundle, locale = locale)
 					.lowercase()
 					.split(",")
 					.map { it.trim() }
 					.filter { it != EMPTY_VALUE_STRING }
 					.toSortedSet()
 			} else {
 				this.aliases.map {
-					translationsProvider.translate(it, resolvedBundle, locale).lowercase()
+					translationsProvider.translate(key = it, bundleName = resolvedBundle, locale = locale).lowercase()
 				}.toSortedSet()
 			}
 

kord-extensions/src/main/kotlin/dev/kordex/core/commands/chat/ChatCommandParser.kt

@@ -875,9 +875,9 @@ public open class ChatCommandParser : KordExKoinComponent {
 
 					append(
 						translationsProvider.translate(
-							it.converter.signatureTypeString,
-							it.converter.bundle,
-							locale
+							key = it.converter.signatureTypeString,
+							bundleName = it.converter.bundle,
+							locale = locale
 						)
 					)
 

kord-extensions/src/main/kotlin/dev/kordex/core/commands/chat/ChatSubCommand.kt

@@ -45,9 +45,9 @@ public open class ChatSubCommand<T : Arguments>(
 	override fun getTranslatedName(locale: Locale): String {
 		if (!nameTranslationCache.containsKey(locale)) {
 			nameTranslationCache[locale] = translationsProvider.translate(
-				this.name,
-				this.resolvedBundle,
-				locale
+				key = this.name,
+				bundleName = this.resolvedBundle,
+				locale = locale
 			).lowercase()
 		}
 

kord-extensions/src/main/kotlin/dev/kordex/core/commands/converters/impl/TagConverter.kt

@@ -159,14 +159,14 @@ public class TagConverter(
 			if (channel == null) {
 				throw DiscordRelayedException(
 					translationsProvider.translate(
-						if (getter == null) {
+						key = if (getter == null) {
 							"converters.tag.error.wrongChannelType"
 						} else {
 							"converters.tag.error.wrongChannelTypeWithGetter"
 						},
 
-						event.getLocale(),
-						DEFAULT_KORDEX_BUNDLE
+						bundleName = DEFAULT_KORDEX_BUNDLE,
+						locale = event.getLocale(),
 					)
 				)
 			}

kord-extensions/src/main/kotlin/dev/kordex/core/components/ComponentContext.kt

@@ -147,7 +147,12 @@ public abstract class ComponentContext<E : ComponentInteractionCreateEvent>(
 	): String {
 		val locale = getLocale()
 
-		return translationsProvider.translate(key, locale, bundleName, replacements)
+		return translationsProvider.translate(
+			key = key,
+			bundleName = bundleName,
+			locale = locale,
+			replacements = replacements
+		)
 	}
 
 	/**
@@ -161,7 +166,12 @@ public abstract class ComponentContext<E : ComponentInteractionCreateEvent>(
 	): String {
 		val locale = getLocale()
 
-		return translationsProvider.translate(key, locale, bundleName, replacements)
+		return translationsProvider.translate(
+			key = key,
+			bundleName = bundleName,
+			locale = locale,
+			replacements = replacements
+		)
 	}
 
 	/**

kord-extensions/src/main/kotlin/dev/kordex/core/components/forms/ModalForm.kt

@@ -145,7 +145,7 @@ public abstract class ModalForm : Form(), KordExKoinComponent {
 
 	/** Return a translated modal title using the given locale, and the given bundle if the modal doesn't have one. **/
 	public fun translateTitle(locale: Locale, otherBundle: String?): String =
-		translations.translate(title, locale, bundle ?: otherBundle)
+		translations.translate(key = title, bundleName = bundle ?: otherBundle, locale = locale)
 
 	/**
 	 * Convenience function to send this modal to the given [interaction] and await its completion, running the provided

kord-extensions/src/main/kotlin/dev/kordex/core/components/forms/widgets/TextInputWidget.kt

@@ -109,7 +109,7 @@ public abstract class TextInputWidget<T : TextInputWidget<T>> : Widget<String?>(
 	}
 
 	override suspend fun apply(builder: ActionRowBuilder, locale: Locale, bundle: String?) {
-		val translatedLabel = translations.translate(label, locale, bundle)
+		val translatedLabel = translations.translate(key = label, bundleName = bundle, locale = locale)
 
 		if (translatedLabel.length > LABEL_LENGTH) {
 			error(
@@ -123,12 +123,12 @@ public abstract class TextInputWidget<T : TextInputWidget<T>> : Widget<String?>(
 			this.required = this@TextInputWidget.required
 
 			this.placeholder = this@TextInputWidget.placeholder?.let {
-				translations.translate(it, locale, bundle)
+				translations.translate(key = it, bundleName = bundle, locale = locale)
 			}
 
 			this.value = this@TextInputWidget.initialValue?.let {
 				if (translateInitialValue) {
-					translations.translate(it, locale, bundle)
+					translations.translate(key = it, bundleName = bundle, locale = locale)
 				} else {
 					it
 				}

kord-extensions/src/main/kotlin/dev/kordex/core/events/EventContext.kt

@@ -56,7 +56,12 @@ public open class EventContext<T : Event>(
 	): String {
 		val locale: Locale = getLocale()
 
-		return translationsProvider.translate(key, locale, bundleName, replacements)
+		return translationsProvider.translate(
+			key = key,
+			bundleName = bundleName,
+			locale = locale,
+			replacements = replacements
+		)
 	}
 
 	/**
@@ -70,7 +75,12 @@ public open class EventContext<T : Event>(
 	): String {
 		val locale: Locale = getLocale()
 
-		return translationsProvider.translate(key, locale, bundleName, replacements)
+		return translationsProvider.translate(
+			key = key,
+			bundleName = bundleName,
+			locale = locale,
+			replacements = replacements
+		)
 	}
 
 	override suspend fun getLocale(): Locale {

kord-extensions/src/main/kotlin/dev/kordex/core/events/EventHandler.kt

@@ -251,7 +251,12 @@ public open class EventHandler<T : Event>(
 	): String {
 		val locale = getLocale()
 
-		return translationsProvider.translate(key, locale, bundleName, replacements)
+		return translationsProvider.translate(
+			key = key,
+			bundleName = bundleName,
+			locale = locale,
+			replacements = replacements
+		)
 	}
 
 	/**
@@ -265,7 +270,12 @@ public open class EventHandler<T : Event>(
 	): String {
 		val locale = getLocale()
 
-		return translationsProvider.translate(key, locale, bundleName, replacements)
+		return translationsProvider.translate(
+			key = key,
+			bundleName = bundleName,
+			locale = locale,
+			replacements = replacements
+		)
 	}
 
 	/**

kord-extensions/src/main/kotlin/dev/kordex/core/extensions/impl/HelpExtension.kt

@@ -281,10 +281,20 @@ public class HelpExtension : HelpProvider, Extension() {
 
 		val description = buildString {
 			if (longDescription) {
-				append(translationsProvider.translate(command.description, command.extension.bundle, locale))
+				append(
+					translationsProvider.translate(
+						key = command.description,
+						bundleName = command.extension.bundle,
+						locale = locale
+					)
+				)
 			} else {
 				append(
-					translationsProvider.translate(command.description, command.extension.bundle, locale)
+					translationsProvider.translate(
+						key = command.description,
+						bundleName = command.extension.bundle,
+						locale = locale
+					)
 						.trim()
 						.takeWhile { it != '\n' }
 				)
@@ -383,17 +393,23 @@ public class HelpExtension : HelpProvider, Extension() {
 
 									append(
 										translationsProvider.translate(
-											it.converter.signatureTypeString,
-											it.converter.bundle,
-											locale
+											key = it.converter.signatureTypeString,
+											bundleName = it.converter.bundle,
+											locale = locale
 										)
 									)
 
 									append(")")
 								}
 
 								append("`: ")
-								append(translationsProvider.translate(it.description, command.extension.bundle, locale))
+								append(
+									translationsProvider.translate(
+										key = it.description,
+										bundleName = command.extension.bundle,
+										locale = locale
+									)
+								)
 							}
 						}
 					)