janewaitara / GradleBuildPlugins

Sample project that shows you how to configure plugins

GradleBuildPlugins

👀 Sample project that shows you how to configure plugins. After generating the project from this template, remember to customize detekt rules and spotless plugin if needed:

• To customize detekt rules, edit the detekt.yml on your root directory

• Inside the spotless folder, on your root directory - add your license file

• Remember to refactor the package name 🚀

Prerequisites

Before every commit, make sure you run the following command:

./codeAnalysis

To check for dependency updates, run the following command:

./gradlew dependencyUpdate

Refer to this issue, if you get any issues running the lint commands on the terminal 🚀

Tech-stack

• Gradle
  • Gradle Kotlin DSL - For reference purposes, here's an article explaining the migration.
  • Plugins
    • Ktlint - creates convenient tasks in your Gradle project that run ktlint checks or do code auto format.
    • Detekt - a static code analysis tool for the Kotlin programming language.
    • Spotless - format java, groovy, markdown and license headers using gradle.
    • Dokka - a documentation engine for Kotlin, performing the same function as javadoc for Java.
    • jacoco - a Code Coverage Library.
    • Gradle Versions - provides a task to determine which dependencies have updates. Additionally, the plugin checks for updates to Gradle itself.

For reference, here's a detailed explanation of the approach of the plugin configuration in this project - A Day with an Elephant in the Room: Configuring Gradle Plugins.