generating-gradle-plugin

BuildConfig and R class generator for non-Android projects

View the Project on GitHub hendraanggrian/generating-gradle-plugin

Travis CI Plugin Portal OpenJDK

Generating Gradle Plugin

Generate Android-like BuildConfig and R class on any JVM projects.

public final class BuildConfig {
    public static final String NAME = "My App";
    public static final String GROUP = "my.package";
    public static final String VERSION = "1.0";
    public static final String DEBUG = true;
}

public final class R {
    public static final class font {
        public static final String MyriadPro = "/font/MyriadPro.ttf";
        public static final String SegoeUI = "/font/SegoeUI.ttf";
    }
    public static final class layout {
        public static final String main = "/layout/main.fxml";
        public static final String about = "/layout/about.fxml";
    }
}

Download

Using plugins DSL:

plugins {
    id('com.hendraanggrian.generating') version "$version"
}

Using legacy plugin application:

buildscript {
    repositories {
        gradlePluginPortal()
    }
    dependencies {
        classpath("com.hendraanggrian:generating-gradle-plugin:$version")
    }
}

apply plugin: 'com.hendraanggrian.generating'

Usage

Once applied, the plugin works out of the box without additional configuration. To configure or even disable this behavior, modify task as instructed below.

This plugin does not have an extension, every configuration is performed within tasks.

BuildConfig

Modify BuildConfig class generation with generateBuildConfig task.

group 'com.example' // project group
version '1.0'       // project version

tasks.generateBuildConfig {
    packageName.set('my.app') // package name of which R.class will be generated to, default is project group

    appName.set('My App')     // `BuildConfig.NAME` value, default is project name
    groupId.set('my.app')     // `BuildConfig.GROUP` value, default is project group
    version.set('2.0')        // `BuildConfig.VERSION` value, default is project version
    debug.set(true)           // `BuildConfig.DEBUG` value

    // add custom field specifying its name, type, and value
    addField String.class, 'myString', 'Hello world!'
    addField double.class, 'myDecimal', 12.0
}

R

Modify R class generation with generateR task. Some file types (CSS & JSON) requires certain capabilities. This is to ensure that plugin consumer only download artifacts they are using.

group 'com.example' // project group
version '1.0'       // project version

tasks.generateR {
    packageName.set('my.app')
    resourceDirectory.set(new File('my/path/resources'))
    exclusions.addAll('some_file', 'some_other_file')
    properties { ... }  // enables Properties file support
}

Feature: CSS file

Enable CSS file support by reading CSS classes and IDs, powered by ph-css.

dependencies {
    classpath("com.hendraanggrian:pages-gradle-plugin:$version") {
        capabilities {
            requireCapability('com.hendraanggrian:generating-css')
        }
    }
}

tasks.generateR {
    css { ... }
}

Feature: JSON file

Enable CSS file support by reading JSON keys, powered by json-simple.

dependencies {
    classpath("com.hendraanggrian:pages-gradle-plugin:$version") {
        capabilities {
            requireCapability('com.hendraanggrian:generating-json')
        }
    }
}

tasks.generateR {
    json { ... }
}