README.md

Chords-Gradle-plugin

Gradle plugin for Spine Chords library that generates Kotlin extensions for Proto messages.

The following code will be generated if the plugin is applied to a project:

• MessageDef implementations for Proto messages.
• MessageField implementations for the fields of Proto messages.
• MessageOneof implementations for the oneof fields of Proto messages.
• Some other useful Kotlin extensions, e.g. ValidatingBuilder.messageDef() that returns the instance of MessageDef implementation for the current message builder.

Requirements

• Java 11
• Gradle 6.9.x

How it works

Actually, the plugin applies codegen-plugins to a project, which requires the code generation.

The codegen-plugins, which generate the code, require the newer version of Gradle, 7.6.x at the moment, comparing to Chords-based projects, which require Gradle version 6.9.x.

So, in order to apply codegen-plugins, this Gradle plugin creates so-called codegen-workspace project, which is configured with Gradle 7.6.x and serves as a place where code generation should be performed. The plugin then copies Proto sources from the original project to the codegen-workspace and runs code generation. After generating the Kotlin extensions, it will be copied back to the original project.

How to use

The following configuration should be added to the build.gradle.kts to apply the plugin:

plugins {
    id("io.spine.chords") version "1.9.5" // Specify the actual version here.
}

// Plugin configuration.
//
chordsGradlePlugin {  
    
    // Specify the artifact of `codegen-plugins` that will be used for code generation.
    //
    // This property is required.
    //
    // The version or even name will differ in your case.
    //
    codegenPluginsArtifact = 
        "io.spine.chords:spine-chords-codegen-plugins:2.0.0-SNAPSHOT.27"
    
    // Specify the Proto dependencies that are required for code generation.
    //
    // This section is optional.
    //
    // Enumerate the libraries, onto which the processed Proto sources depend.
    //
    protoDependencies(
        "io.spine:spine-money:1.5.0"
    ) 
}

The plugin adds a dependency for the compileKotlin task if it is present in the project. Otherwise, it should be configured manually in the project's build script so that the applyCodegenPlugins task is run.

Below is an example configuration, which may differ in your case:

tasks.named("compileKotlin") {
    dependsOn(
        tasks.named("applyCodegenPlugins")
    )
}