project-collections-gradle-settings-plugin/dev.fnc314.gradle.plugins.settings.projectcollectionsgradlesettingsplugin/ProjectCollectionsGradleSettingsExtension

ProjectCollectionsGradleSettingsExtension

abstract class ProjectCollectionsGradleSettingsExtension(source)

Attached to a org.gradle.api.initialization.Settings object to configure the ProjectCollectionsGradleSettingsPlugin

Constructors

ProjectCollectionsGradleSettingsExtension

constructor()

Properties

abstract val fileSpec: Property<Spec<File>>

An optional Spec operating on a File acting as eligibility criteria for File.isDirectory instances to adhere to before passing to org.gradle.api.initialization.Settings.include

projectNameTransform

abstract val projectNameTransform: Property<ProjectNameMapper>

An optional Property of ProjectNameMapper used to rename the argument passed to org.gradle.api.initialization.Settings.include to avoid the potential for empty org.gradle.api.Projects to be created. This aligns with Gradle best practices as outlined here

Functions

registerNestedProjectCollection

abstract fun registerNestedProjectCollection(topLevelDir: String, depth: Int)

Register a collection of nested projects

registerProjectCollection

fun registerProjectCollection(topLevelDir: String)

Register a collection of 1-level-deep projects

abstract fun registerProjectCollection(topLevelDir: String, depth: Int)

Register a collection of nested projects

abstract infix fun String.toDepthOf(depth: Int)

A friendly-syntax approach to including collections of projects