Kotlin Symbol Processing API

Welcome to KSP!

Kotlin Symbol Processing (KSP) is an API that you can use to develop lightweight compiler plugins. KSP provides a simplified compiler plugin API that leverages the power of Kotlin while keeping the learning curve at a minimum. Compared to KAPT, annotation processors that use KSP can run up to 2x faster.

Most of the documentation of KSP can be found on kotlinlang.org. Here are some handy links:

• Overview
• Quickstart
• Libraries that support KSP
• Why KSP?
• Examples
• How KSP models Kotlin code
• Reference for Java annotation processor authors
• Incremental processing notes
• Multiple round processing notes
• KSP on multiplatform projects
• Running KSP from command line
• FAQ

For debugging and testing processors, as well as KSP itself, please check DEVELOPMENT.md

KSP2 Is Here!

KSP2 is a new implementation of the KSP API. It is faster and easier to use than KSP 1.x. Please refer to the KSP2 introduction for more details.

Switching Between KSP1 And KSP2

Starting with KSP 2.0.0, KSP2 is enabled by default. You can still switch back to KSP1 with the Gradle property ksp.useKSP2=false, or the ksp extension in Gradle build scripts:

ksp {
    useKsp2 = false
}

KSP1 deprecation schedule

KSP1 will not be able to support newer Kotlin language features and will be deprecated starting from Kotlin 2.2.0. This is because KSP1 is a compiler plugin of K1, which is already deprecated. Also, the Kotlin Gradle Plugin is standardizing its API and disallowing accesses to its internal implementations on which KSP1 relies.

The KSP team will try to support KSP1 with best efforts so that users have more time to migrate to KSP2, but no promise can be made. Please plan migrating to KSP2 as early as possible.

Nightly Builds

Nightly builds of KSP for the latest Kotlin stable releases are published here.

maven("https://oss.sonatype.org/content/repositories/snapshots")

Feedback and Bug Reporting

Please let us know what you think about KSP by filing a Github issue or connecting with our team in the #ksp channel in the Kotlin Slack workspace!

If you are interested in sending PRs, please also check out the Contributor guide.

Ongoing and Future Works

Here are some planned features that have not yet been completely implemented:

• Improve support to multiplatform. E.g., running KSP on a subset of targets / sharing computations between targets
• Improve performance. There are a bunch of optimizations to be done!
• Keep fixing bugs!