library/io.github.baole.konture/FilesShould

FilesShould

class FilesShould : FilesShouldPathAssertions, FilesShouldContentAssertions, FilesShouldCompositeAssertions

Assertion builder for checking rule expectations on Kotlin file declarations.

Properties

builder

open override val builder: FilesRuleBuilder

Filter or assertion criteria for builder.

Functions

allOf

open fun allOf(vararg blocks: FilesShould.() -> Unit): FilesRuleBuilder

Filter or assertion criteria for all of.

annotatedWith

inline fun <T : Annotation> FilesShould.annotatedWith(): FilesRuleBuilder

Asserts that files are annotated with the annotation type parameter T.

infix fun FilesShould.annotatedWith(annotation: KClass<out Annotation>): FilesRuleBuilder

Asserts that files are annotated with the specified annotation class.

anyOf

open fun anyOf(vararg blocks: FilesShould.() -> Unit): FilesRuleBuilder

Asserts that selected files satisfy at least one of the specified assertion blocks.

beDocumentedWithKDoc

open fun beDocumentedWithKDoc(): FilesRuleBuilder

Filter or assertion criteria for be documented with k doc.

beFreeOfCycles

open fun beFreeOfCycles(): FilesRuleBuilder

Asserts that selected files do not form dependency cycles among themselves.

containClass

open fun containClass(vararg fqNames: String): FilesRuleBuilder

open infix fun containClass(fqName: String): FilesRuleBuilder

open infix fun containClass(fqNames: List<String>): FilesRuleBuilder

open infix fun containClass(kClass: KClass<*>): FilesRuleBuilder

Filter or assertion criteria for contain class.

containClasses

open fun containClasses(): FilesRuleBuilder

Filter or assertion criteria for contain classes.

containClassesWithAnnotation

inline fun <T : Annotation> containClassesWithAnnotation(): FilesRuleBuilder

Asserts that files contain classes with annotation type parameter T.

open infix fun containClassesWithAnnotation(annotationName: String): FilesRuleBuilder

open infix fun containClassesWithAnnotation(annotation: KClass<out Annotation>): FilesRuleBuilder

Filter or assertion criteria for contain classes with annotation.

containOnlyClassesWithVisibility

open fun containOnlyClassesWithVisibility(vararg visibilities: Visibility): FilesRuleBuilder

open fun containOnlyClassesWithVisibility(visibilities: List<Visibility>): FilesRuleBuilder

Asserts that all classes in matching files have one of the specified visibilities.

containOnlyFunctionsWithVisibility

open fun containOnlyFunctionsWithVisibility(vararg visibilities: Visibility): FilesRuleBuilder

open fun containOnlyFunctionsWithVisibility(visibilities: List<Visibility>): FilesRuleBuilder

Asserts that all top-level functions in matching files have one of the specified visibilities.

containOnlyPropertiesWithVisibility

open fun containOnlyPropertiesWithVisibility(vararg visibilities: Visibility): FilesRuleBuilder

open fun containOnlyPropertiesWithVisibility(visibilities: List<Visibility>): FilesRuleBuilder

Asserts that all top-level properties in matching files have one of the specified visibilities.

containTopLevelFunctions

open fun containTopLevelFunctions(): FilesRuleBuilder

Filter or assertion criteria for contain top level functions.

containTopLevelProperties

open fun containTopLevelProperties(): FilesRuleBuilder

Filter or assertion criteria for contain top level properties.

haveAllClassesEndingWith

open infix fun haveAllClassesEndingWith(suffix: String): FilesRuleBuilder

Filter or assertion criteria for have all classes ending with.

haveAllClassesMatching

open infix fun haveAllClassesMatching(pattern: String): FilesRuleBuilder

Filter or assertion criteria for have all classes matching.

haveAllClassesStartingWith

open infix fun haveAllClassesStartingWith(prefix: String): FilesRuleBuilder

Filter or assertion criteria for have all classes starting with.

haveClasses

open fun haveClasses(): FilesRuleBuilder

Filter or assertion criteria for have classes.

haveImportOf

open fun haveImportOf(vararg imports: String): FilesRuleBuilder

open infix fun haveImportOf(importFqName: String): FilesRuleBuilder

open infix fun haveImportOf(imports: List<String>): FilesRuleBuilder

open infix fun haveImportOf(kClass: KClass<*>): FilesRuleBuilder

Filter or assertion criteria for have import of.

haveNameMatchingClassName

open fun haveNameMatchingClassName(): FilesRuleBuilder

Filter or assertion criteria for have name matching class name.

haveNoWildcardImports

open fun haveNoWildcardImports(): FilesRuleBuilder

