DemD10 / napt

Alternative to KAPT that skips Java stub generation and therefore is as efficient as Java APT but with Kotlin

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NAPT

Plugin License

What is it?

An alternative to KAPT that skips stub generation and hence runs up to 50% faster

Usage

JDK 9+ is required to run this particular set of tools

Once applied, you cant reference generated code in Kotlin code anymore, so you'd have to write Java bridge classes in order to reference Java generated code in Kotlin sources.

For example, assume we have following Kotlin Dagger 2 Component:

@Component
interface Component {
    
    @Component.Factory
    interface Factory {
        
        fun create(): Component
    }
}

then, in order to reference the generated component from Kotlin code we have to write Java bridge that would look like this:

class ComponentBridge {
    
    static Component.Factory factory() {
        return DaggerComponent.factory();
    }
}

That's it, now you can easily reference this bridge from your Kotlin code wherever you'd like to

Sample

You could see an example of usage in sample

Download

  • javac plugin is distributed through JitPack
  • Gradle plugin is distributed through Gradle Plugin Portal

Add to the root build.gradle

buildscript {
    repositories {
        gradlePluginPortal()
    }
}

subprojects {
    repositories {
        maven { url("https://jitpack.io") }
    }
}

Add plugin

Remove your old

plugins {
    kotlin("kapt")
}

and replace it with

plugins {
    id("com.sergei-lapin.napt") version("{latest-version}")
}

then you can replace all of your

dependencies {
    kapt("some dependency")
}

with

dependencies {
    annotationProcessor("some dependency")
}

That's it. Enjoy speed the speed up of your annotation processing by ~50%.

Ignore NaptTrigger

Add NaptTrigger.java to root .gitignore

Conflitcting NaptTrigger classes

By default Gradle plugin will generate NaptTrigger with module-named package so the FQ names won't clash, but, just in case, the prefix of NaptTrigger package can be specified like that:

napt {
    naptTriggerPackagePrefix.set("com.slapin.napt")
}

Assume we're in module named sample, will result in the following NaptTrigger.java:

package com.slapin.napt.sample;
class NaptTrigger {
}

About

Alternative to KAPT that skips Java stub generation and therefore is as efficient as Java APT but with Kotlin

License:MIT License


Languages

Language:Kotlin 58.6%Language:Java 41.4%