+ Obviously, you can choose any kind of API to communicate between the directive and its plug-in. In the code
+ above, I chose to directly overrid the entire Info field, but you could instead choose to call
+ a function, just set one boolean instead of the whole object, etc...
+
Tasks are provided by plug-ins and can be invoked from the command line, e.g. ./gradlew assemble. There are two kinds of tasks: static and dynamic.
@@ -418,11 +422,95 @@ fun lineCount(project: Project): TaskResult {
Note that there is no alwaysRunBefore annotation since runBefore
achieves the same functionality.
+ Here are a few different scenarios to illustrate how the three attributes work for the task exampleTask:
+
+Result of the command ./kobaltw --dryRun compile
+
Configuration for exampleTask |
+ Result | + + +
| runBefore = "compile" | +
+ kobalt-line-count:clean +kobalt-line-count:exampleTask +kobalt-line-count:compile+ |
+
| runAfter = "compile" | +
+ kobalt-line-count:clean +kobalt-line-count:compile+ |
+
| alwaysRunAfter = "compile" | +
+ kobalt-line-count:clean +kobalt-line-count:compile +kobalt-line-count:exampleTask+ |
+
+ Dynamic tasks are useful when you want your plug-in to generate one or several tasks that depend on
+ some other runtime information (therefore, you can't declare a method and put a @Task
+ annotation on it). Here is the simplest dynamic task you can create in your plug-in class:
+
+override fun apply(project: Project, context: KobaltContext) {
+ println("*** Adding dynamic task")
+ addTask(project, "dynamicTask") {
+ println("Dynamic task")
+ TaskResult()
+ }
+}
+
+
+ Like a regular task method, the closure you pass to addTask() has to return a TaskResult
+ object to indicate whether it succeeded or failed. You can
+ then see your dynamic task in the list of tasks and run it directly:
+
+$ ./kobaltw --tasks + ===== kobalt-line-count ===== + dynamicTask + lineCount Count the lines +$ ./kobaltw dynamicTask +Dynamic task ++
+ The addTask() method lets you specify any attribute you can specify on the @Task
+ annotation: description, runBefore, etc... For example, here is how we would
+ specify that this task should always run after compile:
+
+addTask(project, "dynamicTask", alwaysRunAfter = listOf("compile")) {
+ println("Dynamic task")
+ TaskResult()
+}
+
++ Let's test it: +
+ ++$ ./kobaltw --dryRun compile +kobalt-line-count:clean +kobalt-line-count:compile +kobalt-line-count:exampleTask +