https://github.com/gfx/gradle-plugin-template

A template project for Gradle plugins
https://github.com/gfx/gradle-plugin-template

Last synced: 26 days ago
JSON representation

A template project for Gradle plugins

• Host: GitHub
• URL: https://github.com/gfx/gradle-plugin-template
• Owner: gfx
• License: apache-2.0
• Created: 2014-05-15T23:25:10.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-03-08T01:05:18.000Z (over 9 years ago)
• Last Synced: 2023-05-25T06:26:50.362Z (over 1 year ago)
• Language: Groovy
• Size: 291 KB
• Stars: 13
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A Template Project on Gradle plugins for Android [![Build Status](https://travis-ci.org/gfx/gradle-plugin-template.svg)](https://travis-ci.org/gfx/gradle-plugin-template)

This is a template project on Gradle plugins for Android. The `plugin/` directory is the main

module that implements a Gradle plugin, including a plugin class, an extension class, and a task

class.

```

plugin/   - The main module of a Gradle plugin

example/  - An example android application that uses this plugin

buildSrc/ - A helper module to use this plugin in example modules

```

## Gradle Properties

Copy `gradle.properties.sample` into `~/.gradle/gradle.properties` and set correct values.

Note that `PGP_KEY_ID` is the value that `gpg --list-secret-keys` shows.

## Caveats

### Resources in plugin.jar

Reading resources from `plugin.jar` is extremely unstable so you'll see a method in

[FooTask.groovy](https://github.com/gfx/gradle-plugin-template/blob/master/plugin%2Fsrc%2Fmain%2Fgroovy%2Fcom%2Fgithub%2Fgfx%2Fgradle_plugin_template%2FFooTask.groovy):

```groovy

String getResourceContent(String filename) {

    URL templateFileUrl = getClass().getClassLoader().getResource(filename)

    if (templateFileUrl == null) {

        throw new GradleException("[${this.tag}] File not found: $filename")

    }

    try {

        return templateFileUrl.openStream().getText("UTF-8")

    } catch (IOException e) {

        // fallback to read JAR directly

        def connection = templateFileUrl.openConnection() as JarURLConnection

        def jarFile = connection.jarFileURL.toURI()

        ZipFile zip

        try {

            zip = new ZipFile(new File(jarFile))

        } catch (FileNotFoundException ex) {

            project.logger.warn("[${this.tag}] No plugin.jar. run `./gradlew plugin:jar` first.")

            throw ex

        }

        return zip.getInputStream((zip.getEntry(filename))).getText("UTF-8")

    }

}

```

It looks strange but works anyway. I don't know whether it is intended or not.

## See Also

* [Gradle User Guide](http://www.gradle.org/docs/current/userguide/userguide.html)

  * [Writing Custom Task Classes](http://www.gradle.org/docs/current/userguide/custom_tasks.html)

  * [Writing Custom Plugins](http://www.gradle.org/docs/current/userguide/custom_plugins.html)

## Author And License

Copyright 2014, FUJI Goro (gfx) . All rights reserved.

This library may be copied only under the terms of the Apache License 2.0, which may be found in the distribution.