library/io.github.baole.konture/FunctionsRuleBuilder

FunctionsRuleBuilder

class FunctionsRuleBuilder(graph: ProjectGraph = Konture.projectGraph, sourceSets: SourceSetSelector = SourceSets.production())

A builder for compiling and verifying architectural rules on Kotlin function declarations.

Accumulates filtering conditions (that()) and assertions (should()), which are verified against all functions in the project (both member/class functions and top-level functions).

Constructors

constructor(graph: ProjectGraph = Konture.projectGraph, sourceSets: SourceSetSelector = SourceSets.production())

Functions

allowEmpty

fun allowEmpty(): FunctionsRuleBuilder

Configures this builder to allow empty selections (i.e. if no functions match the that() filter, the rule will pass instead of throwing an AssertionError).

and

fun and(): FunctionsThat

Logical AND operator for chaining filter conditions.

andShould

fun andShould(): FunctionsShould

Logical AND operator for chaining assertion rules.

check

fun check(g: ProjectGraph = graph): ViolationReport

Executes the compiled function rules against the provided project graph. Throws an AssertionError if any rule violations are detected.

not

fun not(): FunctionsThat

Negates the next filter condition in the chain.

notShould

fun notShould(): FunctionsShould

Negates the next assertion rule in the chain.

fun or(): FunctionsThat

Logical OR operator for chaining filter conditions.

orShould

fun orShould(): FunctionsShould

Logical OR operator for chaining assertion rules.

printAllFunctions

fun printAllFunctions(logger: (FunctionDeclarationContext) -> Unit = { println(getMessage("debug.functions.discovered", it.qualifiedName, ViolationLocation.format(it))) }): FunctionsRuleBuilder

Debugging helper that prints information about all discovered functions in the project graph.

printMatchedFunctions

fun printMatchedFunctions(logger: (FunctionDeclarationContext) -> Unit = { println(getMessage("debug.functions.matched", it.qualifiedName, ViolationLocation.format(it))) }): FunctionsRuleBuilder

Debugging helper that prints information about all functions matched by the that() filter.

should

fun should(): FunctionsShould

Starts adding assertion rules that the selected functions must satisfy.

should

fun FunctionsRuleBuilder.should(assertion: FunctionDeclarationShouldContext.() -> Any?): FunctionsRuleBuilder

Asserts rules on filtered functions using a lambda block that provides a FunctionDeclarationShouldContext receiver. Supports both imperative assertions and Boolean predicate matches.

suppress

fun suppress(block: RuleSuppressionBuilder.() -> Unit): FunctionsRuleBuilder

Configures programmatic violation suppressions for this function rule suite with mandatory audit rationale.

that

fun that(): FunctionsThat

Starts adding filtering conditions to select which functions to verify.

that

fun FunctionsRuleBuilder.that(predicate: FunctionDeclarationContext.() -> Boolean): FunctionsRuleBuilder

Filters functions in this rule using a concise lambda predicate evaluated on each FunctionDeclarationContext.

xor

fun xor(): FunctionsThat

Logical XOR operator for chaining filter conditions.

xorShould

fun xorShould(): FunctionsShould

Logical XOR operator for chaining assertion rules.