Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 1.95 KB

README.md

File metadata and controls

55 lines (43 loc) · 1.95 KB
Raw

Delect - The Gradle Plugin for Dagger Reflect

Delect automatically substitutes Dagger for Dagger Reflect for faster local builds.

Dagger, a dependency injection framework for Java, can slow down compilation with its lengthy annotation processing and code generation.

Dagger Reflect uses the same API as Dagger but swaps the compile time annotation processing for runtime based reflection.

Usage

Delect uses the partial reflection approach.

  1. Add the plugin to your project's root build.gradle:
buildscript {
  classpath 'com.soundcloud.delect:delect-plugin:0.1.0'
}
apply plugin: 'com.soundcloud.delect'
  1. Make sure to use the @Component.Builder or @Component.Factory to create component instances.
  2. Add the runtime retention policy to all @Qualifier, @MapKey and other custom Dagger annotations:
@Retention(RUNTIME)
  1. Add dagger.reflect=true to gradle.properties. You can also add it to ~/.gradle/gradle.properties so it doesn't need to be checked into the project.
  2. Build -- and skip all that pesky code generation!

Plugin Development

To publish to maven local:

./gradlew -b buildSrc/build.gradle.kts publishToMavenLocal

To publish:

./gradlew -b buildSrc/build.gradle.kts publishMavenJavaPublicationToMavenRepository

License

Copyright 2019 SoundCloud

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.