Code Monkey home page Code Monkey logo

gradle-kotlin-dsl-plugin-buildsrc's Introduction

gradle-kotlin-dsl-plugin-buildSrc

Simple internal (located in buildSrc) Gradle plugin example, written in Kotlin using Gradle Kotlin DSL

generate a project

gradle init --type=basic --dsl=kotlin --project-name=gradle-kotlin-dsl-plugin-buildSrc

create buildSrc

mkdir -p buildSrc/src/main/kotlin/com/github/daggerok/plugin

configure plugin

create buildSrc/build.gradle.kts file:

plugins {
  `kotlin-dsl`
}

repositories { // required by kotlin-dsl plugin dependencies
  jcenter()
}

gradlePlugin {
  plugins {
    register("hello-plugin") {
      id = "hello"
      implementationClass = "com.github.daggerok.plugin.HelloPlugin"
    }
  }
}

configure<KotlinDslPluginOptions> {
  experimentalWarning.set(false)
}

plugin implementation

prepare structure for your configuration extension

create ./buildSrc/src/main/kotlin/com/github/daggerok/plugin/HelloPlugin.kt file:

open class HelloExtension {
  var greeting: String = "Hello"
  var name: String = "buddy"
}

prepare plugin

class HelloPlugin : Plugin<Project> {
  override fun apply(project: Project): Unit = project.run {
    val hello = project.extensions.create<HelloExtension>("HelloExtension")
    project.extensions.add("hello", hello)
    tasks.register("hello") {
      doLast {
        println("${hello.greeting.capitalize()}, ${hello.name.capitalize()}!")
      }
    }
  }
}

plugin usage

plugins {
  hello
}

hello {
  greeting = "hola"
  name = "pablo"
}
./gradlew hello
# output
Hola, Pablo!

resources

gradle-kotlin-dsl-plugin-buildsrc's People

Contributors

daggerok avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

wael852

gradle-kotlin-dsl-plugin-buildsrc's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.