Welcome! 👋

Welcome to the Popcorn Gradle Plugin! A CodandoTV library : )

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

⚙️ Minimum requirements

Requirement	Minimum version
Java	17
Gradle	8.7
Kotlin	2.2.0
Android Gradle Plugin	8.7.3 (for Android projects)

🚀 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 the option to use a parent plugin.

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

./gradlew popcornParent

⚠️ If your project is using cache for configuration phase, it is necessary to run popcorngp in this way:

./gradlew popcornParent --no-configuration-cache

It is simple as a popcorn 🍿 + 🐹

🎯 Supported Project Types

The Popcorn Gradle Plugin supports:

• Kotlin Multiplatform Projects (KMP)

• Java Projects

• Android Projects