Welcome! 👋

Welcome to the Popcorn Gradle Plugin!

The goal of this plugin is to help enforce architectural rules in your project. Once you apply the plugin and specify your architecture guidelines, the plugin will automatically verify whether your architecture adheres to these rules.

📚 Take a look at our documentation

🚀 Getting Started

1. Add the Plugin Dependency

Go to your build-logic folder, in the build-logic/build.gradle.kts, add the following dependency:

implementation("io.github.codandotv:popcornguineapig:<version>")

2. Apply the Plugin and define your rules

Popcorn gives you two options: the individual plugin or the parent plugin.

The individual plugin lets you set up rules for specific parts of your project. The parent plugin is great if you want to keep everything in one place and define all the rules centrally.

As for the rules, you can define things like: "I don't want modules with the word presentation in their name to depend on modules that have data in the name." This lets you use your module naming conventions to your advantage.

4. Run the task

If you are using the individual plugin:

./gradlew popcorn

or if you are using the parent plugin:

./gradlew popcornParent

It is simple as a popcorn 🍿 + 🐹

🎯 Supported Project Types

The Popcorn Gradle Plugin supports:

• Kotlin Multiplatform Projects (KMP)

• Java Projects

• Android Projects