library/io.github.baole.konture/KontureModuleScope

KontureModuleScope

class KontureModuleScope(val modules: List<Module>)

Represents a functional scope containing a set of Gradle Module structures for inspection and assertions.

Constructors

Link copied to clipboard
constructor(modules: List<Module>)

Types

Link copied to clipboard
object Companion

Factory methods for constructing module scopes.

Properties

Link copied to clipboard
val modules: List<Module>

Filter or assertion criteria for modules.

Functions

Link copied to clipboard
fun assertAll(message: (Module) -> String = { "Module ${it.path} failed assertion in KontureModuleScope" }, predicate: (Module) -> Boolean)

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

Link copied to clipboard
fun assertAny(message: String = "No modules in KontureModuleScope satisfied the predicate", predicate: (Module) -> Boolean)

Asserts that at least one module in this scope satisfies the given predicate.

Link copied to clipboard
fun assertNone(message: (Module) -> String = { "Module ${it.path} unexpectedly satisfied predicate in KontureModuleScope" }, predicate: (Module) -> Boolean)

Asserts that no modules in this scope satisfy the given predicate.

Link copied to clipboard
fun byPath(pathPattern: String): KontureModuleScope

Filters this scope to modules whose path matches the specified path pattern.

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

Filters this module selector to include modules residing in packages matching the specified pattern.

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

Removes modules present in other scope from this scope by path.

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

Combines two module scopes into a new scope containing distinct modules by path.

Link copied to clipboard
fun ModuleSelector.should(): ModuleSelectorShould

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

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

Filters this module selector to include modules whose path matches the specified pattern.

Link copied to clipboard
fun withPlugin(pluginId: String): KontureModuleScope

Filters this scope to modules that have the specified plugin applied.