library/io.github.baole.konture/RuleSetBuilder

RuleSetBuilder

class RuleSetBuilder(var name: String? = null)

DSL builder for configuring a reusable RuleSet.

Allows declaring module, class, function, property, file, slice, and layer rules, importing existing rule sets, and writing custom extension functions.

Constructors

RuleSetBuilder

constructor(name: String? = null)

Properties

description

var description: String?

Optional human-readable explanation or rationale for this rule set.

name

var name: String?

Optional human-readable name or identifier for this rule set.

Functions

apply

fun apply(rule: RuleDefinition)

Imports and executes a RuleDefinition within this rule set.

fun apply(ruleSet: RuleSet)

Imports and executes another RuleSet within this rule set.

fun apply(vararg rules: RuleDefinition)

Imports and executes multiple RuleDefinition instances within this rule set.

fun apply(vararg ruleSets: RuleSet)

Imports and executes multiple RuleSet instances within this rule set.

fun apply(ruleSets: Iterable<RuleSet>)

Imports and executes a collection of RuleSet instances within this rule set.

assertNoCycles

fun assertNoCycles(includeTestConfigurations: Boolean = false)

Alias for noCycles.

classes

fun classes(block: ClassesRuleBuilder.() -> Unit)

Declares a suite of class structure/dependency rules inside this rule set.

fun classes(sourceSets: SourceSetSelector, block: ClassesRuleBuilder.() -> Unit)

Declares a suite of class structure/dependency rules scoped to specific source sets.

files

fun files(block: FilesRuleBuilder.() -> Unit)

Declares a suite of file structure/dependency rules inside this rule set.

fun files(sourceSets: SourceSetSelector, block: FilesRuleBuilder.() -> Unit)

Declares a suite of file structure/dependency rules scoped to specific source sets.

functions

fun functions(block: FunctionsRuleBuilder.() -> Unit)

Declares a suite of function structure/dependency rules inside this rule set.

fun functions(sourceSets: SourceSetSelector, block: FunctionsRuleBuilder.() -> Unit)

Declares a suite of function structure/dependency rules scoped to specific source sets.

layer

fun layer(name: String, block: ArchitectureLayerPolicy.() -> Unit)

Declares a first-class architectural layer with module/package selectors and explicit dependency boundaries inside this rule set.

layered

fun layered(block: LayeredArchitectureDsl.() -> Unit)

Declares a nested, type-safe layered-architecture specification inside this rule set.

layeredArchitecture

fun layeredArchitecture(block: LayeredArchitectureBuilder.() -> Unit)

Declares a suite of layered-architecture rules inside this rule set.

modules

fun modules(block: ModulesRuleBuilder.() -> Unit)

Declares a suite of module structure/dependency rules inside this rule set.

fun modules(sourceSets: SourceSetSelector, block: ModulesRuleBuilder.() -> Unit)

Declares a suite of module structure/dependency rules scoped to specific source sets.

noCycles

fun noCycles(includeTestConfigurations: Boolean = false)

Verifies that there are no module dependency cycles in the project.

properties

fun properties(block: PropertiesRuleBuilder.() -> Unit)

Declares a suite of property structure/dependency rules inside this rule set.

fun properties(sourceSets: SourceSetSelector, block: PropertiesRuleBuilder.() -> Unit)

Declares a suite of property structure/dependency rules scoped to specific source sets.

rule

fun rule(id: String, block: RuleBuilder.() -> Unit)

Declares a named architecture rule with metadata and sub-rules inside this rule set.

slices

fun slices(block: SlicesRuleBuilder.() -> Unit)

Declares a suite of slice rules inside this rule set.

fun slices(sourceSets: SourceSetSelector, block: SlicesRuleBuilder.() -> Unit)

Declares a suite of slice rules scoped to specific source sets.

sourceSet

fun sourceSet(selector: SourceSetSelector, block: ArchitectureSourceSetPolicy.() -> Unit)

Declares a first-class source-set architecture policy using a custom SourceSetSelector.

fun sourceSet(vararg names: String, block: ArchitectureSourceSetPolicy.() -> Unit)

Declares a first-class source-set architecture policy for source sets matching any of names.

fun sourceSet(name: String, block: ArchitectureSourceSetPolicy.() -> Unit)

Declares a first-class source-set architecture policy for source sets matching name.