Installation

This guide covers how to install and set up the Kotlin Suspend Transform Compiler Plugin in your project.

Version Information

• The latest version on which the current document is based (usually a version that does not include Beta or RC, etc.):
  v2.2.20-0.13.1

• The latest version in the Maven repository and Gradle plugin portal:
  

• The all releases: Go to GitHub Releases

Version Naming Convention

Before 0.9.0 (included), the naming convention for versions was x.y.z. But it seems that the contents of the Kotlin compiler may find changes with each version, and such version numbers do not reflect the corresponding Kotlin version, and may lead to some confusion as a result.

Therefore, starting after 0.9.0, versions will be named in the form $Kotlin-$plugin, e.g. 2.0.20-0.9.1. The first half is the version of Kotlin used for the build, while the second half is the version of this plugin.

Version Compatibility Table

If the version is less than or equal to 0.9.0, you can refer to this comparison table:

Kotlin version	plugin version
2.0.0	0.8.0-beta1 ~ 0.9.0
1.9.22	0.7.0-beta1
1.9.21	0.6.0
1.9.10	0.5.1
1.9.0	0.5.0
1.8.21	0.3.1 ~ 0.4.0

note

I haven't documented in detail the compiler plugin compatibility between each Kotlin version. From my memory and guess, Kotlin versions have a higher probability of incompatibility when minor is added (e.g. 1.8.0 -> 1.9.0), and a smaller probability of incompatibility when patch is added (e.g. 1.9.21 -> 1.9.22).

Version Follow-up

We typically actively follow updates for regular Kotlin release versions (such as 2.1.0, 2.2.20, etc.). For non-regular versions (such as 2.1.0-RC1, 2.2.20-Beta2, etc.), we do not guarantee that we will update for every version.

However, if:

• You need a specific version that is incompatible with previous versions and we haven't updated for it
• We haven't noticed/updated after a regular release update

Feel free to let us know through issues!

Gradle Setup

Plugins DSL

build.gradle.kts

plugins {
    kotlin("jvm") version "$KOTLIN_VERSION" // or multiplatform
    id("love.forte.plugin.suspend-transform") version "2.2.20-0.13.1"
    // Others ...
}

Legacy Plugin Application

build.gradle.kts

buildscript {
    repositories {
        mavenCentral()
        gradlePluginPortal()
    }
    dependencies {
        classpath("love.forte.plugin.suspend-transform:suspend-transform-plugin-gradle:2.2.20-0.13.1")
    }
}

plugins {
    id("org.jetbrains.kotlin.jvm") // or multiplatform?
    id("love.forte.plugin.suspend-transform")
    // Others ...
}

// config it.
suspendTransformPlugin {
    // Config the SuspendTransformPluginExtension ...
}

Configuration

For more information on this topic, please refer to Configuration.

Dependencies

Plugins may automatically introduce some dependencies. For more information on this topic, please refer to Configuration - Include Dependencies.

Cautions

Gradle JVM

Gradle JVM must be JDK11+.

K2 Support

K2 is supported since v0.7.0.

IDE support in current development projects

The IDE does NOT support highlighting for projects that currently use compiler plugins. If you want to verify that the compiler plugin is working, you can:

• JVM platform:
  • Check the compiled .class file or its decompiled result.
  • Use reflection to access the expected function in unit testing.
• JS platform:
  • Check whether the function is generated correctly by generating a .d.ts file.
  • Use dynamic access to the expected function in unit testing.