library/io.github.baole.konture/ArchitectureLayerPolicy

ArchitectureLayerPolicy

class ArchitectureLayerPolicy

First-class, declarative architectural-layer policy DSL.

A layer groups a set of modules and/or packages and declares which other layers it may (or may not) depend on, and which layers may (or may not) depend on it. The policy is compiled down to the primitive Konture module/package selectors and class dependency assertions.

Example Usage:

architecture {
    layer("feature") {
        selector {
            modules(":feature:**")
        }
        mayDependOn("core", "domain")
        mustNotDependOn("feature")
    }

    layer("domain") {
        selector {
            packages("com.acme.domain..")
        }
        mayDependOn("core")
    }
}

Properties

val name: String

The unique, human-readable name of this layer.

Functions

mayBeAccessedBy

fun mayBeAccessedBy(vararg layers: String)

Restricts the layers that are allowed to depend on this layer (intra-layer dependencies are always allowed).

fun mayBeAccessedBy(layers: List<String>)

Restricts the layers that are allowed to depend on this layer.

fun mayDependOn(vararg layers: String)

Restricts the layers this layer is allowed to depend on (intra-layer dependencies are always allowed).

fun mayDependOn(layers: List<String>)

Restricts the layers this layer is allowed to depend on.

mustNotBeAccessedBy

fun mustNotBeAccessedBy(vararg layers: String)

fun mustNotBeAccessedBy(layers: List<String>)

Forbids the given layers from depending on this layer.

mustNotDependOn

fun mustNotDependOn(vararg layers: String)

fun mustNotDependOn(layers: List<String>)

Forbids this layer from depending on the given layers.

fun selector(block: LayerSelectorDsl.() -> Unit)

Declares which modules and/or packages belong to this layer.