Gradle Configuration

Mappie is a Kotlin compiler plugin which comes with a Gradle plugin to automatically apply and configure the compiler plugin. We can apply Mappie by adding the following plugin to the Gradle build file

plugins {
    id("tech.mappie.plugin") version "x.y.z"
}

plugins {
    id "tech.mappie.plugin" version "x.y.z"
}

When using mappie version below 1.0.0 or when you want to add the mappie-api dependency manually, the mappie-api dependency can be added as follows

dependencies {
    implementation("tech.mappie:mappie-api:x.y.z")
}

dependencies {
    implementation "tech.mappie:mappie-api:x.y.z"
}

The most recent version of Mappie can be found at the releases page.

Configuration #

Mappie can be configured via Gradle or per Mapper. The following configuration options are available

mappie {
    useDefaultArguments = false // Disable using default arguments in implicit mappings
    strictness {
        visibility = true // Allow calling constructors not visible from the calling scope
        enums = false // Do not report an error if not all enum sources are mapped 
    }
}

Local configuration options are applied as annotations on the class level of mappers, and will override the global configuration option on a per-mapper basis.

The following options exist with their corresponding default values

Compatibility #

Mappie depends on some compiler internals, which might be unstable. These dependencies are kept to a minimum, but are unavoidable. Mappie is tested and compatible with Kotlin versions 1.9.24, 2.0.0, and higher.

Versions below 1.9.24 might work, but are untested. If you encounter an issue, please report this as a bug. Note that incompatible versions might lead to a compilation failure, but never to runtime risks.