Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

provide ability to disable napt trigger generation #7

Merged
merged 1 commit into from
Aug 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,13 @@ package com.slapin.napt.sample;
class NaptTrigger {
}
```

#### Disabling NaptTrigger generation

`NaptTrigger.java` generation can be disabled (e.g. when you already have java sources in your module) by setting corresponding property to `false`:

``` Gradle
napt {
generateNaptTrigger.set(false)
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,15 @@ import org.gradle.api.provider.Property

abstract class NaptGradleExtension {

/**
* Defines whether to generate NaptTrigger.java file in order to kick Java compilation in or
* not. Defaults to true.
*/
abstract val generateNaptTrigger: Property<Boolean>

/**
* Defines package prefix for generated NaptTrigger class. Might be useful if project contains
* more than 1 equally named module. Defaults to null.
*/
abstract val naptTriggerPackagePrefix: Property<String>
}
10 changes: 7 additions & 3 deletions plugins/gradle/src/main/java/com/slapin/napt/NaptGradlePlugin.kt
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,17 @@ class NaptGradlePlugin : Plugin<Project> {
}

private fun Project.bindTriggerCreation(extension: NaptGradleExtension) {

val createTrigger =
tasks.register(
"createNaptTrigger",
CreateNaptTrigger::class.java,
) { task ->
task.mainSourceSetDir.set(layout.projectDirectory.dir("src/main"))
task.mainSourceSetJavaDirPath.set(
layout.projectDirectory.dir("src/main/java").asFile.path
)
task.projectName.set(name)
task.packagePrefix.set(extension.naptTriggerPackagePrefix)
task.onlyIf { extension.generateNaptTrigger.getOrElse(true) }
sergei-lapin marked this conversation as resolved.
Show resolved Hide resolved
task.group = "napt"
task.description = "Creates NaptTrigger.java in order to trigger NAPT javac plugin"
}
Expand Down Expand Up @@ -81,7 +83,9 @@ class NaptGradlePlugin : Plugin<Project> {
"cleanNaptTrigger",
CleanNaptTrigger::class.java,
) { task ->
task.mainSourceSetDir.set(layout.projectDirectory.dir("src/main"))
task.mainSourceSetJavaDirPath.set(
layout.projectDirectory.dir("src/main/java").asFile.path
)
task.group = "napt"
task.description = "Removes NaptTrigger.java if present"
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
package com.slapin.napt.task

import java.io.File
import javax.inject.Inject
import org.gradle.api.DefaultTask
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.tasks.InputDirectory
import org.gradle.api.tasks.PathSensitive
import org.gradle.api.tasks.PathSensitivity
import org.gradle.api.internal.file.FileOperations
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.TaskAction

abstract class CleanNaptTrigger : DefaultTask() {

@get:InputDirectory
@get:PathSensitive(PathSensitivity.RELATIVE)
abstract val mainSourceSetDir: DirectoryProperty
@get:Inject abstract val fileOperations: FileOperations

@get:Input abstract val mainSourceSetJavaDirPath: Property<String>

@TaskAction
fun run() {
val trigger = mainSourceSetDir.file("java/NaptTrigger.java").get().asFile
val trigger = File(fileOperations.file(mainSourceSetJavaDirPath.get()), "NaptTrigger.java")
didWork = trigger.exists()
if (trigger.exists()) trigger.delete()
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,25 +1,38 @@
package com.slapin.napt.task

import java.io.File
import javax.inject.Inject
import org.gradle.api.DefaultTask
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.file.RegularFile
import org.gradle.api.internal.file.FileOperations
import org.gradle.api.provider.Property
import org.gradle.api.provider.Provider
import org.gradle.api.tasks.*

import org.gradle.api.provider.ProviderFactory
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.Optional
import org.gradle.api.tasks.OutputFile
import org.gradle.api.tasks.TaskAction
import org.gradle.work.DisableCachingByDefault

@DisableCachingByDefault(because = "Not worth caching")
abstract class CreateNaptTrigger : DefaultTask() {

@get:Inject abstract val providersFactory: ProviderFactory

@get:Inject abstract val fileOperations: FileOperations

@get:Input abstract val projectName: Property<String>

@get:InputDirectory
@get:PathSensitive(PathSensitivity.RELATIVE)
abstract val mainSourceSetDir: DirectoryProperty
@get:Input abstract val mainSourceSetJavaDirPath: Property<String>

@get:Input @get:Optional abstract val packagePrefix: Property<String>

@get:OutputFile
val output: Provider<RegularFile>
get() = mainSourceSetDir.file("java/NaptTrigger.java")
val output: Provider<File>
get() =
providersFactory.provider {
val javaDir = fileOperations.file(mainSourceSetJavaDirPath.get())
File(javaDir, "NaptTrigger.java")
}

@TaskAction
fun run() {
Expand All @@ -29,9 +42,9 @@ abstract class CreateNaptTrigger : DefaultTask() {
class NaptTrigger {
}
""".trimIndent()
val output = output.get().asFile
val output = output.get()
output.parentFile?.mkdirs()
output.createNewFile()
if (!output.exists()) output.createNewFile()
output.writeText(triggerCode)
}

Expand Down