io.spine.js.gradle

Class ProtoJsPlugin

java.lang.Object

io.spine.tools.gradle.SpinePlugin

io.spine.tools.gradle.ProtoPlugin

io.spine.js.gradle.ProtoJsPlugin

All Implemented Interfaces:

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

public class ProtoJsPlugin
extends io.spine.tools.gradle.ProtoPlugin

The Gradle plugin which performs additional code generation for Protobuf types.

To run the plugin, add the "io.spine.tools:spine-proto-js-plugin:$spineBaseVersion" to the classpath configuration and add apply plugin: 'io.spine.tools.proto-js-plugin' to the module generating JS messages.

In particular, the plugin:

• Generates a getter to obtain a TypeUrl for each type.
• Generates parsers for types with standard JSON mapping.
• Exposes all the messages and enums as well as generated parsers (to be used by the Spine Web).

The main plugin action may be retrieved and configured as necessary via the "protoJs" extension. By default, the action is a dependency of the build task.

This plugin currently relies on the set of the hard-coded Gradle settings which have to be set to the required values in a project willing to use the plugin. These settings are:

1. CommonJS import style for all generated code: js {option "import_style=commonjs"};

The build.gradle file located under the test/resources folder of this module can be used as an example of the required project configuration.

Constructor Summary

Constructors

Constructor and Description
ProtoJsPlugin()

Method Summary

Modifier and Type	Method and Description
void	apply(org.gradle.api.Project project)
protected java.util.function.Supplier<java.io.File>	mainDescriptorFile(org.gradle.api.Project project)
protected java.util.function.Supplier<java.io.File>	testDescriptorFile(org.gradle.api.Project project)

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

mainProtoFiles, testProtoFiles

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

ProtoJsPlugin

public ProtoJsPlugin()

Method Detail

apply

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

mainDescriptorFile

protected java.util.function.Supplier<java.io.File> mainDescriptorFile(org.gradle.api.Project project)

Specified by:

mainDescriptorFile in class io.spine.tools.gradle.ProtoPlugin

testDescriptorFile

protected java.util.function.Supplier<java.io.File> testDescriptorFile(org.gradle.api.Project project)

Specified by:

testDescriptorFile in class io.spine.tools.gradle.ProtoPlugin