Filter or assertion criteria for have no wildcard imports.

haveOnlyOneClassPerFile

open fun haveOnlyOneClassPerFile(): FilesRuleBuilder

Filter or assertion criteria for have only one class per file.

haveTopLevelFunctions

open fun haveTopLevelFunctions(): FilesRuleBuilder

Filter or assertion criteria for have top level functions.

haveTopLevelProperties

open fun haveTopLevelProperties(): FilesRuleBuilder

Filter or assertion criteria for have top level properties.

inModule

open infix fun inModule(modulePath: String): FilesRuleBuilder

Asserts that files reside in a module matching modulePath.

inModules

open fun inModules(vararg modulePaths: String): FilesRuleBuilder

open infix fun inModules(modulePaths: List<String>): FilesRuleBuilder

Asserts that files reside in modules matching modulePaths.

inPackage

open fun inPackage(vararg packagePatterns: String): FilesRuleBuilder

open infix fun inPackage(packagePatterns: List<String>): FilesRuleBuilder

Asserts that files reside in packages matching packagePatterns.

open infix fun inPackage(predicate: (String) -> Boolean): FilesRuleBuilder

Asserts that files reside in a package matching predicate.

open infix fun inPackage(packagePattern: String): FilesRuleBuilder

Asserts that files reside in a package matching packagePattern.

inPackageOf

inline fun <T : Any> FilesShould.inPackageOf(): FilesRuleBuilder

Asserts that files are in the package of the type parameter T.

infix fun FilesShould.inPackageOf(type: KClass<*>): FilesRuleBuilder

Asserts that files are in the package of the specified type.

named

open fun named(vararg names: String): FilesRuleBuilder

open infix fun named(predicate: (String) -> Boolean): FilesRuleBuilder

open infix fun named(name: String): FilesRuleBuilder

open infix fun named(names: List<String>): FilesRuleBuilder

Filter or assertion criteria for named.

nameEndsWith

open fun nameEndsWith(vararg suffixes: String): FilesRuleBuilder

open infix fun nameEndsWith(suffix: String): FilesRuleBuilder

open infix fun nameEndsWith(suffixes: List<String>): FilesRuleBuilder

Filter or assertion criteria for name ending with.

nameMatches

open fun nameMatches(vararg patterns: String): FilesRuleBuilder

open infix fun nameMatches(pattern: String): FilesRuleBuilder

open infix fun nameMatches(patterns: List<String>): FilesRuleBuilder

Filter or assertion criteria for name matching.

nameStartsWith

open fun nameStartsWith(vararg prefixes: String): FilesRuleBuilder

open infix fun nameStartsWith(prefix: String): FilesRuleBuilder

open infix fun nameStartsWith(prefixes: List<String>): FilesRuleBuilder

Filter or assertion criteria for name starting with.

noneOf

open fun noneOf(vararg blocks: FilesShould.() -> Unit): FilesRuleBuilder

Filter or assertion criteria for none of.

notCall

open fun notCall(fqName: String): FilesRuleBuilder

open fun notCall(kClass: KClass<*>): FilesRuleBuilder

Filter or assertion criteria for not call.

notCall

inline fun <T : Any> FilesShould.notCall(): FilesRuleBuilder

Asserts that files do not call members of type parameter T.

notContainClass

open infix fun notContainClass(fqName: String): FilesRuleBuilder

open infix fun notContainClass(kClass: KClass<*>): FilesRuleBuilder

Filter or assertion criteria for not contain class.

notContainClasses

open fun notContainClasses(): FilesRuleBuilder

Filter or assertion criteria for not contain classes.

notContainCycles

open fun notContainCycles(): FilesRuleBuilder

Asserts that selected files do not form dependency cycles among themselves.

notContainTopLevelFunctions

open fun notContainTopLevelFunctions(): FilesRuleBuilder

Filter or assertion criteria for not contain top level functions.

notContainTopLevelProperties

open fun notContainTopLevelProperties(): FilesRuleBuilder

Filter or assertion criteria for not contain top level properties.

notContainWildcardImports

open fun notContainWildcardImports(): FilesRuleBuilder

Filter or assertion criteria for not contain wildcard imports.

notDependOnModules

open fun notDependOnModules(vararg modulePaths: String): FilesRuleBuilder

open infix fun notDependOnModules(modulePaths: List<String>): FilesRuleBuilder

Filter or assertion criteria for not depend on modules.

notDependOnPackages

open fun notDependOnPackages(vararg packages: String): FilesRuleBuilder

open infix fun notDependOnPackages(packages: List<String>): FilesRuleBuilder

Filter or assertion criteria for not depend on packages.

notHaveClasses

