aalekh-gradle/com.aalekh.aalekh.gradle.dsl/ForbiddenDependencySpec

ForbiddenDependencySpec

Builds one predicate rule inside a forbid { } block: "modules matching from must not depend on modules matching to".

aalekh {
    forbid {
        from(":core:domain")
        toModuleType(ModuleType.ANDROID_LIBRARY)
        because("the domain layer stays platform-agnostic")
        severity(Severity.ERROR)   // default ERROR
    }
    forbid {
        from(":feature:**")
        to(":feature:**")
        because("features must not depend on each other")
    }
}

Each side is selected either by path glob (from / to) or by module type (fromModuleType / toModuleType). The spec serializes to a plain, configuration-cache-safe string; predicates are never captured as lambdas.

Constructors

constructor()

Functions

apiOnly

fun apiOnly()

Restricts the rule to api dependencies only - an "API-leak" rule. The from module may still depend on to via implementation; it just may not re-export it onto its own consumers with api. Use it to stop a module widening its public surface, e.g. forbid { from(":core:public"); to(":core:internal"); apiOnly() }.

because

fun because(text: String)

Explains why the dependency is disallowed; shown in the violation message.

from

fun from(pattern: String)

Selects depending modules by Gradle path glob, e.g. ":feature:**".

fromModuleType

fun fromModuleType(type: ModuleType)

Selects depending modules by ModuleType.

severity

fun severity(level: Severity)

Severity for a match. ERROR (default) fails the build; WARNING only reports.

fun to(pattern: String)

Selects forbidden dependency targets by Gradle path glob.

toModuleType

fun toModuleType(type: ModuleType)

Selects forbidden dependency targets by ModuleType.