i18n-plugin/io.github.octaviusframework.i18n/GenerateI18nTask

GenerateI18nTask

@CacheableTask

abstract class GenerateI18nTask : DefaultTask

Gradle task that generates type-safe Kotlin classes from JSON translation files.

Generated files:

{ObjectName}Translations{Lang}.kt - flat maps with translations per language
{ObjectName}.kt - registry pattern + type-safe accessors

Example usage of generated code:

Tr.Action.save()              // instead of T.get("action.save")
Tr.Form.Actions.itemLabel(1)  // instead of T.get("form.actions.itemLabel", 1)
Tr.Games.Form.category(5)     // instead of T.getPlural("games.form.category", 5)

// Runtime language switching
Tr.currentLanguage = "en"

Constructors

GenerateI18nTask

constructor()

Properties

actions

open var actions: List<Action<in Task?>?>?

ant

open val ant: AntBuilder?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

dependsOn

open val dependsOn: Set<Any?>?

description

open var description: @Nullable String?

destroyables

open val destroyables: TaskDestroyables?

didWork

open var didWork: Boolean

enabled

open var enabled: Boolean

extensions

open val extensions: ExtensionContainer?

fallbackLanguage

@get:Input

abstract val fallbackLanguage: Property<String>

The fallback language code used at runtime when a translation is missing in the current language.

finalizedBy

open val finalizedBy: TaskDependency?

group

open var group: @Nullable String?

identityPath

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

inputs

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

isEnabled

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

localState

open val localState: TaskLocalState?

logger

open val logger: Logger?

logging

open val logging: LoggingManager?

mustRunAfter

open val mustRunAfter: TaskDependency?

name

open val name: String?

objectName

@get:Input

abstract val objectName: Property<String>

The name of the generated Kotlin object holding the translations.

onlyIf

open val onlyIf: Spec<in TaskInternal?>?

outputDir

@get:OutputDirectory

abstract val outputDir: DirectoryProperty

Directory where the generated Kotlin sources are written. Owned exclusively by this task: it is wiped before every run, so renamed objects or removed languages leave no stale files behind.

outputs

open val outputs: TaskOutputsInternal?

path

open val path: String?

project

open val project: Project?

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

services

@get:Internal

protected open val services: ServiceRegistry?

sharedResources

open val sharedResources: List<ResourceLock?>?

shouldRunAfter

open val shouldRunAfter: TaskDependency?

sourceFiles

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val sourceFiles: Property<FileCollection>

The translation JSON source files to read and merge, one set per language.

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

state

open val state: TaskStateInternal?

targetPackage

@get:Input

abstract val targetPackage: Property<String>

Target package where the generated code should be placed.

taskActions

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

taskIdentity

open val taskIdentity: TaskIdentity<*>?

temporaryDir

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

timeout

open val timeout: Property<Duration?>?

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task?>?)

compareTo

open operator fun compareTo(otherTask: Task?): Int

configure

open fun configure(closure: Closure<*>?): Task?

dependsOn

open fun dependsOn(vararg paths: Any?): Task?

doFirst

open fun doFirst(action: Closure<*>?): Task?

open fun doFirst(action: Action<in Task?>?): Task?

open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?

doLast

open fun doLast(action: Closure<*>?): Task?

open fun doLast(action: Action<in Task?>?): Task?

open fun doLast(actionName: String?, action: Action<in Task?>?): Task?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)

finalizedBy

open fun finalizedBy(vararg paths: Any?): Task?

generate

fun generate()

Reads and merges all sourceFiles JSON translations by language, then writes the generated per-language data classes and the type-safe accessor object into outputDir.

hasProperty