open fun notHaveClasses(): FilesRuleBuilder

Filter or assertion criteria for not have classes.

notHaveImportOf

open fun notHaveImportOf(vararg imports: String): FilesRuleBuilder

open infix fun notHaveImportOf(importFqName: String): FilesRuleBuilder

open infix fun notHaveImportOf(imports: List<String>): FilesRuleBuilder

open infix fun notHaveImportOf(kClass: KClass<*>): FilesRuleBuilder

Filter or assertion criteria for not have import of.

notHaveTopLevelFunctions

open fun notHaveTopLevelFunctions(): FilesRuleBuilder

Filter or assertion criteria for not have top level functions.

notHaveTopLevelProperties

open fun notHaveTopLevelProperties(): FilesRuleBuilder

Filter or assertion criteria for not have top level properties.

notHaveWildcardImports

open fun notHaveWildcardImports(): FilesRuleBuilder

Filter or assertion criteria for not have wildcard imports.

notInModule

open infix fun notInModule(modulePath: String): FilesRuleBuilder

Asserts that files do not reside in a module matching modulePath.

notInModules

open fun notInModules(vararg modulePaths: String): FilesRuleBuilder

open infix fun notInModules(modulePaths: List<String>): FilesRuleBuilder

Asserts that files do not reside in modules matching modulePaths.

notInPackage

open fun notInPackage(vararg packagePatterns: String): FilesRuleBuilder

open infix fun notInPackage(packagePatterns: List<String>): FilesRuleBuilder

Asserts that files do not reside in packages matching packagePatterns.

open infix fun notInPackage(packagePattern: String): FilesRuleBuilder

Asserts that files do not reside in a package matching packagePattern.

notNamed

open fun notNamed(vararg names: String): FilesRuleBuilder

open infix fun notNamed(name: String): FilesRuleBuilder

open infix fun notNamed(names: List<String>): FilesRuleBuilder

Filter or assertion criteria for notNamed.

notNameEndsWith

open fun notNameEndsWith(vararg suffixes: String): FilesRuleBuilder

open infix fun notNameEndsWith(suffix: String): FilesRuleBuilder

open infix fun notNameEndsWith(suffixes: List<String>): FilesRuleBuilder

Filter or assertion criteria for not name ending with.

notNameMatches

open fun notNameMatches(vararg patterns: String): FilesRuleBuilder

open infix fun notNameMatches(pattern: String): FilesRuleBuilder

open infix fun notNameMatches(patterns: List<String>): FilesRuleBuilder

Filter or assertion criteria for not name matching.

notNameStartsWith

open fun notNameStartsWith(vararg prefixes: String): FilesRuleBuilder

open infix fun notNameStartsWith(prefix: String): FilesRuleBuilder

open infix fun notNameStartsWith(prefixes: List<String>): FilesRuleBuilder

Filter or assertion criteria for not name starting with.

notReferenceClass

open fun notReferenceClass(fqName: String): FilesRuleBuilder

open fun notReferenceClass(kClass: KClass<*>): FilesRuleBuilder

Filter or assertion criteria for not reference class.

notReferenceClass

inline fun <T : Any> FilesShould.notReferenceClass(): FilesRuleBuilder

Asserts that files do not reference class type parameter T.

onlyDependOnModules

open fun onlyDependOnModules(vararg modulePaths: String): FilesRuleBuilder

open infix fun onlyDependOnModules(modulePaths: List<String>): FilesRuleBuilder

Filter or assertion criteria for only depend on modules.

onlyDependOnPackages

open fun onlyDependOnPackages(vararg packages: String): FilesRuleBuilder

open infix fun onlyDependOnPackages(packages: List<String>): FilesRuleBuilder

Filter or assertion criteria for only depend on packages.

satisfy

open infix fun satisfy(assertion: (FileDeclarationContext) -> Boolean): FilesRuleBuilder

Asserts that selected files satisfy a custom boolean condition.

open fun satisfy(assertion: (FileDeclarationContext, MutableList<String>) -> Unit): FilesRuleBuilder

Asserts that selected files satisfy a custom violation-collecting assertion.

open infix fun satisfy(description: String): FilesRuleBuilder

Asserts that selected files satisfy custom description description.

open fun satisfy(description: String, predicate: (FileDeclarationContext) -> Boolean): FilesRuleBuilder

Asserts that selected files satisfy custom predicate predicate with description.

open fun satisfy(id: String, description: String? = null, predicate: SatisfyContext<FileDeclarationContext>.(FileDeclarationContext) -> Boolean): FilesRuleBuilder

Asserts that selected files satisfy a custom predicate within a SatisfyContext block identified by id and optional description.