library/io.github.baole.konture/FileDeclarationShouldContext

FileDeclarationShouldContext

Context receiver for writing declarative assertions on a FileDeclarationContext element. Provides easy access to all element properties and custom helper assertions.

Properties

allFiles

val allFiles: List<FileDeclarationContext>

Filter or assertion criteria for all files.

classes

val classes: List<ClassDeclaration>

Filter or assertion criteria for classes.

declaration

val declaration: FileDeclaration

Filter or assertion criteria for declaration.

element

val element: FileDeclarationContext

Filter or assertion criteria for element.

filePath

val filePath: String

Filter or assertion criteria for file path.

imports

val imports: List<String>

Filter or assertion criteria for imports.

kdocText

val kdocText: String?

Filter or assertion criteria for kdoc text.

modulePath

val modulePath: String

Filter or assertion criteria for module path.

name

val name: String

Filter or assertion criteria for name.

packageName

val packageName: String

Filter or assertion criteria for package name.

topLevelFunctions

val topLevelFunctions: List<FunctionDeclaration>

Filter or assertion criteria for top level functions.

topLevelProperties

val topLevelProperties: List<PropertyDeclaration>

Filter or assertion criteria for top level properties.

violations

val violations: MutableList<String>

Filter or assertion criteria for violations.

Functions

addViolation

fun addViolation(message: String)

Appends a custom violation failure message to the assertion run.

assertNoWildcardImports

fun assertNoWildcardImports()

Asserts that this file does not use any wildcard star imports.

assertOnlyOneClassPerFile

fun assertOnlyOneClassPerFile()

Asserts that this file contains at most one class declaration.

check

fun check(condition: Boolean, message: String? = null)

Asserts condition is true, recording a violation with message when false. When message is omitted, a default message referencing element is used.

containsClassWith

fun containsClassWith(predicate: (ClassDeclaration) -> Boolean): Boolean

Checks if this file contains any classes matching the given predicate.

hasImport

fun hasImport(predicate: (String) -> Boolean): Boolean

Checks if this file contains an import matching the given predicate.

hasImportContaining

fun hasImportContaining(vararg segments: String): Boolean

Checks if this file contains any import with matching package path segment strings.