io.spine.tools.gradle.bootstrap

Class BootstrapPlugin

java.lang.Object

io.spine.tools.gradle.SpinePlugin

io.spine.tools.gradle.bootstrap.BootstrapPlugin

All Implemented Interfaces:

io.spine.logging.Logging, org.gradle.api.Plugin<org.gradle.api.Project>

public final class BootstrapPlugin
extends io.spine.tools.gradle.SpinePlugin

Spine Bootstrap plugin entrance point.

This plugin configures the project in order to make it possible to develop Spine-based applications. Many configurations are implicit. For a more fine-grain configuration, use spine-model-compiler plugin, spine-proto-js-plugin, java/java-library plugin, and com.google.protobuf plugin directly.

A typical usage of the bootstrap plugin is as follows:

     
     // -- build.gradle --

     plugins {
         id 'io.spine.tools.gradle.bootstrap'
     }

     spine {
         enableJava {
             grpc = true
         }
         enableJavaScript()
     }
     
 

The example above configures the project to generate both Java and JS code from Protobuf. Also, gRPC stubs and implementation bases are generated for the Protobuf services in Java. Also, java, com.google.protobuf, io.spine.tools.spine-model.compiler, and io.spine.tools.spine-proto-js-plugin Gradle plugins are added to the project automatically.

Constructor Summary

Constructors

Constructor and Description
BootstrapPlugin()

Method Summary

Modifier and Type	Method and Description
void	apply(org.gradle.api.Project project)

Methods inherited from class io.spine.tools.gradle.SpinePlugin

logMissingDescriptorSetFile, newTask, resolve

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.spine.logging.Logging

_config, _debug, _error, _fine, _finer, _finest, _info, _severe, _trace, _warn, debugLevel, errorLevel, logger, loggerFor

Constructor Detail

BootstrapPlugin

public BootstrapPlugin()

Method Detail

apply

public void apply(org.gradle.api.Project project)