Initial commit

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*{.yml,yaml}]
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1,4 @@
+* text=auto eol=lf
+
+*.bat text eol=crlf
+*.jar binary

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+## 🐛 Describe the bug
+<!-- A clear and concise description of what the bug is. -->
+
+## ⚠️ Current behavior
+<!-- A clear and concise description of what you expected to happen. -->
+
+## ✅ Expected behavior
+<!-- A clear and concise description of what you expected to happen. -->
+
+## 💣 Steps to reproduce
+<!-- How we can reproduce the behavior: -->
+
+## 📷 Screenshots
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+## 📱 Tech info
+ - Device: <!-- e.g. Nexus One -->
+ - OS: <!-- e.g. 7.1.1 -->
+ - Library/App version: <!-- e.g. 1.0.0 -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+
+## ⚠️ Is your feature request related to a problem? Please describe
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+## 💡 Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
+
+## 🤚 Do you want to develop this feature yourself?
+<!-- Put an `x` symbol into braces of desired choice. -->
+- [ ] Yes
+- [ ] No

.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,26 @@
+<!-- Thanks for taking the time to write this Pull Request ❤️ -->
+
+## 🚀 Description
+<!-- Describe your changes in detail -->
+
+## 📄 Motivation and Context
+<!-- Why is this change required? What problem does it solve? -->
+<!-- If it fixes an open issue, please link to the issue here. -->
+
+## 🧪 How Has This Been Tested?
+<!-- Please describe in detail how you tested your changes. -->
+<!-- Include details of your testing environment, tests ran to see how -->
+<!-- your change affects other areas of the code, etc. -->
+
+## 📦 Types of changes
+<!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## ✅ Checklist
+<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.

.github/renovate.json

@@ -0,0 +1,8 @@
+{
+    "labels": [
+        "dependencies"
+    ],
+    "extends": [
+        "config:base"
+    ]
+}

.github/workflows/gradle-wrapper-validation.yml

@@ -0,0 +1,19 @@
+name: Validate Gradle Wrapper
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  validation:
+    name: Validation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout latest code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+      - name: Validate Gradle Wrapper
+        uses: gradle/wrapper-validation-action@v2
+

.github/workflows/pre-merge.yaml

@@ -0,0 +1,36 @@
+name: Pre Merge Checks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  gradle:
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+    runs-on: ${{ matrix.os }}
+    env:
+      GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }}
+      GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }}
+    if: ${{ !contains(github.event.head_commit.message, 'ci skip') }}
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+      - name: Cache Gradle Caches
+        uses: gradle/gradle-build-action@v3
+      - name: Run Gradle tasks
+        run: ./gradlew preMerge --continue
+
+        # We do a run of the new task `templateExample` created by the plugin
+      - name: Run the plugin
+        run: ./gradlew templateExample --message="Test Run" --tag=CI
+        if: success()
+        # And we verify that the output of the file is correct.
+      - name: Verify the plugin output
+        run: grep -Fxq "[CI] Test Run" ./example/build/template-example.txt
+        if: success()

.github/workflows/publish-plugin.yaml

@@ -0,0 +1,24 @@
+name: Publish Plugin to Portal
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  gradle:
+    runs-on: ubuntu-latest
+    env:
+      GRADLE_PUBLISH_KEY: ${{ secrets.GRADLE_PUBLISH_KEY }}
+      GRADLE_PUBLISH_SECRET: ${{ secrets.GRADLE_PUBLISH_SECRET }}
+    if: ${{ !contains(github.event.head_commit.message, 'ci skip') }}
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+      - name: Cache Gradle Caches
+        uses: gradle/gradle-build-action@v3
+      - name: Run Gradle tasks
+        run: ./gradlew preMerge --continue
+      - name: Publish on Plugin Portal
+        run: ./gradlew --project-dir plugin-build setupPluginUploadFromEnvironment publishPlugins
+        if: success()

.gitignore

