library/io.github.baole.konture/KontureFileScope

KontureFileScope

class KontureFileScope(val files: List<FileDeclaration>)

Represents a scope containing a set of Kotlin files for checking file-level rules.

Constructors

KontureFileScope

constructor(files: List<FileDeclaration>)

Types

object Companion

Properties

val files: List<FileDeclaration>

The list of FileDeclaration structures included in this scope.

Functions

assertFileNameMatchesClassName

fun KontureFileScope.assertFileNameMatchesClassName(additionalMessage: String? = null)

fun KontureFileScope.assertHasKDoc(additionalMessage: String? = null)

assertNameEndingWith

fun KontureFileScope.assertNameEndingWith(vararg suffixes: String)

Asserts that all file declarations in the scope have names ending with any of the specified suffixes.

assertNameMatching

fun KontureFileScope.assertNameMatching(vararg patterns: String)

Asserts that all file declarations in the scope have names matching any of the specified glob patterns.

assertNameStartingWith

fun KontureFileScope.assertNameStartingWith(vararg prefixes: String)

Asserts that all file declarations in the scope have names starting with any of the specified prefixes.

assertNoWildcardImports

fun KontureFileScope.assertNoWildcardImports(additionalMessage: String? = null)

assertOnlyOneClassPerFile

fun KontureFileScope.assertOnlyOneClassPerFile(additionalMessage: String? = null)

assertResideInAPackage

fun KontureFileScope.assertResideInAPackage(vararg packagePatterns: String)

Asserts that all file declarations in the scope reside in packages matching any of the specified patterns. Matches using standard Kotlin package wildcard matching (e.g. "..domain..").

fun KontureFileScope.assertTrue(additionalMessage: String? = null, predicate: (FileDeclaration) -> Boolean)

operator fun KontureFileScope.minus(other: KontureFileScope): KontureFileScope

operator fun KontureFileScope.plus(other: KontureFileScope): KontureFileScope

withNameEndingWith

fun KontureFileScope.withNameEndingWith(suffix: String): KontureFileScope

withNameMatching

fun KontureFileScope.withNameMatching(pattern: String): KontureFileScope

withNameStartingWith

fun KontureFileScope.withNameStartingWith(prefix: String): KontureFileScope

fun KontureFileScope.withPackage(packagePattern: String): KontureFileScope