library/io.github.baole.konture/KonturePropertyScope

KonturePropertyScope

class KonturePropertyScope(val properties: List<PropertyDeclarationContext>)

Represents a scope containing a set of property declaration contexts for checking property-level rules in a Konsist-inspired fluent DSL.

A scope acts as the starting point or container for filtering, querying, and running assertions against Kotlin property declarations (both member and top-level properties) in your codebase.

Constructors

Link copied to clipboard
constructor(properties: List<PropertyDeclarationContext>)

Types

Link copied to clipboard
object Companion

Factory methods for constructing property scopes.

Properties

Link copied to clipboard
val properties: List<PropertyDeclarationContext>

Filter or assertion criteria for properties.

Functions

Link copied to clipboard
fun KonturePropertyScope.assertTrue(additionalMessage: String? = null, predicate: (PropertyDeclarationContext) -> Boolean)

Asserts that all properties in this scope satisfy the given predicate.

Link copied to clipboard
fun KonturePropertyScope.extensionProperties(): KonturePropertyScope

Filters properties in this scope to include only extension properties.

Link copied to clipboard
fun KonturePropertyScope.haveNameEndingWith(suffix: String): KonturePropertyScope

Filters properties in this scope ending with suffix.

Link copied to clipboard
fun KonturePropertyScope.haveNameStartingWith(prefix: String): KonturePropertyScope

Filters properties in this scope starting with prefix.

Link copied to clipboard
fun PropertySelector.inPackage(packagePattern: String): PropertySelector

Filters this property selector to include properties residing in packages matching the specified pattern.

Link copied to clipboard
fun KonturePropertyScope.memberProperties(): KonturePropertyScope

Filters properties in this scope to include only member/class properties.

Link copied to clipboard
operator fun KonturePropertyScope.minus(other: KonturePropertyScope): KonturePropertyScope

Subtracts the properties present in other from this KonturePropertyScope.

Link copied to clipboard
operator fun KonturePropertyScope.plus(other: KonturePropertyScope): KonturePropertyScope

Combines two KonturePropertyScope scopes into a single unified scope.

Link copied to clipboard
fun KonturePropertyScope.resideInAPackage(packagePattern: String): KonturePropertyScope

Filters properties in this scope residing in packages matching packagePattern.

Link copied to clipboard
fun PropertySelector.should(): PropertySelectorShould

Returns a fluent assertion scope for sequential assertions on this PropertySelector.

Link copied to clipboard
fun KonturePropertyScope.topLevelProperties(): KonturePropertyScope

Filters properties in this scope to include only top-level properties.

Link copied to clipboard
fun KonturePropertyScope.valProperties(): KonturePropertyScope

Filters properties in this scope to include only read-only (val) properties.

Link copied to clipboard
fun KonturePropertyScope.varProperties(): KonturePropertyScope

Filters properties in this scope to include only mutable (var) properties.

Link copied to clipboard
fun KonturePropertyScope.withModule(modulePath: String): KonturePropertyScope

Filters properties in this scope to include only those residing in module modulePath.

Link copied to clipboard
fun PropertySelector.withName(pattern: String): PropertySelector

Filters this property selector to include properties whose names match the specified pattern.

Link copied to clipboard
fun KonturePropertyScope.withNameMatching(pattern: String): KonturePropertyScope

Filters properties in this scope matching glob pattern pattern.