library/io.github.baole.konture/FilesRuleBuilder

FilesRuleBuilder

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

A builder for compiling and verifying architectural rules on Kotlin source files.

Accumulates filtering conditions (that()) and assertions (should()), which are verified against all source files in the project.

Constructors

FilesRuleBuilder

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

Functions

allowEmpty

fun allowEmpty(): FilesRuleBuilder

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

and

fun and(): FilesThat

Logical AND operator for chaining filter conditions.

andShould

fun andShould(): FilesShould

Logical AND operator for chaining assertion rules.

check

fun check(g: ProjectGraph = graph): ViolationReport

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

not

fun not(): FilesThat

Negates the next filter condition in the chain.

notShould

fun notShould(): FilesShould

Negates the next assertion rule in the chain.

fun or(): FilesThat

Logical OR operator for chaining filter conditions.

orShould

fun orShould(): FilesShould

Logical OR operator for chaining assertion rules.

printAllFiles

fun printAllFiles(logger: (FileDeclarationContext) -> Unit = { println( getMessage( "debug.files.discovered", it.declaration.name, ViolationLocation.format(it.declaration, it.modulePath, it.sourceSet?.name), it.declaration.packageName, ), ) }): FilesRuleBuilder

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

printMatchedFiles

fun printMatchedFiles(logger: (FileDeclarationContext) -> Unit = { println( getMessage( "debug.files.matched", it.declaration.name, ViolationLocation.format(it.declaration, it.modulePath, it.sourceSet?.name), it.declaration.packageName, ), ) }): FilesRuleBuilder

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

should

fun should(): FilesShould

Starts adding assertion rules that the selected files must satisfy.

should

fun FilesRuleBuilder.should(assertion: FileDeclarationShouldContext.() -> Any?): FilesRuleBuilder

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

suppress

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

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

that

fun that(): FilesThat

Starts adding filtering conditions to select which files to verify.

that

fun FilesRuleBuilder.that(predicate: FileDeclarationContext.() -> Boolean): FilesRuleBuilder

Filters files in this rule using a concise lambda predicate evaluated on each FileDeclarationContext.

xor

fun xor(): FilesThat

Logical XOR operator for chaining filter conditions.

xorShould

fun xorShould(): FilesShould

Logical XOR operator for chaining assertion rules.