@@ -0,0 +1,11 @@
+*.iml
+.DS_Store
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+build

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2020 <Source Code Author>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,95 @@
+# kotlin-gradle-plugin-template 🐘
+
+[![Use this template](https://img.shields.io/badge/-Use%20this%20template-brightgreen)](https://github.com/cortinico/kotlin-gradle-plugin-template/generate) [![Pre Merge Checks](https://github.com/cortinico/kotlin-gradle-plugin-template/workflows/Pre%20Merge%20Checks/badge.svg)](https://github.com/cortinico/kotlin-gradle-plugin-template/actions?query=workflow%3A%22Pre+Merge+Checks%22)  [![License](https://img.shields.io/github/license/cortinico/kotlin-android-template.svg)](LICENSE) ![Language](https://img.shields.io/github/languages/top/cortinico/kotlin-android-template?color=blue&logo=kotlin)
+
+A simple Github template that lets you create a **Gradle Plugin** 🐘 project using **100% Kotlin** and be up and running in a **few seconds**.
+
+This template is focused on delivering a project with **static analysis** and **continuous integration** already in place.
+
+## How to use 👣
+
+Just click on [![Use this template](https://img.shields.io/badge/-Use%20this%20template-brightgreen)](https://github.com/cortinico/kotlin-gradle-plugin-template/generate) button to create a new repo starting from this template.
+
+Once created don't forget to update the:
+- [gradle.properties](plugin-build/gradle.properties)
+- Plugin Usages (search for [com.ncorti.kotlin.gradle.template](https://github.com/cortinico/kotlin-gradle-plugin-template/search?q=com.ncorti.kotlin.gradle.template&unscoped_q=com.ncorti.kotlin.gradle.template) in the repo and replace it with your ID).
+
+## Features 🎨
+
+- **100% Kotlin-only template**.
+- Plugin build setup with **composite build**.
+- 100% Gradle Kotlin DSL setup.
+- Dependency versions managed via Gradle Versions Catalog (`libs.versions.toml`).
+- CI Setup with GitHub Actions.
+- Kotlin Static Analysis via `ktlint` and `detekt`.
+- Publishing-ready to Gradle Portal.
+- Issues Template (bug report + feature request)
+- Pull Request Template.
+
+## Composite Build 📦
+
+This template is using a [Gradle composite build](https://docs.gradle.org/current/userguide/composite_builds.html) to build, test and publish the plugin. This means that you don't need to run Gradle twice to test the changes on your Gradle plugin (no more `publishToMavenLocal` tricks or so).
+
+The included build is inside the [plugin-build](plugin-build) folder.
+
+### `preMerge` task
+
+A `preMerge` task on the top level build is already provided in the template. This allows you to run all the `check` tasks both in the top level and in the included build.
+
+You can easily invoke it with:
+
+```
+./gradlew preMerge
+```
+
+If you need to invoke a task inside the included build with:
+
+```
+./gradlew -p plugin-build <task-name>
+```
+
+
+### Dependency substitution
+
+Please note that the project relies on module name/group in order for [dependency substitution](https://docs.gradle.org/current/userguide/resolution_rules.html#sec:dependency_substitution_rules) to work properly. If you change only the plugin ID everything will work as expected. If you change module name/group, things might break and you probably have to specify a [substitution rule](https://docs.gradle.org/current/userguide/resolution_rules.html#sub:project_to_module_substitution).
+
+
+## Publishing 🚀
+
+This template is ready to let you publish to [Gradle Portal](https://plugins.gradle.org/).
+
+The [![Publish Plugin to Portal](https://github.com/cortinico/kotlin-gradle-plugin-template/workflows/Publish%20Plugin%20to%20Portal/badge.svg?branch=1.0.0)](https://github.com/cortinico/kotlin-gradle-plugin-template/actions?query=workflow%3A%22Publish+Plugin+to+Portal%22) Github Action will take care of the publishing whenever you **push a tag**.
+
+Please note that you need to configure two secrets: `GRADLE_PUBLISH_KEY` and `GRADLE_PUBLISH_SECRET` with the credetials you can get from your profile on the Gradle Portal.
+
+## 100% Kotlin 🅺
+
+This template is designed to use Kotlin everywhere. The build files are written using [**Gradle Kotlin DSL**](https://docs.gradle.org/current/userguide/kotlin_dsl.html) as well as the [Plugin DSL](https://docs.gradle.org/current/userguide/plugins.html#sec:plugins_block) to setup the build.
+
+Dependencies are centralized inside the [libs.versions.toml](gradle/libs.versions.toml).
+
+Moreover, a minimalistic Gradle Plugin is already provided in Kotlin to let you easily start developing your own around it.
+
+## Static Analysis 🔍
+
+This template is using [**ktlint**](https://github.com/pinterest/ktlint) with the [ktlint-gradle](https://github.com/jlleitschuh/ktlint-gradle) plugin to format your code. To reformat all the source code as well as the buildscript you can run the `ktlintFormat` gradle task.
+
+This template is also using [**detekt**](https://github.com/arturbosch/detekt) to analyze the source code, with the configuration that is stored in the [detekt.yml](config/detekt/detekt.yml) file (the file has been generated with the `detektGenerateConfig` task).
+
+## CI ⚙️
+
+This template is using [**GitHub Actions**](https://github.com/cortinico/kotlin-android-template/actions) as CI. You don't need to setup any external service and you should have a running CI once you start using this template.
+
+There are currently the following workflows available:
+- [Validate Gradle Wrapper](.github/workflows/gradle-wrapper-validation.yml) - Will check that the gradle wrapper has a valid checksum
+- [Pre Merge Checks](.github/workflows/pre-merge.yaml) - Will run the `preMerge` tasks as well as trying to run the Gradle plugin.
+- [Publish to Plugin Portal](.github/workflows/publish-plugin.yaml) - Will run the `publishPlugin` task when pushing a new tag.
+
+## Contributing 🤝
+
+Feel free to open a issue or submit a pull request for any bugs/improvements.
+
+## License 📄
+
+This template is licensed under the MIT License - see the [License](License) file for details.
+Please note that the generated template is offering to start with a MIT license but you can change it to whatever you wish, as long as you attribute under the MIT terms that you're using the template.

build.gradle.kts

@@ -0,0 +1,71 @@
+import com.github.benmanes.gradle.versions.updates.DependencyUpdatesTask
+import io.gitlab.arturbosch.detekt.Detekt
+
+plugins {
+    alias(libs.plugins.kotlin) apply false
+    alias(libs.plugins.detekt)
+    alias(libs.plugins.ktlint)
+    alias(libs.plugins.versionCheck)
+}
+
+subprojects {
+    apply {
+        plugin(rootProject.libs.plugins.detekt.get().pluginId)
+        plugin(rootProject.libs.plugins.ktlint.get().pluginId)
+    }
+
+    ktlint {
+        debug.set(false)
+        verbose.set(true)
+        android.set(false)
+        outputToConsole.set(true)
+        ignoreFailures.set(false)
+        enableExperimentalRules.set(true)
+        filter {
+            exclude("**/generated/**")
+            include("**/kotlin/**")
+        }
+    }
+
+    detekt {
+        config.setFrom(rootProject.files("config/detekt/detekt.yml"))
+    }
+}
+
+tasks.withType<Detekt>().configureEach {
+    reports {
+        html.required.set(true)
+        html.outputLocation.set(file("build/reports/detekt.html"))
+    }
+}
+
+tasks.withType<DependencyUpdatesTask> {
+    rejectVersionIf {
+        candidate.version.isNonStable()
+    }
+}
+
+fun String.isNonStable() = "^[0-9,.v-]+(-r)?$".toRegex().matches(this).not()
+
+tasks.register("clean", Delete::class.java) {
+    delete(rootProject.layout.buildDirectory)
+}
+
+tasks.register("reformatAll") {
+    description = "Reformat all the Kotlin Code"
+
+    dependsOn("ktlintFormat")
+    dependsOn(gradle.includedBuild("plugin-build").task(":plugin:ktlintFormat"))
+}
+
+tasks.register("preMerge") {
+    description = "Runs all the tests/verification tasks on both top level and included build."
+
+    dependsOn(":example:check")
+    dependsOn(gradle.includedBuild("plugin-build").task(":plugin:check"))
+    dependsOn(gradle.includedBuild("plugin-build").task(":plugin:validatePlugins"))
+}
+
+tasks.wrapper {
+    distributionType = Wrapper.DistributionType.ALL
+}