library/io.github.baole.konture/ModulesThat

ModulesThat

class ModulesThat

Fluent API for defining filtering conditions on Gradle modules.

Functions

allOf

fun allOf(vararg blocks: ModulesThat.() -> Unit): ModulesRuleBuilder

Matches if all of the nested condition blocks are satisfied.

anyOf

fun anyOf(vararg blocks: ModulesThat.() -> Unit): ModulesRuleBuilder

Matches if any of the nested condition blocks are satisfied.

applyPlugin

infix fun applyPlugin(pluginId: String): ModulesRuleBuilder

infix fun applyPlugin(pluginIds: List<String>): ModulesRuleBuilder

Filter or assertion criteria for apply plugin.

containClass

infix fun containClass(fqName: String): ModulesRuleBuilder

infix fun containClass(type: KClass<*>): ModulesRuleBuilder

Filter or assertion criteria for contain class.

containClass

inline fun <T : Any> ModulesThat.containClass(): ModulesRuleBuilder

Filters modules containing the class specified by type parameter T.

containClassesInPackage

infix fun containClassesInPackage(packagePattern: String): ModulesRuleBuilder

Filter or assertion criteria for contain classes in package.

containClassesWithAnnotation

infix fun containClassesWithAnnotation(annotationFqName: String): ModulesRuleBuilder

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

Filter or assertion criteria for contain classes with annotation.

containClassesWithAnnotation

inline fun <T : Annotation> ModulesThat.containClassesWithAnnotation(): ModulesRuleBuilder

Filters modules containing classes annotated with annotation type parameter T.

dependOnExternalLibraries

fun dependOnExternalLibraries(vararg coordinates: String): ModulesRuleBuilder

Filter or assertion criteria for depend on external libraries.

dependOnExternalLibrary

infix fun dependOnExternalLibrary(coordinate: String): ModulesRuleBuilder

Filter or assertion criteria for depend on external library.

dependOnModule

infix fun dependOnModule(modulePath: String): ModulesRuleBuilder

Filter or assertion criteria for depend on module.

dependOnModules

fun dependOnModules(vararg modulePaths: String): ModulesRuleBuilder

infix fun dependOnModules(modulePaths: List<String>): ModulesRuleBuilder

Filter or assertion criteria for depend on modules.

haveBuildId

infix fun haveBuildId(buildId: String): ModulesRuleBuilder

Filter or assertion criteria for have build id.

haveName

fun haveName(vararg paths: String): ModulesRuleBuilder

infix fun haveName(path: String): ModulesRuleBuilder

infix fun haveName(paths: List<String>): ModulesRuleBuilder

Filter or assertion criteria for have name.

haveNameEndingWith

fun haveNameEndingWith(vararg suffixes: String): ModulesRuleBuilder

infix fun haveNameEndingWith(suffix: String): ModulesRuleBuilder

infix fun haveNameEndingWith(suffixes: List<String>): ModulesRuleBuilder

Filter or assertion criteria for have name ending with.

haveNameMatching

fun haveNameMatching(vararg patterns: String): ModulesRuleBuilder

infix fun haveNameMatching(patterns: List<String>): ModulesRuleBuilder

Restricts the rules to modules whose Gradle path matches any of the specified glob patterns.

infix fun haveNameMatching(pattern: String): ModulesRuleBuilder

Restricts the rules to modules whose Gradle path matches the specified glob pattern.

haveNamePath

fun haveNamePath(vararg paths: String): ModulesRuleBuilder

Restricts the rules to modules with an exact matching Gradle path in the specified paths.

infix fun haveNamePath(predicate: (String) -> Boolean): ModulesRuleBuilder

Restricts the rules to modules with a Gradle path matching the given predicate.

infix fun haveNamePath(path: String): ModulesRuleBuilder

Filter or assertion criteria for have name path.

infix fun haveNamePath(paths: List<String>): ModulesRuleBuilder

Restricts the rules to modules with an exact matching Gradle path in the specified list of paths.

haveNameStartingWith

fun haveNameStartingWith(vararg prefixes: String): ModulesRuleBuilder

infix fun haveNameStartingWith(prefix: String): ModulesRuleBuilder

infix fun haveNameStartingWith(prefixes: List<String>): ModulesRuleBuilder

Filter or assertion criteria for have name starting with.

havePlugin

infix fun havePlugin(pluginId: String): ModulesRuleBuilder

Filter or assertion criteria for have plugin.

havePlugins

fun havePlugins(vararg pluginIds: String): ModulesRuleBuilder

infix fun havePlugins(pluginIds: List<String>): ModulesRuleBuilder

Filter or assertion criteria for have plugins.

haveProjectDir

infix fun haveProjectDir(dirPattern: String): ModulesRuleBuilder

Filter or assertion criteria for have project dir.

haveSourceSet

fun haveSourceSet(vararg sourceSetNames: String): ModulesRuleBuilder

