library/io.github.baole.konture/RuleBuilder

RuleBuilder

class RuleBuilder(val id: String, projectGraph: ProjectGraph = Konture.projectGraph)

DSL builder for configuring named architecture rules with metadata and sub-rule blocks.

Constructors

RuleBuilder

constructor(id: String, projectGraph: ProjectGraph = Konture.projectGraph)

Properties

description

var description: String?

Human-readable explanation or rationale for this rule.

val id: String

Unique identifier for the rule.

severity

var severity: Severity

Severity level associated with rule violations (defaults to Severity.ERROR).

Functions

buildMetadata

fun buildMetadata(): RuleMetadata

Constructs the RuleMetadata representation of this rule configuration.

classes

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

Declares a class-level rule suite inside this named rule scope.

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

Declares a class-level rule suite scoped to specific source sets.

files

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

Declares a file-level rule suite inside this named rule scope.

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

Declares a file-level rule suite scoped to specific source sets.

functions

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

Declares a function-level rule suite inside this named rule scope.

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

Declares a function-level rule suite scoped to specific source sets.

layered

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

Declares a nested type-safe layered architecture specification inside this named rule scope.

layeredArchitecture

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

Declares a layered-architecture rule suite inside this named rule scope.

modules

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

Declares a module-level rule suite inside this named rule scope.

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

Declares a module-level rule suite scoped to specific source sets.

properties

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

Declares a property-level rule suite inside this named rule scope.

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

Declares a property-level rule suite scoped to specific source sets.

slices

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

Declares a slice rule suite inside this named rule scope.

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

Declares a slice rule suite scoped to specific source sets.

suppress

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

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

tag

fun tag(vararg tagNames: String)

Tag this rule with one or more arbitrary string labels.