infix fun haveSourceSet(sourceSetName: String): ModulesRuleBuilder

infix fun haveSourceSet(sourceSetNames: List<String>): ModulesRuleBuilder

Filter or assertion criteria for have source set.

matching

infix fun matching(predicate: (Module) -> Boolean): ModulesRuleBuilder

Restricts the rules to modules matching the specified predicate.

noneOf

fun noneOf(vararg blocks: ModulesThat.() -> Unit): ModulesRuleBuilder

Matches if none of the nested condition blocks are satisfied.

not

fun not(): ModulesThat

Logical NOT operator for negating the next filter condition.

notApplyPlugin

infix fun notApplyPlugin(pluginId: String): ModulesRuleBuilder

Filter or assertion criteria for not apply plugin.

notContainClass

infix fun notContainClass(fqName: String): ModulesRuleBuilder

infix fun notContainClass(type: KClass<*>): ModulesRuleBuilder

Filter or assertion criteria for not contain class.

notContainClass

inline fun <T : Any> ModulesThat.notContainClass(): ModulesRuleBuilder

Filters modules that do not contain the class specified by type parameter T.

notContainClassesInPackage

infix fun notContainClassesInPackage(packagePattern: String): ModulesRuleBuilder

Filter or assertion criteria for not contain classes in package.

notContainClassesWithAnnotation

infix fun notContainClassesWithAnnotation(annotationFqName: String): ModulesRuleBuilder

infix fun notContainClassesWithAnnotation(annotation: KClass<out Annotation>): ModulesRuleBuilder

Filter or assertion criteria for not contain classes with annotation.

notContainClassesWithAnnotation

inline fun <T : Annotation> ModulesThat.notContainClassesWithAnnotation(): ModulesRuleBuilder

Filters modules that do not contain classes annotated with annotation type parameter T.

notDependOnModule

infix fun notDependOnModule(modulePath: String): ModulesRuleBuilder

Filter or assertion criteria for not depend on module.

notDependOnModules

fun notDependOnModules(vararg modulePaths: String): ModulesRuleBuilder

infix fun notDependOnModules(modulePaths: List<String>): ModulesRuleBuilder

Filter or assertion criteria for not depend on modules.

notHaveBuildId

infix fun notHaveBuildId(buildId: String): ModulesRuleBuilder

Filter or assertion criteria for not have build id.

notHaveName

infix fun notHaveName(path: String): ModulesRuleBuilder

Filter or assertion criteria for not have name.

notHaveNameEndingWith

infix fun notHaveNameEndingWith(suffix: String): ModulesRuleBuilder

Filter or assertion criteria for not have name ending with.

notHaveNameMatching

infix fun notHaveNameMatching(pattern: String): ModulesRuleBuilder

Filter or assertion criteria for not have name matching.

notHaveNameStartingWith

infix fun notHaveNameStartingWith(prefix: String): ModulesRuleBuilder

Filter or assertion criteria for not have name starting with.

notHavePlugin

infix fun notHavePlugin(pluginId: String): ModulesRuleBuilder

Filter or assertion criteria for not have plugin.

notHavePlugins

fun notHavePlugins(vararg pluginIds: String): ModulesRuleBuilder

infix fun notHavePlugins(pluginIds: List<String>): ModulesRuleBuilder

Filter or assertion criteria for not have plugins.

notHaveProjectDir

infix fun notHaveProjectDir(dirPattern: String): ModulesRuleBuilder

Filter or assertion criteria for not have project dir.

notHaveSourceSet

infix fun notHaveSourceSet(sourceSetName: String): ModulesRuleBuilder

Filter or assertion criteria for not have source set.

resideInAModule

fun resideInAModule(vararg modulePaths: String): ModulesRuleBuilder

infix fun resideInAModule(modulePaths: List<String>): ModulesRuleBuilder

Restricts the rules to modules with a Gradle path matching any of the specified module path patterns.

infix fun resideInAModule(modulePath: String): ModulesRuleBuilder

Restricts the rules to modules with a Gradle path matching the specified module path pattern.

resideInAPackage

fun resideInAPackage(vararg packagePatterns: String): ModulesRuleBuilder

infix fun resideInAPackage(packagePatterns: List<String>): ModulesRuleBuilder

Restricts the rules to modules containing files in a package matching any of the specified package patterns.

infix fun resideInAPackage(packagePattern: String): ModulesRuleBuilder

Restricts the rules to modules containing files in a package matching the specified package pattern.

resideInModule

infix fun resideInModule(modulePath: String): ModulesRuleBuilder

Alias for resideInAModule.

resideInModules

fun resideInModules(vararg modulePaths: String): ModulesRuleBuilder

infix fun resideInModules(modulePaths: List<String>): ModulesRuleBuilder

Alias for resideInAModule.

satisfy

fun satisfy(predicate: (Module) -> Boolean): ModulesRuleBuilder

Satisfies an arbitrary custom predicate logic.